googleapis
Version:
Google APIs Client Library for Node.js
1,272 lines • 205 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace contactcenterinsights_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
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;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Contact Center AI Insights API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const contactcenterinsights = google.contactcenterinsights('v1');
* ```
*/
export class Contactcenterinsights {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The analysis resource.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1Analysis {
/**
* Output only. The result of the analysis, which is populated when the analysis finishes.
*/
analysisResult?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnalysisResult;
/**
* To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
*/
annotatorSelector?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector;
/**
* Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
*/
createTime?: string | null;
/**
* Immutable. The resource name of the analysis. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/analyses/{analysis\}
*/
name?: string | null;
/**
* Output only. The time at which the analysis was requested.
*/
requestTime?: string | null;
}
/**
* The result of an analysis.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnalysisResult {
/**
* Call-specific metadata created by the analysis.
*/
callAnalysisMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata;
/**
* The time at which the analysis ended.
*/
endTime?: string | null;
}
/**
* Call-specific metadata created during analysis.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata {
/**
* A list of call annotations that apply to this call.
*/
annotations?: Schema$GoogleCloudContactcenterinsightsV1alpha1CallAnnotation[];
/**
* All the entities in the call.
*/
entities?: {
[key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1Entity;
} | null;
/**
* All the matched intents in the call.
*/
intents?: {
[key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1Intent;
} | null;
/**
* Overall conversation-level issue modeling result.
*/
issueModelResult?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelResult;
/**
* All the matched phrase matchers in the call.
*/
phraseMatchers?: {
[key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData;
} | null;
/**
* Overall conversation-level sentiment for each channel of the call.
*/
sentiments?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment[];
}
/**
* A point in a conversation that marks the start or the end of an annotation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary {
/**
* The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.
*/
transcriptIndex?: number | null;
/**
* The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.
*/
wordIndex?: number | null;
}
/**
* Selector of all available annotators and phrase matchers to run.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector {
/**
* The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
*/
issueModels?: string[] | null;
/**
* The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project\}/locations/{location\}/phraseMatchers/{phrase_matcher\}
*/
phraseMatchers?: string[] | null;
/**
* Whether to run the entity annotator.
*/
runEntityAnnotator?: boolean | null;
/**
* Whether to run the intent annotator.
*/
runIntentAnnotator?: boolean | null;
/**
* Whether to run the interruption annotator.
*/
runInterruptionAnnotator?: boolean | null;
/**
* Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
*/
runIssueModelAnnotator?: boolean | null;
/**
* Whether to run the active phrase matcher annotator(s).
*/
runPhraseMatcherAnnotator?: boolean | null;
/**
* Whether to run the sentiment annotator.
*/
runSentimentAnnotator?: boolean | null;
/**
* Whether to run the silence annotator.
*/
runSilenceAnnotator?: boolean | null;
/**
* Whether to run the summarization annotator.
*/
runSummarizationAnnotator?: boolean | null;
/**
* Configuration for the summarization annotator.
*/
summarizationConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig;
}
/**
* Configuration for summarization.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig {
/**
* Resource name of the Dialogflow conversation profile. Format: projects/{project\}/locations/{location\}/conversationProfiles/{conversation_profile\}
*/
conversationProfile?: string | null;
/**
* Default summarization model to be used.
*/
summarizationModel?: string | null;
}
/**
* The feedback that the customer has about a certain answer in the conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback {
/**
* Indicates whether an answer or item was clicked by the human agent.
*/
clicked?: boolean | null;
/**
* The correctness level of an answer.
*/
correctnessLevel?: string | null;
/**
* Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.
*/
displayed?: boolean | null;
}
/**
* Agent Assist Article Suggestion data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData {
/**
* The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
*/
confidenceScore?: number | null;
/**
* Map that contains metadata about the Article Suggestion and the document that it originates from.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* The name of the answer record. Format: projects/{project\}/locations/{location\}/answerRecords/{answer_record\}
*/
queryRecord?: string | null;
/**
* The knowledge document that this answer was extracted from. Format: projects/{project\}/knowledgeBases/{knowledge_base\}/documents/{document\}
*/
source?: string | null;
/**
* Article title.
*/
title?: string | null;
/**
* Article URI.
*/
uri?: string | null;
}
/**
* The metadata for a bulk analyze conversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata {
/**
* The number of requested analyses that have completed successfully so far.
*/
completedAnalysesCount?: number | null;
/**
* The time the operation was created.
*/
createTime?: string | null;
/**
* The time the operation finished running.
*/
endTime?: string | null;
/**
* The number of requested analyses that have failed so far.
*/
failedAnalysesCount?: number | null;
/**
* The original request for bulk analyze.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest;
/**
* Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.
*/
totalRequestedAnalysesCount?: number | null;
}
/**
* The request to analyze conversations in bulk.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest {
/**
* Required. Percentage of selected conversation to analyze, between [0, 100].
*/
analysisPercentage?: number | null;
/**
* To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
*/
annotatorSelector?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector;
/**
* Required. Filter used to select the subset of conversations to analyze.
*/
filter?: string | null;
/**
* Required. The parent resource to create analyses in.
*/
parent?: string | null;
}
/**
* The response for a bulk analyze conversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse {
/**
* Count of failed analyses.
*/
failedAnalysisCount?: number | null;
/**
* Count of successful analyses.
*/
successfulAnalysisCount?: number | null;
}
/**
* A piece of metadata that applies to a window of a call.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CallAnnotation {
/**
* The boundary in the conversation where the annotation ends, inclusive.
*/
annotationEndBoundary?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
/**
* The boundary in the conversation where the annotation starts, inclusive.
*/
annotationStartBoundary?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary;
/**
* The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.
*/
channelTag?: number | null;
/**
* Data specifying an entity mention.
*/
entityMentionData?: Schema$GoogleCloudContactcenterinsightsV1alpha1EntityMentionData;
/**
* Data specifying a hold.
*/
holdData?: Schema$GoogleCloudContactcenterinsightsV1alpha1HoldData;
/**
* Data specifying an intent match.
*/
intentMatchData?: Schema$GoogleCloudContactcenterinsightsV1alpha1IntentMatchData;
/**
* Data specifying an interruption.
*/
interruptionData?: Schema$GoogleCloudContactcenterinsightsV1alpha1InterruptionData;
/**
* Data specifying an issue match.
*/
issueMatchData?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueMatchData;
/**
* Data specifying a phrase match.
*/
phraseMatchData?: Schema$GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData;
/**
* Data specifying sentiment.
*/
sentimentData?: Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData;
/**
* Data specifying silence.
*/
silenceData?: Schema$GoogleCloudContactcenterinsightsV1alpha1SilenceData;
}
/**
* The conversation resource.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1Conversation {
/**
* An opaque, user-specified string representing the human agent who handled the conversation.
*/
agentId?: string | null;
/**
* Call-specific metadata.
*/
callMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata;
/**
* Output only. The time at which the conversation was created.
*/
createTime?: string | null;
/**
* The source of the audio and transcription for the conversation.
*/
dataSource?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource;
/**
* Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project\}/agent/{agent\}/intents/{intent\}
*/
dialogflowIntents?: {
[key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent;
} | null;
/**
* Output only. The duration of the conversation.
*/
duration?: string | null;
/**
* The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
*/
expireTime?: string | null;
/**
* A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
*/
labels?: {
[key: string]: string;
} | null;
/**
* A user-specified language code for the conversation.
*/
languageCode?: string | null;
/**
* Output only. The conversation's latest analysis, if one exists.
*/
latestAnalysis?: Schema$GoogleCloudContactcenterinsightsV1alpha1Analysis;
/**
* Output only. Latest summary of the conversation.
*/
latestSummary?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData;
/**
* Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
*/
medium?: string | null;
/**
* Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}
*/
name?: string | null;
/**
* Obfuscated user ID which the customer sent to us.
*/
obfuscatedUserId?: string | null;
/**
* Output only. The annotations that were generated during the customer and agent interaction.
*/
runtimeAnnotations?: Schema$GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation[];
/**
* The time at which the conversation started.
*/
startTime?: string | null;
/**
* Output only. The conversation transcript.
*/
transcript?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript;
/**
* Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
*/
ttl?: string | null;
/**
* Output only. The number of turns in the conversation.
*/
turnCount?: number | null;
/**
* Output only. The most recent time at which the conversation was updated.
*/
updateTime?: string | null;
}
/**
* Call-specific metadata.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata {
/**
* The audio channel that contains the agent.
*/
agentChannel?: number | null;
/**
* The audio channel that contains the customer.
*/
customerChannel?: number | null;
}
/**
* The conversation source, which is a combination of transcript and audio.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource {
/**
* The source when the conversation comes from Dialogflow.
*/
dialogflowSource?: Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowSource;
/**
* A Cloud Storage location specification for the audio and transcript.
*/
gcsSource?: Schema$GoogleCloudContactcenterinsightsV1alpha1GcsSource;
}
/**
* One channel of conversation-level sentiment data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment {
/**
* The channel of the audio that the data applies to.
*/
channelTag?: number | null;
/**
* Data specifying sentiment.
*/
sentimentData?: Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData;
}
/**
* The call participant speaking for a given utterance.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant {
/**
* Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/participants/{participant\}
*/
dialogflowParticipant?: string | null;
/**
* The name of the participant provided by Dialogflow. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/participants/{participant\}
*/
dialogflowParticipantName?: string | null;
/**
* Obfuscated user ID from Dialogflow.
*/
obfuscatedExternalUserId?: string | null;
/**
* The role of the participant.
*/
role?: string | null;
/**
* A user-specified ID representing the participant.
*/
userId?: string | null;
}
/**
* Conversation summarization suggestion data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData {
/**
* The name of the answer record. Format: projects/{project\}/locations/{location\}/answerRecords/{answer_record\}
*/
answerRecord?: string | null;
/**
* The confidence score of the summarization.
*/
confidence?: number | null;
/**
* The name of the model that generates this summary. Format: projects/{project\}/locations/{location\}/conversationModels/{conversation_model\}
*/
conversationModel?: string | null;
/**
* A map that contains metadata about the summarization and the document from which it originates.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* The summarization content that is concatenated into one string.
*/
text?: string | null;
/**
* The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
*/
textSections?: {
[key: string]: string;
} | null;
}
/**
* A message representing the transcript of a conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript {
/**
* A list of sequential transcript segments that comprise the conversation.
*/
transcriptSegments?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment[];
}
/**
* A segment of a full transcript.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment {
/**
* For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.
*/
channelTag?: number | null;
/**
* A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.
*/
confidence?: number | null;
/**
* CCAI metadata relating to the current transcript segment.
*/
dialogflowSegmentMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata;
/**
* The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US".
*/
languageCode?: string | null;
/**
* The time that the message occurred, if provided.
*/
messageTime?: string | null;
/**
* The participant of this segment.
*/
segmentParticipant?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant;
/**
* The sentiment for this transcript segment.
*/
sentiment?: Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData;
/**
* The text of this segment.
*/
text?: string | null;
/**
* A list of the word-specific information for each word in the segment.
*/
words?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo[];
}
/**
* Metadata from Dialogflow relating to the current transcript segment.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata {
/**
* Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.
*/
smartReplyAllowlistCovered?: boolean | null;
}
/**
* Word-level info for words in a transcript.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo {
/**
* A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.
*/
confidence?: number | null;
/**
* Time offset of the end of this word relative to the beginning of the total conversation.
*/
endOffset?: string | null;
/**
* Time offset of the start of this word relative to the beginning of the total conversation.
*/
startOffset?: string | null;
/**
* The word itself. Includes punctuation marks that surround the word.
*/
word?: string | null;
}
/**
* Metadata for a create analysis operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata {
/**
* Output only. The annotator selector used for the analysis (if any).
*/
annotatorSelector?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector;
/**
* Output only. The Conversation that this Analysis Operation belongs to.
*/
conversation?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
}
/**
* Metadata for creating an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata {
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* The original request for creation.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest;
}
/**
* The request to create an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest {
/**
* Required. The issue model to create.
*/
issueModel?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModel;
/**
* Required. The parent resource of the issue model.
*/
parent?: string | null;
}
/**
* Metadata for deleting an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata {
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* The original request for deletion.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest;
}
/**
* The request to delete an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest {
/**
* Required. The name of the issue model to delete.
*/
name?: string | null;
}
/**
* Metadata for deploying an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata {
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* The original request for deployment.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest;
}
/**
* The request to deploy an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest {
/**
* Required. The issue model to deploy.
*/
name?: string | null;
}
/**
* The response to deploy an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse {
}
/**
* The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent {
/**
* The human-readable name of the intent.
*/
displayName?: string | null;
}
/**
* Dialogflow interaction data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData {
/**
* The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
*/
confidence?: number | null;
/**
* The Dialogflow intent resource path. Format: projects/{project\}/agent/{agent\}/intents/{intent\}
*/
dialogflowIntentId?: string | null;
}
/**
* A Dialogflow source of conversation data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowSource {
/**
* Cloud Storage URI that points to a file that contains the conversation audio.
*/
audioUri?: string | null;
/**
* Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}
*/
dialogflowConversation?: string | null;
}
/**
* The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1Entity {
/**
* The representative name for the entity.
*/
displayName?: string | null;
/**
* Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
*/
salience?: number | null;
/**
* The aggregate sentiment expressed for this entity in the conversation.
*/
sentiment?: Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData;
/**
* The entity type.
*/
type?: string | null;
}
/**
* The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1EntityMentionData {
/**
* The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.
*/
entityUniqueId?: string | null;
/**
* Sentiment expressed for this mention of the entity.
*/
sentiment?: Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData;
/**
* The type of the entity mention.
*/
type?: string | null;
}
/**
* Metadata for an export insights operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata {
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Partial errors during export operation that might cause the operation output to be incomplete.
*/
partialErrors?: Schema$GoogleRpcStatus[];
/**
* The original request for export.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest;
}
/**
* The request to export insights.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest {
/**
* Specified if sink is a BigQuery table.
*/
bigQueryDestination?: Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination;
/**
* A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.
*/
filter?: string | null;
/**
* A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}/cryptoKeyVersions/{version\}
*/
kmsKey?: string | null;
/**
* Required. The parent resource to export data from.
*/
parent?: string | null;
/**
* Options for what to do if the destination table already exists.
*/
writeDisposition?: string | null;
}
/**
* A BigQuery Table Reference.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination {
/**
* 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.
*/
dataset?: string | null;
/**
* A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.
*/
projectId?: string | null;
/**
* The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.
*/
table?: string | null;
}
/**
* Response for an export insights operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse {
}
/**
* Agent Assist frequently-asked-question answer data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData {
/**
* The piece of text from the `source` knowledge base document.
*/
answer?: string | null;
/**
* The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
*/
confidenceScore?: number | null;
/**
* Map that contains metadata about the FAQ answer and the document that it originates from.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* The name of the answer record. Format: projects/{project\}/locations/{location\}/answerRecords/{answer_record\}
*/
queryRecord?: string | null;
/**
* The corresponding FAQ question.
*/
question?: string | null;
/**
* The knowledge document that this answer was extracted from. Format: projects/{project\}/knowledgeBases/{knowledge_base\}/documents/{document\}.
*/
source?: string | null;
}
/**
* A Cloud Storage source of conversation data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1GcsSource {
/**
* Cloud Storage URI that points to a file that contains the conversation audio.
*/
audioUri?: string | null;
/**
* Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.
*/
transcriptUri?: string | null;
}
/**
* The data for a hold annotation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1HoldData {
}
/**
* The metadata for an IngestConversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata {
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Statistics for IngestConversations operation.
*/
ingestConversationsStats?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats;
/**
* Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.
*/
partialErrors?: Schema$GoogleRpcStatus[];
/**
* Output only. The original request for ingest.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest;
}
/**
* Statistics for IngestConversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats {
/**
* Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.
*/
duplicatesSkippedCount?: number | null;
/**
* Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.
*/
failedIngestCount?: number | null;
/**
* Output only. The number of objects processed during the ingest operation.
*/
processedObjectCount?: number | null;
/**
* Output only. The number of new conversations added during this ingest operation.
*/
successfulIngestCount?: number | null;
}
/**
* The request to ingest conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest {
/**
* Configuration that applies to all conversations.
*/
conversationConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig;
/**
* A cloud storage bucket source.
*/
gcsSource?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource;
/**
* Required. The parent resource for new conversations.
*/
parent?: string | null;
/**
* Configuration for when `source` contains conversation transcripts.
*/
transcriptObjectConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig;
}
/**
* Configuration that applies to all conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig {
/**
* An opaque, user-specified string representing the human agent who handled the conversations.
*/
agentId?: string | null;
}
/**
* Configuration for Cloud Storage bucket sources.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource {
/**
* Required. The Cloud Storage bucket containing source objects.
*/
bucketUri?: string | null;
}
/**
* Configuration for processing transcript objects.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig {
/**
* Required. The medium transcript objects represent.
*/
medium?: string | null;
}
/**
* The response to an IngestConversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse {
}
/**
* The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1Intent {
/**
* The human-readable name of the intent.
*/
displayName?: string | null;
/**
* The unique identifier of the intent.
*/
id?: string | null;
}
/**
* The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IntentMatchData {
/**
* The id of the matched intent. Can be used to retrieve the corresponding intent information.
*/
intentUniqueId?: string | null;
}
/**
* The data for an interruption annotation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1InterruptionData {
}
/**
* Information about the issue.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueAssignment {
/**
* Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.
*/
displayName?: string | null;
/**
* Resource name of the assigned issue.
*/
issue?: string | null;
/**
* Score indicating the likelihood of the issue assignment. currently bounded on [0,1].
*/
score?: number | null;
}
/**
* The data for an issue match annotation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueMatchData {
/**
* Information about the issue's assignment.
*/
issueAssignment?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueAssignment;
}
/**
* The issue model resource.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModel {
/**
* Output only. The time at which this issue model was created.
*/
createTime?: string | null;
/**
* The representative name for the issue model.
*/
displayName?: string | null;
/**
* Configs for the input data that used to create the issue model.
*/
inputDataConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig;
/**
* Output only. Number of issues in this issue model.
*/
issueCount?: string | null;
/**
* Language of the model.
*/
languageCode?: string | null;
/**
* Type of the model.
*/
modelType?: string | null;
/**
* Immutable. The resource name of the issue model. Format: projects/{project\}/locations/{location\}/issueModels/{issue_model\}
*/
name?: string | null;
/**
* Output only. State of the model.
*/
state?: string | null;
/**
* Output only. Immutable. The issue model's label statistics on its training data.
*/
trainingStats?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats;
/**
* Output only. The most recent time at which the issue model was updated.
*/
updateTime?: string | null;
}
/**
* Configs for the input data used to create the issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig {
/**
* A filter to reduce the conversations used for training the model to a specific subset.
*/
filter?: string | null;
/**
* Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.
*/
medium?: string | null;
/**
* Output only. Number of conversations used in training. Output only.
*/
trainingConversationsCount?: string | null;
}
/**
* Aggregated statistics about an issue model.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats {
/**
* Number of conversations the issue model has analyzed at this point in time.
*/
analyzedConversationsCount?: string | null;
/**
* Statistics on each issue. Key is the issue's resource name.
*/
issueStats?: {
[key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats;
} | null;
/**
* Number of analyzed conversations for which no issue was applicable at this point in time.
*/
unclassifiedConversationsCount?: string | null;
}
/**
* Aggregated statistics about an issue.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats {
/**
* Display name of the issue.
*/
displayName?: string | null;
/**
* Issue resource. Format: projects/{project\}/locations/{location\}/issueModels/{issue_model\}/issues/{issue\}
*/
issue?: string | null;
/**
* Number of conversations attached to the issue at this point in time.
*/
labeledConversationsCount?: string | null;
}
/**
* Issue Modeling result on a conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueModelResult {
/**
* Issue model that generates the result. Format: projects/{project\}/locations/{location\}/issueModels/{issue_model\}
*/
issueModel?: string | null;
/**
* All the matched issues.
*/
issues?: Schema$GoogleCloudContactcenterinsightsV1alpha1IssueAssignment[];
}
/**
* The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData {
/**
* The human-readable name of the phrase matcher.
*/
displayName?: string | null;
/**
* The unique identifier (the resource name) of the phrase matcher.
*/
phraseMatcher?: string | null;
}
/**
* DLP resources used for redaction while ingesting conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1RedactionConfig {
/**
* The fully-qualified DLP deidentify template resource name. Format: `projects/{project\}/deidentifyTemplates/{template\}`
*/
deidentifyTemplate?: string | null;
/**
* The fully-qualified DLP inspect template resource name. Format: `projects/{project\}/locations/{location\}/inspectTemplates/{template\}`
*/
inspectTemplate?: string | null;
}
/**
* An annotation that was generated during the customer and agent interaction.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation {
/**
* The unique identifier of the annotation. Format: projects/{project\}/locations/{location\}/conversationDatasets/{dataset\}/conversationDataItems/{data_item\}/conversationAnnotations/{annotation\}
*/
annotationId?: string | null;
/**
* The feedback that the customer has about the answer in `data`.
*/
answerFeedback?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback;
/**
* Agent Assist Article Suggestion data.
*/
articleSuggestion?: Schema$GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData;
/**
* Conversation summarization suggestion data.
*/
conversationSummarizationSuggestion?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData;
/**
* The time at which this annotation was created.
*/
createTime?: string | null;
/**
* Dialogflow interaction data.
*/
dialogflowInteraction?: Schema$GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData;
/**
* The boundary in the conversation where the annotation ends, inclusive.
*/
endBoundary?: Schema$G