feat: Add IngestConversationsStats

Google APIs · copybara-github · commit cfed8e603c64 · 2023-02-03T13:50:59.000-08:00
docs: Reformat some lines of code

PiperOrigin-RevId: 506985378
diff --git a/google/cloud/contactcenterinsights/v1/contact_center_insights.proto b/google/cloud/contactcenterinsights/v1/contact_center_insights.proto
@@ -39,15 +39,17 @@ option ruby_package = "Google::Cloud::ContactCenterInsights::V1";
 // An API that lets users analyze and explore their business conversation data.
 service ContactCenterInsights {
   option (google.api.default_host) = "contactcenterinsights.googleapis.com";
-  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
 
   // Creates a conversation.
   rpc CreateConversation(CreateConversationRequest) returns (Conversation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*}/conversations"
       body: "conversation"
     };
-    option (google.api.method_signature) = "parent,conversation,conversation_id";
+    option (google.api.method_signature) =
+        "parent,conversation,conversation_id";
   }
 
   // Updates a conversation.
@@ -68,15 +70,17 @@ service ContactCenterInsights {
   }
 
   // Lists conversations.
-  rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) {
+  rpc ListConversations(ListConversationsRequest)
+      returns (ListConversationsResponse) {
     option (google.api.http) = {
       get: "/v1/{parent=projects/*/locations/*}/conversations"
     };
     option (google.api.method_signature) = "parent";
   }
 
   // Deletes a conversation.
-  rpc DeleteConversation(DeleteConversationRequest) returns (google.protobuf.Empty) {
+  rpc DeleteConversation(DeleteConversationRequest)
+      returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v1/{name=projects/*/locations/*/conversations/*}"
     };
@@ -85,7 +89,8 @@ service ContactCenterInsights {
 
   // Creates an analysis. The long running operation is done when the analysis
   // has completed.
-  rpc CreateAnalysis(CreateAnalysisRequest) returns (google.longrunning.Operation) {
+  rpc CreateAnalysis(CreateAnalysisRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*/conversations/*}/analyses"
       body: "analysis"
@@ -122,7 +127,8 @@ service ContactCenterInsights {
   }
 
   // Analyzes multiple conversations in a single request.
-  rpc BulkAnalyzeConversations(BulkAnalyzeConversationsRequest) returns (google.longrunning.Operation) {
+  rpc BulkAnalyzeConversations(BulkAnalyzeConversationsRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*}/conversations:bulkAnalyze"
       body: "*"
@@ -136,7 +142,8 @@ service ContactCenterInsights {
 
   // Imports conversations and processes them according to the user's
   // configuration.
-  rpc IngestConversations(IngestConversationsRequest) returns (google.longrunning.Operation) {
+  rpc IngestConversations(IngestConversationsRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*}/conversations:ingest"
       body: "*"
@@ -149,7 +156,8 @@ service ContactCenterInsights {
   }
 
   // Export insights data to a destination defined in the request body.
-  rpc ExportInsightsData(ExportInsightsDataRequest) returns (google.longrunning.Operation) {
+  rpc ExportInsightsData(ExportInsightsDataRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*}/insightsdata:export"
       body: "*"
@@ -162,7 +170,8 @@ service ContactCenterInsights {
   }
 
   // Creates an issue model.
-  rpc CreateIssueModel(CreateIssueModelRequest) returns (google.longrunning.Operation) {
+  rpc CreateIssueModel(CreateIssueModelRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{parent=projects/*/locations/*}/issueModels"
       body: "issue_model"
@@ -192,15 +201,17 @@ service ContactCenterInsights {
   }
 
   // Lists issue models.
-  rpc ListIssueModels(ListIssueModelsRequest) returns (ListIssueModelsResponse) {
+  rpc ListIssueModels(ListIssueModelsRequest)
+      returns (ListIssueModelsResponse) {
     option (google.api.http) = {
       get: "/v1/{parent=projects/*/locations/*}/issueModels"
     };
     option (google.api.method_signature) = "parent";
   }
 
   // Deletes an issue model.
-  rpc DeleteIssueModel(DeleteIssueModelRequest) returns (google.longrunning.Operation) {
+  rpc DeleteIssueModel(DeleteIssueModelRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       delete: "/v1/{name=projects/*/locations/*/issueModels/*}"
     };
@@ -213,7 +224,8 @@ service ContactCenterInsights {
 
   // Deploys an issue model. Returns an error if a model is already deployed.
   // An issue model can only be used in analysis after it has been deployed.
-  rpc DeployIssueModel(DeployIssueModelRequest) returns (google.longrunning.Operation) {
+  rpc DeployIssueModel(DeployIssueModelRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{name=projects/*/locations/*/issueModels/*}:deploy"
       body: "*"
@@ -227,7 +239,8 @@ service ContactCenterInsights {
 
   // Undeploys an issue model.
   // An issue model can not be used in analysis after it has been undeployed.
-  rpc UndeployIssueModel(UndeployIssueModelRequest) returns (google.longrunning.Operation) {
+  rpc UndeployIssueModel(UndeployIssueModelRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1/{name=projects/*/locations/*/issueModels/*}:undeploy"
       body: "*"
@@ -273,7 +286,8 @@ service ContactCenterInsights {
   }
 
   // Gets an issue model's statistics.
-  rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest) returns (CalculateIssueModelStatsResponse) {
+  rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest)
+      returns (CalculateIssueModelStatsResponse) {
     option (google.api.http) = {
       get: "/v1/{issue_model=projects/*/locations/*/issueModels/*}:calculateIssueModelStats"
     };
@@ -298,15 +312,17 @@ service ContactCenterInsights {
   }
 
   // Lists phrase matchers.
-  rpc ListPhraseMatchers(ListPhraseMatchersRequest) returns (ListPhraseMatchersResponse) {
+  rpc ListPhraseMatchers(ListPhraseMatchersRequest)
+      returns (ListPhraseMatchersResponse) {
     option (google.api.http) = {
       get: "/v1/{parent=projects/*/locations/*}/phraseMatchers"
     };
     option (google.api.method_signature) = "parent";
   }
 
   // Deletes a phrase matcher.
-  rpc DeletePhraseMatcher(DeletePhraseMatcherRequest) returns (google.protobuf.Empty) {
+  rpc DeletePhraseMatcher(DeletePhraseMatcherRequest)
+      returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v1/{name=projects/*/locations/*/phraseMatchers/*}"
     };
@@ -479,10 +495,12 @@ message CalculateStatsResponse {
 // Metadata for a create analysis operation.
 message CreateAnalysisOperationMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The Conversation that this Analysis Operation belongs to.
   string conversation = 3 [
@@ -493,7 +511,8 @@ message CreateAnalysisOperationMetadata {
   ];
 
   // Output only. The annotator selector used for the analysis (if any).
-  AnnotatorSelector annotator_selector = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  AnnotatorSelector annotator_selector = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Request to create a conversation.
@@ -645,24 +664,51 @@ message IngestConversationsRequest {
 
 // The metadata for an IngestConversations operation.
 message IngestConversationsMetadata {
+  // Statistics for IngestConversations operation.
+  message IngestConversationsStats {
+    // Output only. The number of objects processed during the ingest operation.
+    int32 processed_object_count = 1
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The number of objects skipped because another conversation
+    // with the same transcript uri had already been ingested.
+    int32 duplicates_skipped_count = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The number of new conversations added during this ingest
+    // operation.
+    int32 successful_ingest_count = 3
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The number of objects which were unable to be ingested due
+    // to errors. The errors are populated in the partial_errors field.
+    int32 failed_ingest_count = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The original request for ingest.
-  IngestConversationsRequest request = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+  IngestConversationsRequest request = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Output only. Partial errors during ingest operation that might cause the operation
-  // output to be incomplete.
-  repeated google.rpc.Status partial_errors = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Output only. Partial errors during ingest operation that might cause the
+  // operation output to be incomplete.
+  repeated google.rpc.Status partial_errors = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Statistics for IngestConversations operation.
+  IngestConversationsStats ingest_conversations_stats = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // The response to an IngestConversations operation.
-message IngestConversationsResponse {
-
-}
+message IngestConversationsResponse {}
 
 // The request to create an analysis.
 message CreateAnalysisRequest {
@@ -798,9 +844,9 @@ message ExportInsightsDataRequest {
     // the resource project will be used.
     string project_id = 3;
 
-    // Required. The name of the BigQuery dataset that the snapshot result should be
-    // exported to. If this dataset does not exist, the export call returns an
-    // INVALID_ARGUMENT error.
+    // Required. The name of the BigQuery dataset that the snapshot result
+    // should be exported to. If this dataset does not exist, the export call
+    // returns an INVALID_ARGUMENT error.
     string dataset = 1 [(google.api.field_behavior) = REQUIRED];
 
     // The BigQuery table name to which the insights data should be written.
@@ -852,10 +898,12 @@ message ExportInsightsDataRequest {
 // Metadata for an export insights operation.
 message ExportInsightsDataMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The original request for export.
   ExportInsightsDataRequest request = 3;
@@ -866,9 +914,7 @@ message ExportInsightsDataMetadata {
 }
 
 // Response for an export insights operation.
-message ExportInsightsDataResponse {
-
-}
+message ExportInsightsDataResponse {}
 
 // The request to create an issue model.
 message CreateIssueModelRequest {
@@ -887,10 +933,12 @@ message CreateIssueModelRequest {
 // Metadata for creating an issue model.
 message CreateIssueModelMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The original request for creation.
   CreateIssueModelRequest request = 3;
@@ -947,10 +995,12 @@ message DeleteIssueModelRequest {
 // Metadata for deleting an issue model.
 message DeleteIssueModelMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The original request for deletion.
   DeleteIssueModelRequest request = 3;
@@ -968,17 +1018,17 @@ message DeployIssueModelRequest {
 }
 
 // The response to deploy an issue model.
-message DeployIssueModelResponse {
-
-}
+message DeployIssueModelResponse {}
 
 // Metadata for deploying an issue model.
 message DeployIssueModelMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The original request for deployment.
   DeployIssueModelRequest request = 3;
@@ -996,17 +1046,17 @@ message UndeployIssueModelRequest {
 }
 
 // The response to undeploy an issue model.
-message UndeployIssueModelResponse {
-
-}
+message UndeployIssueModelResponse {}
 
 // Metadata for undeploying an issue model.
 message UndeployIssueModelMetadata {
   // Output only. The time the operation was created.
-  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The time the operation finished running.
-  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp end_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The original request for undeployment.
   UndeployIssueModelRequest request = 3;
@@ -1080,10 +1130,10 @@ message CalculateIssueModelStatsResponse {
 
 // Request to create a phrase matcher.
 message CreatePhraseMatcherRequest {
-  // Required. The parent resource of the phrase matcher. Required. The location to create
-  // a phrase matcher for.
-  // Format: `projects/<Project ID>/locations/<Location ID>` or
-  // `projects/<Project Number>/locations/<Location ID>`
+  // Required. The parent resource of the phrase matcher. Required. The location
+  // to create a phrase matcher for. Format: `projects/<Project
+  // ID>/locations/<Location ID>` or `projects/<Project
+  // Number>/locations/<Location ID>`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -1179,7 +1229,8 @@ message UpdateSettingsRequest {
   Settings settings = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The list of fields to be updated.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 }
 
 // The request to create a view.
diff --git a/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml b/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml
@@ -44,3 +44,10 @@ authentication:
 
 publishing:
   organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+  new_issue_uri: ''
+  documentation_uri: ''
+  api_short_name: ''
+  github_label: ''
+  doc_tag_prefix: ''
+  codeowner_github_teams:
+  library_settings:
diff --git a/google/cloud/contactcenterinsights/v1/resources.proto b/google/cloud/contactcenterinsights/v1/resources.proto
