googleapis
Version:
Google APIs Client Library for Node.js
1,311 lines (1,310 loc) • 1.4 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, 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);
}
/**
* Represents an event indicating the transfer of a conversation to a different agent.
*/
export interface Schema$GoogleCloudCesV1mainAgentTransfer {
/**
* Output only. Display name of the agent.
*/
displayName?: string | null;
/**
* Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project\}/locations/{location\}/apps/{app\}/agents/{agent\}`
*/
targetAgent?: string | null;
}
/**
* Represents a blob input or output in the conversation.
*/
export interface Schema$GoogleCloudCesV1mainBlob {
/**
* Required. Raw bytes of the blob.
*/
data?: string | null;
/**
* Required. The IANA standard MIME type of the source data.
*/
mimeType?: string | null;
}
/**
* A chunk of content within a message.
*/
export interface Schema$GoogleCloudCesV1mainChunk {
/**
* Optional. Agent transfer event.
*/
agentTransfer?: Schema$GoogleCloudCesV1mainAgentTransfer;
/**
* Optional. Blob data.
*/
blob?: Schema$GoogleCloudCesV1mainBlob;
/**
* A struct represents default variables at the start of the conversation, keyed by variable names.
*/
defaultVariables?: {
[key: string]: any;
} | null;
/**
* Optional. Image data.
*/
image?: Schema$GoogleCloudCesV1mainImage;
/**
* Optional. Custom payload data.
*/
payload?: {
[key: string]: any;
} | null;
/**
* Optional. Text data.
*/
text?: string | null;
/**
* Optional. Tool execution request.
*/
toolCall?: Schema$GoogleCloudCesV1mainToolCall;
/**
* Optional. Tool execution response.
*/
toolResponse?: Schema$GoogleCloudCesV1mainToolResponse;
/**
* Optional. Transcript associated with the audio.
*/
transcript?: string | null;
/**
* A struct represents variables that were updated in the conversation, keyed by variable names.
*/
updatedVariables?: {
[key: string]: any;
} | null;
}
/**
* Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.
*/
export interface Schema$GoogleCloudCesV1mainEndSession {
/**
* Optional. Provides additional information about the end session signal, such as the reason for ending the session.
*/
metadata?: {
[key: string]: any;
} | null;
}
/**
* Represents an image input or output in the conversation.
*/
export interface Schema$GoogleCloudCesV1mainImage {
/**
* Required. Raw bytes of the image.
*/
data?: string | null;
/**
* Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
*/
mimeType?: string | null;
}
/**
* A message within a conversation.
*/
export interface Schema$GoogleCloudCesV1mainMessage {
/**
* Optional. Content of the message as a series of chunks.
*/
chunks?: Schema$GoogleCloudCesV1mainChunk[];
/**
* Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
*/
eventTime?: string | null;
/**
* Optional. The role within the conversation, e.g., user, agent.
*/
role?: string | null;
}
/**
* A span is a unit of work or a single operation during the request processing.
*/
export interface Schema$GoogleCloudCesV1mainSpan {
/**
* Output only. Key-value attributes associated with the span.
*/
attributes?: {
[key: string]: any;
} | null;
/**
* Output only. The child spans that are nested under this span.
*/
childSpans?: Schema$GoogleCloudCesV1mainSpan[];
/**
* Output only. The duration of the span.
*/
duration?: string | null;
/**
* Output only. The end time of the span.
*/
endTime?: string | null;
/**
* Output only. The name of the span.
*/
name?: string | null;
/**
* Output only. The start time of the span.
*/
startTime?: string | null;
}
/**
* Request for the client or the agent to execute the specified tool.
*/
export interface Schema$GoogleCloudCesV1mainToolCall {
/**
* Optional. The input parameters and values for the tool in JSON object format.
*/
args?: {
[key: string]: any;
} | null;
/**
* Output only. Display name of the tool.
*/
displayName?: string | null;
/**
* Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
*/
id?: string | null;
/**
* Optional. The name of the tool to execute. Format: `projects/{project\}/locations/{location\}/apps/{app\}/tools/{tool\}`
*/
tool?: string | null;
/**
* Optional. The toolset tool to execute.
*/
toolsetTool?: Schema$GoogleCloudCesV1mainToolsetTool;
}
/**
* The execution result of a specific tool from the client or the agent.
*/
export interface Schema$GoogleCloudCesV1mainToolResponse {
/**
* Output only. Display name of the tool.
*/
displayName?: string | null;
/**
* Optional. The matching ID of the tool call the response is for.
*/
id?: string | null;
/**
* Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
*/
response?: {
[key: string]: any;
} | null;
/**
* Optional. The name of the tool to execute. Format: `projects/{project\}/locations/{location\}/apps/{app\}/tools/{tool\}`
*/
tool?: string | null;
/**
* Optional. The toolset tool that got executed.
*/
toolsetTool?: Schema$GoogleCloudCesV1mainToolsetTool;
}
/**
* A tool that is created from a toolset.
*/
export interface Schema$GoogleCloudCesV1mainToolsetTool {
/**
* Optional. The tool ID to filter the tools to retrieve the schema for.
*/
toolId?: string | null;
/**
* Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project\}/locations/{location\}/apps/{app\}/toolsets/{toolset\}`
*/
toolset?: string | null;
}
/**
* 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;
/**
* Results of scoring QaScorecards.
*/
qaScorecardResults?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult[];
/**
* Overall conversation-level sentiment for each channel of the call.
*/
sentiments?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment[];
/**
* Overall conversation-level silence during the call.
*/
silence?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence;
}
/**
* 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;
/**
* Configuration for the QA annotator.
*/
qaConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig;
/**
* Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.
*/
runAutoLabelingAnnotator?: boolean | 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 QA annotator.
*/
runQaAnnotator?: 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 the QA feature.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig {
/**
* A manual list of scorecards to score.
*/
scorecardList?: Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList;
}
/**
* Container for a list of scorecards.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList {
/**
* List of QaScorecardRevisions.
*/
qaScorecardRevisions?: string[] | null;
}
/**
* 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;
/**
* The resource name of the existing created generator. Format: projects//locations//generators/
*/
generator?: 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;
/**
* Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.
*/
partialErrors?: Schema$GoogleRpcStatus[];
/**
* Output only. If true, the labeling rules will be re-evaluated for the conversations.
*/
relabel?: boolean | 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;
/**
* Optional. If true, the labeling rules will be re-evaluated for the conversations.
*/
relabel?: boolean | 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;
}
/**
* The metadata for a bulk delete conversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata {
/**
* The time the operation was created.
*/
createTime?: string | null;
/**
* The time the operation finished running.
*/
endTime?: string | null;
/**
* Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.
*/
partialErrors?: Schema$GoogleRpcStatus[];
/**
* The original request for bulk delete.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest;
}
/**
* The request to delete conversations in bulk.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest {
/**
* Filter used to select the subset of conversations to delete.
*/
filter?: string | null;
/**
* If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
*/
force?: boolean | null;
/**
* Maximum number of conversations to delete.
*/
maxDeleteCount?: number | null;
/**
* Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\}
*/
parent?: string | null;
}
/**
* The response for a bulk delete conversations operation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse {
}
/**
* Metadata for the BulkDeleteFeedbackLabels endpoint.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata {
/**
* Partial errors during deletion operation that might cause the operation output to be incomplete.
*/
partialErrors?: Schema$GoogleRpcStatus[];
/**
* Output only. The original request for delete.
*/
request?: Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest;
}
/**
* Request for the BulkDeleteFeedbackLabels endpoint.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest {
/**
* Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
*/
filter?: string | null;
/**
* Required. The parent resource for new feedback labels.
*/
parent?: string | null;
}
/**
* Response for the BulkDeleteFeedbackLabels endpoint.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse {
}
/**
* 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 CES end session annotation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation {
/**
* End session signal from CES.
*/
endSession?: Schema$GoogleCloudCesV1mainEndSession;
}
/**
* The CES diagnostic information.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation {
/**
* The messages in the turn.
*/
messages?: Schema$GoogleCloudCesV1mainMessage[];
/**
* The root span of the action processing.
*/
rootSpan?: Schema$GoogleCloudCesV1mainSpan;
}
/**
* The result of testing a constraint expression on a pair of conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult {
/**
* The first conversation resource name.
*/
conversationA?: string | null;
/**
* The second conversation resource name.
*/
conversationB?: string | null;
/**
* The results for each applicable constraint rule.
*/
ruleConstraintResults?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult[];
}
/**
* The result of a single constraint rule on the pair of conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult {
/**
* Whether the constraint expression evaluated to true for (A, B) or (B, A).
*/
constraintMet?: boolean | null;
/**
* The error status if the constraint expression failed to evaluate.
*/
error?: Schema$GoogleRpcStatus;
/**
* The rule ID.
*/
ruleId?: string | null;
}
/**
* 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. Info for correlating across conversations.
*/
correlationInfo?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo;
/**
* 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 100 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.
*/
medium?: string | null;
/**
* Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.
*/
metadataJson?: 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;
/**
* Conversation metadata related to quality management.
*/
qualityMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata;
/**
* 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;
}
/**
* Info for correlating across conversations.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo {
/**
* Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.
*/
correlationTypes?: string[] | null;
/**
* Output only. The full conversation correlation id this conversation is a segment of.
*/
fullConversationCorrelationId?: string | null;
/**
* Output only. The full conversation correlation id this conversation is a merged conversation of.
*/
mergedFullConversationCorrelationId?: string | null;
}
/**
* The result of testing correlation config on a single conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult {
/**
* The conversation resource name.
*/
conversation?: string | null;
/**
* The results for each correlation rule.
*/
ruleResults?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult[];
}
/**
* The result of a single correlation rule.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult {
/**
* The correlation ID generated by the join key expression.
*/
correlationId?: string | null;
/**
* The error status if the join key expression failed to evaluate.
*/
error?: Schema$GoogleRpcStatus;
/**
* The rule ID.
*/
ruleId?: string | 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;
/**
* Cloud Storage URI that points to a file that contains the conversation metadata.
*/
metadataUri?: string | null;
/**
* Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.
*/
turnLevelAudios?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio[];
}
/**
* A wrapper for holding the audio for any given turn.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio {
/**
* The duration of the audio.
*/
audioDuration?: string | null;
/**
* The Cloud Storage URI of the audio for any given turn.
*/
audioGcsUri?: string | null;
}
/**
* 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;
}
/**
* Conversation-level silence data.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence {
/**
* Amount of time calculated to be in silence.
*/
silenceDuration?: string | null;
/**
* Percentage of the total conversation spent in silence.
*/
silencePercentage?: number | null;
}
/**
* 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 metadata related to quality management.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata {
/**
* Information about agents involved in the call.
*/
agentInfo?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo[];
/**
* An arbitrary integer value indicating the customer's satisfaction rating.
*/
customerSatisfactionRating?: number | null;
/**
* Input only. The feedback labels associated with the conversation.
*/
feedbackLabels?: Schema$GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel[];
/**
* An arbitrary string value specifying the menu path the customer took.
*/
menuPath?: string | null;
/**
* The amount of time the customer waited to connect with an agent.
*/
waitDuration?: string | null;
}
/**
* Information about an agent involved in the conversation.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo {
/**
* A user-specified string representing the agent.
*/
agentId?: string | null;
/**
* The agent type, e.g. HUMAN_AGENT.
*/
agentType?: string | null;
/**
* The agent's deployment display name. Only applicable to automated agents.
*/
deploymentDisplayName?: string | null;
/**
* The agent's deployment ID. Only applicable to automated agents.
*/
deploymentId?: string | null;
/**
* The agent's name.
*/
displayName?: string | null;
/**
* A user-provided string indicating the outcome of the agent's segment of the call.
*/
dispositionCode?: string | null;
/**
* The entry subagent's display name.
*/
entrySubagentDisplayName?: string | null;
/**
* The entry subagent's ID.
*/
entrySubagentId?: string | null;
/**
* The agent's location.
*/
location?: string | null;
/**
* A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
*/
team?: string | null;
/**
* User-specified strings representing the agent's teams.
*/
teams?: string[] | null;
/**
* The agent's version display name. Only applicable to automated agents.
*/
versionDisplayName?: string | null;
/**
* The agent's version ID. Only applicable to automated agents.
*/
versionId?: 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;
/**
* Agent Assist generator ID.
*/
generatorId?: 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;
/**
* Turn level audio for this transcript segment.
*/
turnLevelAudio?: Schema$GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio;
/**
* 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.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata {
/**
* 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$GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest;
}
/**
* 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;
}
/**
* The request to create an issue.
*/
export interface Schema$GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest {
/**
* Required. The values for the new issue.
*/
issue?: Schema$GoogleCloudContactcenterinsightsV1alpha1Issue;
/**