@maxim_mazurok/gapi.client.contactcenterinsights-v1 0.0.20240610 → 0.0.20240617

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://contactcenterinsights.googleapis.com/$discovery/rest?version=v1
-// Revision: 20240610
+// Revision: 20240617
 
 /// <reference types="gapi.client" />
 
@@ -480,9 +480,9 @@ declare namespace gapi.client {
       request?: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest;
     }
     interface GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest {
-      /** Google Cloud Storage URI to export the Issue Model to. */
+      /** Google Cloud Storage URI to export the issue model to. */
       gcsDestination?: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination;
-      /** Required. The issue model to export */
+      /** Required. The issue model to export. */
       name?: string;
     }
     interface GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination {
@@ -520,7 +520,7 @@ declare namespace gapi.client {
       request?: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest;
     }
     interface GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest {
-      /** Optional. If set to true, will create a new issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file. */
+      /** Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file. */
       createNewModel?: boolean;
       /** Google Cloud Storage source message. */
       gcsSource?: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource;
@@ -563,7 +563,7 @@ declare namespace gapi.client {
       parent?: string;
       /** Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */
       redactionConfig?: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig;
-      /** Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Note that conversations produced via sampling will not be ingested by subsequent ingest requests unless they are first deleted. */
+      /** Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests. */
       sampleSize?: number;
       /** Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings. */
       speechConfig?: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig;
@@ -573,7 +573,7 @@ declare namespace gapi.client {
     interface GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig {
       /** Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. */
       agentChannel?: number;
-      /** Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided via the `metadata_bucket_uri`. */
+      /** Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`. */
       agentId?: string;
       /** Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. */
       customerChannel?: number;
@@ -585,7 +585,7 @@ declare namespace gapi.client {
       bucketUri?: string;
       /** Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation. */
       customMetadataKeys?: string[];
-      /** Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files are expected to be in JSON format [2] metadata and source objects must be in separate buckets [3] a source object's metadata object must share the same name to be properly ingested */
+      /** Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`. */
       metadataBucketUri?: string;
     }
     interface GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig {
@@ -1272,9 +1272,9 @@ declare namespace gapi.client {
       request?: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest;
     }
     interface GoogleCloudContactcenterinsightsV1ExportIssueModelRequest {
-      /** Google Cloud Storage URI to export the Issue Model to. */
+      /** Google Cloud Storage URI to export the issue model to. */
       gcsDestination?: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination;
-      /** Required. The issue model to export */
+      /** Required. The issue model to export. */
       name?: string;
     }
     interface GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination {
@@ -1312,7 +1312,7 @@ declare namespace gapi.client {
       request?: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest;
     }
     interface GoogleCloudContactcenterinsightsV1ImportIssueModelRequest {
-      /** Optional. If set to true, will create a new issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file. */
+      /** Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file. */
       createNewModel?: boolean;
       /** Google Cloud Storage source message. */
       gcsSource?: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource;
@@ -1355,7 +1355,7 @@ declare namespace gapi.client {
       parent?: string;
       /** Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */
       redactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
-      /** Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Note that conversations produced via sampling will not be ingested by subsequent ingest requests unless they are first deleted. */
+      /** Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests. */
       sampleSize?: number;
       /** Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings. */
       speechConfig?: GoogleCloudContactcenterinsightsV1SpeechConfig;
@@ -1365,7 +1365,7 @@ declare namespace gapi.client {
     interface GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig {
       /** Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. */
       agentChannel?: number;
-      /** Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided via the `metadata_bucket_uri`. */
+      /** Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`. */
       agentId?: string;
       /** Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. */
       customerChannel?: number;
@@ -1377,7 +1377,7 @@ declare namespace gapi.client {
       bucketUri?: string;
       /** Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation. */
       customMetadataKeys?: string[];
-      /** Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files are expected to be in JSON format [2] metadata and source objects must be in separate buckets [3] a source object's metadata object must share the same name to be properly ingested */
+      /** Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`. */
       metadataBucketUri?: string;
     }
     interface GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig {
@@ -1609,11 +1609,11 @@ declare namespace gapi.client {
       languageCode?: string;
       /** Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings */
       name?: string;
-      /** A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO completes. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} */
+      /** A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} */
       pubsubNotificationSettings?: {[P in string]: string};
-      /** Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform. */
+      /** Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. */
       redactionConfig?: GoogleCloudContactcenterinsightsV1RedactionConfig;
-      /** Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform. */
+      /** Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. */
       speechConfig?: GoogleCloudContactcenterinsightsV1SpeechConfig;
       /** Output only. The time at which the settings were last updated. */
       updateTime?: string;
@@ -2020,7 +2020,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudContactcenterinsightsV1CalculateStatsResponse>;
-      /** Creates a conversation. DEPRECATED: Use UploadConversation instead. CreateConversation does not support audio transcription or DLP redaction. */
+      /** Creates a conversation. Does not support audio transcription or DLP redaction. Use `conversations.upload` instead. */
       create(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -2216,7 +2216,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc`, i.e. `create_time desc`. See https://google.aip.dev/132#ordering for more details. */
+        /** Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). */
         orderBy?: string;
         /** The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */
         pageSize?: number;
@@ -2297,7 +2297,7 @@ declare namespace gapi.client {
         },
         body: GoogleCloudContactcenterinsightsV1Conversation
       ): Request<GoogleCloudContactcenterinsightsV1Conversation>;
-      /** Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction. */
+      /** Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. */
       upload(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -2747,7 +2747,7 @@ declare namespace gapi.client {
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
-        /** Required. The issue model to export */
+        /** Required. The issue model to export. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -2776,7 +2776,7 @@ declare namespace gapi.client {
           fields?: string;
           /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
           key?: string;
-          /** Required. The issue model to export */
+          /** Required. The issue model to export. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.contactcenterinsights-v1",
-  "version": "0.0.20240610",
+  "version": "0.0.20240617",
   "description": "TypeScript typings for Contact Center AI Insights API v1",
   "repository": {
     "type": "git",