Skip to content

Commit 68b0c8a

Browse files
Google APIscopybara-github
authored andcommitted
feat: new feature flag disable_issue_modeling
docs: fixed formatting issues in the reference documentation PiperOrigin-RevId: 411102531
1 parent a1af8f0 commit 68b0c8a

2 files changed

Lines changed: 52 additions & 69 deletions

File tree

google/cloud/contactcenterinsights/v1/contact_center_insights.proto

Lines changed: 47 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,15 @@ option ruby_package = "Google::Cloud::ContactCenterInsights::V1";
3939
// An API that lets users analyze and explore their business conversation data.
4040
service ContactCenterInsights {
4141
option (google.api.default_host) = "contactcenterinsights.googleapis.com";
42-
option (google.api.oauth_scopes) =
43-
"https://www.googleapis.com/auth/cloud-platform";
42+
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
4443

4544
// Creates a conversation.
4645
rpc CreateConversation(CreateConversationRequest) returns (Conversation) {
4746
option (google.api.http) = {
4847
post: "/v1/{parent=projects/*/locations/*}/conversations"
4948
body: "conversation"
5049
};
51-
option (google.api.method_signature) =
52-
"parent,conversation,conversation_id";
50+
option (google.api.method_signature) = "parent,conversation,conversation_id";
5351
}
5452

5553
// Updates a conversation.
@@ -70,17 +68,15 @@ service ContactCenterInsights {
7068
}
7169

7270
// Lists conversations.
73-
rpc ListConversations(ListConversationsRequest)
74-
returns (ListConversationsResponse) {
71+
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) {
7572
option (google.api.http) = {
7673
get: "/v1/{parent=projects/*/locations/*}/conversations"
7774
};
7875
option (google.api.method_signature) = "parent";
7976
}
8077

8178
// Deletes a conversation.
82-
rpc DeleteConversation(DeleteConversationRequest)
83-
returns (google.protobuf.Empty) {
79+
rpc DeleteConversation(DeleteConversationRequest) returns (google.protobuf.Empty) {
8480
option (google.api.http) = {
8581
delete: "/v1/{name=projects/*/locations/*/conversations/*}"
8682
};
@@ -89,8 +85,7 @@ service ContactCenterInsights {
8985

9086
// Creates an analysis. The long running operation is done when the analysis
9187
// has completed.
92-
rpc CreateAnalysis(CreateAnalysisRequest)
93-
returns (google.longrunning.Operation) {
88+
rpc CreateAnalysis(CreateAnalysisRequest) returns (google.longrunning.Operation) {
9489
option (google.api.http) = {
9590
post: "/v1/{parent=projects/*/locations/*/conversations/*}/analyses"
9691
body: "analysis"
@@ -127,8 +122,7 @@ service ContactCenterInsights {
127122
}
128123

129124
// Export insights data to a destination defined in the request body.
130-
rpc ExportInsightsData(ExportInsightsDataRequest)
131-
returns (google.longrunning.Operation) {
125+
rpc ExportInsightsData(ExportInsightsDataRequest) returns (google.longrunning.Operation) {
132126
option (google.api.http) = {
133127
post: "/v1/{parent=projects/*/locations/*}/insightsdata:export"
134128
body: "*"
@@ -141,8 +135,7 @@ service ContactCenterInsights {
141135
}
142136

143137
// Creates an issue model.
144-
rpc CreateIssueModel(CreateIssueModelRequest)
145-
returns (google.longrunning.Operation) {
138+
rpc CreateIssueModel(CreateIssueModelRequest) returns (google.longrunning.Operation) {
146139
option (google.api.http) = {
147140
post: "/v1/{parent=projects/*/locations/*}/issueModels"
148141
body: "issue_model"
@@ -172,17 +165,15 @@ service ContactCenterInsights {
172165
}
173166

174167
// Lists issue models.
175-
rpc ListIssueModels(ListIssueModelsRequest)
176-
returns (ListIssueModelsResponse) {
168+
rpc ListIssueModels(ListIssueModelsRequest) returns (ListIssueModelsResponse) {
177169
option (google.api.http) = {
178170
get: "/v1/{parent=projects/*/locations/*}/issueModels"
179171
};
180172
option (google.api.method_signature) = "parent";
181173
}
182174

183175
// Deletes an issue model.
184-
rpc DeleteIssueModel(DeleteIssueModelRequest)
185-
returns (google.longrunning.Operation) {
176+
rpc DeleteIssueModel(DeleteIssueModelRequest) returns (google.longrunning.Operation) {
186177
option (google.api.http) = {
187178
delete: "/v1/{name=projects/*/locations/*/issueModels/*}"
188179
};
@@ -195,8 +186,7 @@ service ContactCenterInsights {
195186

196187
// Deploys an issue model. Returns an error if a model is already deployed.
197188
// An issue model can only be used in analysis after it has been deployed.
198-
rpc DeployIssueModel(DeployIssueModelRequest)
199-
returns (google.longrunning.Operation) {
189+
rpc DeployIssueModel(DeployIssueModelRequest) returns (google.longrunning.Operation) {
200190
option (google.api.http) = {
201191
post: "/v1/{name=projects/*/locations/*/issueModels/*}:deploy"
202192
body: "*"
@@ -210,8 +200,7 @@ service ContactCenterInsights {
210200

211201
// Undeploys an issue model.
212202
// An issue model can not be used in analysis after it has been undeployed.
213-
rpc UndeployIssueModel(UndeployIssueModelRequest)
214-
returns (google.longrunning.Operation) {
203+
rpc UndeployIssueModel(UndeployIssueModelRequest) returns (google.longrunning.Operation) {
215204
option (google.api.http) = {
216205
post: "/v1/{name=projects/*/locations/*/issueModels/*}:undeploy"
217206
body: "*"
@@ -249,8 +238,7 @@ service ContactCenterInsights {
249238
}
250239

251240
// Gets an issue model's statistics.
252-
rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest)
253-
returns (CalculateIssueModelStatsResponse) {
241+
rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest) returns (CalculateIssueModelStatsResponse) {
254242
option (google.api.http) = {
255243
get: "/v1/{issue_model=projects/*/locations/*/issueModels/*}:calculateIssueModelStats"
256244
};
@@ -275,17 +263,15 @@ service ContactCenterInsights {
275263
}
276264

277265
// Lists phrase matchers.
278-
rpc ListPhraseMatchers(ListPhraseMatchersRequest)
279-
returns (ListPhraseMatchersResponse) {
266+
rpc ListPhraseMatchers(ListPhraseMatchersRequest) returns (ListPhraseMatchersResponse) {
280267
option (google.api.http) = {
281268
get: "/v1/{parent=projects/*/locations/*}/phraseMatchers"
282269
};
283270
option (google.api.method_signature) = "parent";
284271
}
285272

286273
// Deletes a phrase matcher.
287-
rpc DeletePhraseMatcher(DeletePhraseMatcherRequest)
288-
returns (google.protobuf.Empty) {
274+
rpc DeletePhraseMatcher(DeletePhraseMatcherRequest) returns (google.protobuf.Empty) {
289275
option (google.api.http) = {
290276
delete: "/v1/{name=projects/*/locations/*/phraseMatchers/*}"
291277
};
@@ -397,14 +383,13 @@ message CalculateStatsResponse {
397383

398384
// A map associating each issue resource name with its respective number of
399385
// matches in the set of conversations. Key has the format:
400-
// `projects/<Project ID>/locations/<Location ID>/issueModels/<Issue Model
401-
// ID>/issues/<Issue ID>`
386+
// `projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>`
402387
// Deprecated, use `issue_matches_stats` field instead.
403388
map<string, int32> issue_matches = 6 [deprecated = true];
404389

405390
// A map associating each issue resource name with its respective number of
406391
// matches in the set of conversations. Key has the format:
407-
// `projects/<ProjectID>/locations/<LocationID>/issueModels/<IssueModelID>/issues/<IssueID>`
392+
// `projects/<Project-ID>/locations/<Location-ID>/issueModels/<Issue-Model-ID>/issues/<Issue-ID>`
408393
map<string, IssueModelLabelStats.IssueStats> issue_matches_stats = 8;
409394

410395
// A time series representing the count of conversations created over time
@@ -415,12 +400,10 @@ message CalculateStatsResponse {
415400
// Metadata for a create analysis operation.
416401
message CreateAnalysisOperationMetadata {
417402
// Output only. The time the operation was created.
418-
google.protobuf.Timestamp create_time = 1
419-
[(google.api.field_behavior) = OUTPUT_ONLY];
403+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
420404

421405
// Output only. The time the operation finished running.
422-
google.protobuf.Timestamp end_time = 2
423-
[(google.api.field_behavior) = OUTPUT_ONLY];
406+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
424407

425408
// Output only. The Conversation that this Analysis Operation belongs to.
426409
string conversation = 3 [
@@ -448,8 +431,8 @@ message CreateConversationRequest {
448431
// component of the conversation's resource name. If no ID is specified, a
449432
// server-generated ID will be used.
450433
//
451-
// This value should be 4-32 characters and must match the regular
452-
// expression /^[a-z0-9-]{4,32}$/. Valid characters are /[a-z][0-9]-/
434+
// This value should be 4-64 characters and must match the regular
435+
// expression `^[a-z0-9-]{4,64}$`. Valid characters are `[a-z][0-9]-`
453436
string conversation_id = 3;
454437
}
455438

@@ -613,9 +596,9 @@ message ExportInsightsDataRequest {
613596
// the resource project will be used.
614597
string project_id = 3;
615598

616-
// Required. The name of the BigQuery dataset that the snapshot result
617-
// should be exported to. If this dataset does not exist, the export call
618-
// returns an INVALID_ARGUMENT error.
599+
// Required. The name of the BigQuery dataset that the snapshot result should be
600+
// exported to. If this dataset does not exist, the export call returns an
601+
// INVALID_ARGUMENT error.
619602
string dataset = 1 [(google.api.field_behavior) = REQUIRED];
620603

621604
// The BigQuery table name to which the insights data should be written.
@@ -651,12 +634,10 @@ message ExportInsightsDataRequest {
651634
// Metadata for an export insights operation.
652635
message ExportInsightsDataMetadata {
653636
// Output only. The time the operation was created.
654-
google.protobuf.Timestamp create_time = 1
655-
[(google.api.field_behavior) = OUTPUT_ONLY];
637+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
656638

657639
// Output only. The time the operation finished running.
658-
google.protobuf.Timestamp end_time = 2
659-
[(google.api.field_behavior) = OUTPUT_ONLY];
640+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
660641

661642
// The original request for export.
662643
ExportInsightsDataRequest request = 3;
@@ -667,7 +648,9 @@ message ExportInsightsDataMetadata {
667648
}
668649

669650
// Response for an export insights operation.
670-
message ExportInsightsDataResponse {}
651+
message ExportInsightsDataResponse {
652+
653+
}
671654

672655
// The request to create an issue model.
673656
message CreateIssueModelRequest {
@@ -686,12 +669,10 @@ message CreateIssueModelRequest {
686669
// Metadata for creating an issue model.
687670
message CreateIssueModelMetadata {
688671
// Output only. The time the operation was created.
689-
google.protobuf.Timestamp create_time = 1
690-
[(google.api.field_behavior) = OUTPUT_ONLY];
672+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
691673

692674
// Output only. The time the operation finished running.
693-
google.protobuf.Timestamp end_time = 2
694-
[(google.api.field_behavior) = OUTPUT_ONLY];
675+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
695676

696677
// The original request for creation.
697678
CreateIssueModelRequest request = 3;
@@ -748,12 +729,10 @@ message DeleteIssueModelRequest {
748729
// Metadata for deleting an issue model.
749730
message DeleteIssueModelMetadata {
750731
// Output only. The time the operation was created.
751-
google.protobuf.Timestamp create_time = 1
752-
[(google.api.field_behavior) = OUTPUT_ONLY];
732+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
753733

754734
// Output only. The time the operation finished running.
755-
google.protobuf.Timestamp end_time = 2
756-
[(google.api.field_behavior) = OUTPUT_ONLY];
735+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
757736

758737
// The original request for deletion.
759738
DeleteIssueModelRequest request = 3;
@@ -771,17 +750,17 @@ message DeployIssueModelRequest {
771750
}
772751

773752
// The response to deploy an issue model.
774-
message DeployIssueModelResponse {}
753+
message DeployIssueModelResponse {
754+
755+
}
775756

776757
// Metadata for deploying an issue model.
777758
message DeployIssueModelMetadata {
778759
// Output only. The time the operation was created.
779-
google.protobuf.Timestamp create_time = 1
780-
[(google.api.field_behavior) = OUTPUT_ONLY];
760+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
781761

782762
// Output only. The time the operation finished running.
783-
google.protobuf.Timestamp end_time = 2
784-
[(google.api.field_behavior) = OUTPUT_ONLY];
763+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
785764

786765
// The original request for deployment.
787766
DeployIssueModelRequest request = 3;
@@ -799,17 +778,17 @@ message UndeployIssueModelRequest {
799778
}
800779

801780
// The response to undeploy an issue model.
802-
message UndeployIssueModelResponse {}
781+
message UndeployIssueModelResponse {
782+
783+
}
803784

804785
// Metadata for undeploying an issue model.
805786
message UndeployIssueModelMetadata {
806787
// Output only. The time the operation was created.
807-
google.protobuf.Timestamp create_time = 1
808-
[(google.api.field_behavior) = OUTPUT_ONLY];
788+
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
809789

810790
// Output only. The time the operation finished running.
811-
google.protobuf.Timestamp end_time = 2
812-
[(google.api.field_behavior) = OUTPUT_ONLY];
791+
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
813792

814793
// The original request for undeployment.
815794
UndeployIssueModelRequest request = 3;
@@ -872,10 +851,10 @@ message CalculateIssueModelStatsResponse {
872851

873852
// Request to create a phrase matcher.
874853
message CreatePhraseMatcherRequest {
875-
// Required. The parent resource of the phrase matcher. Required. The location
876-
// to create a phrase matcher for. Format: `projects/<Project
877-
// ID>/locations/<Location ID>` or `projects/<Project
878-
// Number>/locations/<Location ID>`
854+
// Required. The parent resource of the phrase matcher. Required. The location to create
855+
// a phrase matcher for.
856+
// Format: `projects/<Project ID>/locations/<Location ID>` or
857+
// `projects/<Project Number>/locations/<Location ID>`
879858
string parent = 1 [
880859
(google.api.field_behavior) = REQUIRED,
881860
(google.api.resource_reference) = {
@@ -971,6 +950,5 @@ message UpdateSettingsRequest {
971950
Settings settings = 1 [(google.api.field_behavior) = REQUIRED];
972951

973952
// Required. The list of fields to be updated.
974-
google.protobuf.FieldMask update_mask = 2
975-
[(google.api.field_behavior) = REQUIRED];
953+
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
976954
}

google/cloud/contactcenterinsights/v1/resources.proto

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,11 @@ message Settings {
823823
// Percentage of conversations created using Dialogflow runtime integration
824824
// to analyze automatically, between [0, 100].
825825
double runtime_integration_analysis_percentage = 1;
826+
827+
// Whether to disable issue model inference during analysis.
828+
// By default issue modeling will be included in analysis if there is an
829+
// active issue model for the project.
830+
bool disable_issue_modeling = 3;
826831
}
827832

828833
// Immutable. The resource name of the settings resource.

0 commit comments

Comments
 (0)