@maxim_mazurok/gapi.client.contactcenterinsights-v1 0.0.20240402 → 0.0.20240416

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: 20240402
+// Revision: 20240416
 
 /// <reference types="gapi.client" />
 
@@ -28,6 +28,98 @@ declare namespace gapi.client {
   ): void;
 
   namespace contactcenterinsights {
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingInstruction {
+      /** Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty */
+      agentAction?: string;
+      /** Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. */
+      condition?: string;
+      /** Optional. The detailed description of this instruction. */
+      description?: string;
+      /** Optional. Display name for the instruction. */
+      displayName?: string;
+      /** Optional. Additional information attached to this instruction. */
+      metadata?: {[P in string]: string};
+      /** Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty */
+      systemAction?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion {
+      /** Optional. Suggested actions for the agent to take. */
+      agentActionSuggestions?: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion[];
+      /** Optional. Instructions applicable based on the current context. */
+      applicableInstructions?: GoogleCloudContactcenterinsightsV1AgentCoachingInstruction[];
+      /** Optional. Sample response for the Agent. */
+      sampleResponses?: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse[];
+      /** Self evaluation of the suggestion. */
+      suggestionEval?: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval;
+      /** Reasoning for the suggestion. */
+      suggestionReasoning?: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning;
+    }
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion {
+      /** Optional. The suggested action for the agent. */
+      agentAction?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval {
+      /** Optional. Eval for Agent action suggestion. */
+      actionActionSuggestionEval?: string;
+      /** Optional. Eval for sample response. */
+      sampleResponseEval?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning {
+      /** Optional. The actions that the agent has taken already. */
+      agentActionTaken?: string;
+      /** Optional. Summary of the issue. */
+      issueSummary?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse {
+      /** Optional. Sample response for Agent in text. */
+      responseText?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction {
+      /** Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty */
+      agentAction?: string;
+      /** Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty. */
+      condition?: string;
+      /** Optional. The detailed description of this instruction. */
+      description?: string;
+      /** Optional. Display name for the instruction. */
+      displayName?: string;
+      /** Optional. Additional information attached to this instruction. */
+      metadata?: {[P in string]: string};
+      /** Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty */
+      systemAction?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion {
+      /** Optional. Suggested actions for the agent to take. */
+      agentActionSuggestions?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion[];
+      /** Optional. Instructions applicable based on the current context. */
+      applicableInstructions?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction[];
+      /** Optional. Sample response for the Agent. */
+      sampleResponses?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse[];
+      /** Self evaluation of the suggestion. */
+      suggestionEval?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval;
+      /** Reasoning for the suggestion. */
+      suggestionReasoning?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion {
+      /** Optional. The suggested action for the agent. */
+      agentAction?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval {
+      /** Optional. Eval for Agent action suggestion. */
+      actionActionSuggestionEval?: string;
+      /** Optional. Eval for sample response. */
+      sampleResponseEval?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning {
+      /** Optional. The actions that the agent has taken already. */
+      agentActionTaken?: string;
+      /** Optional. Summary of the issue. */
+      issueSummary?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse {
+      /** Optional. Sample response for Agent in text. */
+      responseText?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1alpha1Analysis {
       /** Output only. The result of the analysis, which is populated when the analysis finishes. */
       analysisResult?: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult;
@@ -496,12 +588,80 @@ declare namespace gapi.client {
       /** The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. */
       source?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion {
+      /** Optional. Labels for the generator. */
+      labels?: string[];
+      /** Required. Free form suggestion. */
+      response?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1alpha1GcsSource {
       /** Cloud Storage URI that points to a file that contains the conversation audio. */
       audioUri?: string;
       /** Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */
       transcriptUri?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion {
+      /** Optional. Suggestion to coach the agent. */
+      agentCoachingSuggestion?: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion;
+      /** Optional. Free form suggestion. */
+      freeFormSuggestion?: GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion;
+      /** Optional. Suggested summary. */
+      summarySuggestion?: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse {
+      /** The suggestion generated from the Generator. */
+      generatorSuggestion?: GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse {
+      /** The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. */
+      suggestedQuery?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery;
+      /** The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. */
+      suggestedQueryAnswer?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer {
+      /** The piece of text from the `source` that answers this suggested query. */
+      answerText?: string;
+      /** Populated if the prediction came from FAQ. */
+      faqSource?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource;
+      /** Populated if the prediction was Generative. */
+      generativeSource?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource;
+      /** Populated if the prediction was from intent matching. */
+      intentMatchingSource?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource;
+      /** The system's confidence score that this answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). */
+      matchConfidence?: number;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource {
+      /** Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`. */
+      document?: string;
+      /** The corresponding FAQ question. */
+      question?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource {
+      /** All snippets used for this Generative Prediction, with their source URI and data. */
+      snippets?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet[];
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet {
+      /** Indicates which Knowledge Document this snippet was extracted from. Format: `projects//knowledgeBases//documents/`. */
+      document?: string;
+      /** text taken from that URI. */
+      text?: string;
+      /** Title of the document. */
+      title?: string;
+      /** URI the data is sourced from. */
+      uri?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource {
+      /** Title of the document. */
+      title?: string;
+      /** URI the data is sourced from. */
+      uri?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery {
+      /** Suggested query text. */
+      queryText?: string;
+      /** Suggested query score. */
+      score?: number;
+    }
     interface GoogleCloudContactcenterinsightsV1alpha1HoldData {}
     interface GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata {
       /** The time the operation was created. */
@@ -689,6 +849,12 @@ declare namespace gapi.client {
       endBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
       /** Agent Assist FAQ answer data. */
       faqAnswer?: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData;
+      /** The generator suggestion result. */
+      generatorSuggestionResult?: GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse;
+      /** The Knowledge Assist result. */
+      knowledgeAssistResult?: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse;
+      /** The Knowledge Search result. */
+      knowledgeSearchResult?: GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer;
       /** Agent Assist Smart Compose suggestion data. */
       smartComposeSuggestion?: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData;
       /** Agent Assist Smart Reply data. */
@@ -696,6 +862,28 @@ declare namespace gapi.client {
       /** The boundary in the conversation where the annotation starts, inclusive. */
       startBoundary?: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
     }
+    interface GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer {
+      /** The piece of text from the knowledge base documents that answers the search query */
+      answer?: string;
+      /** The name of the answer record. Format: `projects//locations//answer Records/` */
+      answerRecord?: string;
+      /** All sources used to generate the answer. */
+      answerSources?: GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource[];
+      /** The type of the answer. */
+      answerType?: string;
+      /** The confidence score in [0.0, 1.0] range. */
+      confidenceScore?: number;
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource {
+      /** The document from which the snippet was extracted. Format: `projects//knowledgeBases//documents/` */
+      document?: string;
+      /** The relevant snippet of the article. */
+      snippet?: string;
+      /** The title of the article. */
+      title?: string;
+      /** The URI of the article. */
+      uri?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1alpha1SentimentData {
       /** A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. */
       magnitude?: number;
@@ -727,6 +915,16 @@ declare namespace gapi.client {
       /** The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}` */
       speechRecognizer?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion {
+      /** Required. All the parts of generated summary. */
+      summarySections?: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection[];
+    }
+    interface GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection {
+      /** Required. Name of the section. */
+      section?: string;
+      /** Required. Summary text for the section. */
+      summary?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata {
       /** Output only. The time the operation was created. */
       createTime?: string;
@@ -1270,12 +1468,80 @@ declare namespace gapi.client {
       /** The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. */
       source?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1FreeFormSuggestion {
+      /** Optional. Labels for the generator. */
+      labels?: string[];
+      /** Required. Free form suggestion. */
+      response?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1GcsSource {
       /** Cloud Storage URI that points to a file that contains the conversation audio. */
       audioUri?: string;
       /** Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */
       transcriptUri?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1GeneratorSuggestion {
+      /** Optional. Suggestion to coach the agent. */
+      agentCoachingSuggestion?: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion;
+      /** Optional. Free form suggestion. */
+      freeFormSuggestion?: GoogleCloudContactcenterinsightsV1FreeFormSuggestion;
+      /** Optional. Suggested summary. */
+      summarySuggestion?: GoogleCloudContactcenterinsightsV1SummarySuggestion;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse {
+      /** The suggestion generated from the Generator. */
+      generatorSuggestion?: GoogleCloudContactcenterinsightsV1GeneratorSuggestion;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse {
+      /** The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. */
+      suggestedQuery?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery;
+      /** The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. */
+      suggestedQueryAnswer?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer {
+      /** The piece of text from the `source` that answers this suggested query. */
+      answerText?: string;
+      /** Populated if the prediction came from FAQ. */
+      faqSource?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource;
+      /** Populated if the prediction was Generative. */
+      generativeSource?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource;
+      /** Populated if the prediction was from intent matching. */
+      intentMatchingSource?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource;
+      /** The system's confidence score that this answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). */
+      matchConfidence?: number;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource {
+      /** Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`. */
+      document?: string;
+      /** The corresponding FAQ question. */
+      question?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource {
+      /** All snippets used for this Generative Prediction, with their source URI and data. */
+      snippets?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet[];
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet {
+      /** Indicates which Knowledge Document this snippet was extracted from. Format: `projects//knowledgeBases//documents/`. */
+      document?: string;
+      /** text taken from that URI. */
+      text?: string;
+      /** Title of the document. */
+      title?: string;
+      /** URI the data is sourced from. */
+      uri?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource {
+      /** Title of the document. */
+      title?: string;
+      /** URI the data is sourced from. */
+      uri?: string;
+    }
+    interface GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery {
+      /** Suggested query text. */
+      queryText?: string;
+      /** Suggested query score. */
+      score?: number;
+    }
     interface GoogleCloudContactcenterinsightsV1HoldData {}
     interface GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata {
       /** The time the operation was created. */
@@ -1549,6 +1815,12 @@ declare namespace gapi.client {
       endBoundary?: GoogleCloudContactcenterinsightsV1AnnotationBoundary;
       /** Agent Assist FAQ answer data. */
       faqAnswer?: GoogleCloudContactcenterinsightsV1FaqAnswerData;
+      /** The generator suggestion result. */
+      generatorSuggestionResult?: GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse;
+      /** The Knowledge Assist result. */
+      knowledgeAssistResult?: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse;
+      /** The Knowledge Search result. */
+      knowledgeSearchResult?: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer;
       /** Agent Assist Smart Compose suggestion data. */
       smartComposeSuggestion?: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData;
       /** Agent Assist Smart Reply data. */
@@ -1556,6 +1828,28 @@ declare namespace gapi.client {
       /** The boundary in the conversation where the annotation starts, inclusive. */
       startBoundary?: GoogleCloudContactcenterinsightsV1AnnotationBoundary;
     }
+    interface GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer {
+      /** The piece of text from the knowledge base documents that answers the search query */
+      answer?: string;
+      /** The name of the answer record. Format: `projects//locations//answer Records/` */
+      answerRecord?: string;
+      /** All sources used to generate the answer. */
+      answerSources?: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource[];
+      /** The type of the answer. */
+      answerType?: string;
+      /** The confidence score in [0.0, 1.0] range. */
+      confidenceScore?: number;
+    }
+    interface GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource {
+      /** The document from which the snippet was extracted. Format: `projects//knowledgeBases//documents/` */
+      document?: string;
+      /** The relevant snippet of the article. */
+      snippet?: string;
+      /** The title of the article. */
+      title?: string;
+      /** The URI of the article. */
+      uri?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1SentimentData {
       /** A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. */
       magnitude?: number;
@@ -1615,6 +1909,16 @@ declare namespace gapi.client {
       /** The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}` */
       speechRecognizer?: string;
     }
+    interface GoogleCloudContactcenterinsightsV1SummarySuggestion {
+      /** Required. All the parts of generated summary. */
+      summarySections?: GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection[];
+    }
+    interface GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection {
+      /** Required. Name of the section. */
+      section?: string;
+      /** Required. Summary text for the section. */
+      summary?: string;
+    }
     interface GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata {
       /** Output only. The time the operation was created. */
       createTime?: string;

package/package.json

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