--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig `POST /v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig` ## Request - Base URL: `https://contactcenterinsights.googleapis.com` - URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Tests correlation config on a conversation. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Request body - GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest: The request to test correlation config. - `conversations` GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations: Wrapper for a list of conversations. - `conversations` GoogleCloudContactcenterinsightsV1Conversation[]: Optional. The conversations. - `agentId` string: An opaque, user-specified string representing the human agent who handled the conversation. - `callMetadata` GoogleCloudContactcenterinsightsV1ConversationCallMetadata: Call-specific metadata. - `agentChannel` integer: The audio channel that contains the agent. - `customerChannel` integer: The audio channel that contains the customer. - `correlationInfo` GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo: Info for correlating across conversations. - `correlationTypes` string[]: 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. - `fullConversationCorrelationId` string: Output only. The full conversation correlation id this conversation is a segment of. - `mergedFullConversationCorrelationId` string: Output only. The full conversation correlation id this conversation is a merged conversation of. - `createTime` string, google-datetime: Output only. The time at which the conversation was created. - `dataSource` GoogleCloudContactcenterinsightsV1ConversationDataSource: The conversation source, which is a combination of transcript and audio. - `dialogflowSource` GoogleCloudContactcenterinsightsV1DialogflowSource: A Dialogflow source of conversation data. - `audioUri` string: Cloud Storage URI that points to a file that contains the conversation audio. - `dialogflowConversation` string: Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} - `gcsSource` GoogleCloudContactcenterinsightsV1GcsSource: A Cloud Storage source of conversation data. - `audioUri` string: Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio. - `audioUris` string[]: Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers). - `transcriptUri` string: Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. - `metadataUri` string: Cloud Storage URI that points to a file that contains the conversation metadata. - `turnLevelAudios` GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio[]: 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. - `audioDuration` string, google-duration: The duration of the audio. - `audioGcsUri` string: The Cloud Storage URI of the audio for any given turn. - `dialogflowIntents` object: Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} - `duration` string, google-duration: Output only. The duration of the conversation. - `expireTime` string, google-datetime: The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. - `labels` object: 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. - `languageCode` string: A user-specified language code for the conversation. - `latestAnalysis` GoogleCloudContactcenterinsightsV1Analysis: The analysis resource. - `analysisResult` GoogleCloudContactcenterinsightsV1AnalysisResult: The result of an analysis. - `callAnalysisMetadata` GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: Call-specific metadata created during analysis. - `annotations` GoogleCloudContactcenterinsightsV1CallAnnotation[]: A list of call annotations that apply to this call. - … - `entities` object: All the entities in the call. - `intents` object: All the matched intents in the call. - `issueModelResult` GoogleCloudContactcenterinsightsV1IssueModelResult: Issue Modeling result on a conversation. - … - `phraseMatchers` object: All the matched phrase matchers in the call. - `qaScorecardResults` GoogleCloudContactcenterinsightsV1QaScorecardResult[]: Results of scoring QaScorecards. - … - `sentiments` GoogleCloudContactcenterinsightsV1ConversationLevelSentiment[]: Overall conversation-level sentiment for each channel of the call. - … - `silence` GoogleCloudContactcenterinsightsV1ConversationLevelSilence: Conversation-level silence data. - … - `endTime` string, google-datetime: The time at which the analysis ended. - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector: Selector of all available annotators and phrase matchers to run. - `issueModels` string[]: 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. - `phraseMatchers` string[]: 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} - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: Configuration for the QA feature. - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: Container for a list of scorecards. - … - `runAutoLabelingAnnotator` boolean: 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. - `runEntityAnnotator` boolean: Whether to run the entity annotator. - `runIntentAnnotator` boolean: Whether to run the intent annotator. - `runInterruptionAnnotator` boolean: Whether to run the interruption annotator. - `runIssueModelAnnotator` boolean: Whether to run the issue model annotator. A model should have already been deployed for this to take effect. - `runPhraseMatcherAnnotator` boolean: Whether to run the active phrase matcher annotator(s). - `runQaAnnotator` boolean: Whether to run the QA annotator. - `runSentimentAnnotator` boolean: Whether to run the sentiment annotator. - `runSilenceAnnotator` boolean: Whether to run the silence annotator. - `runSummarizationAnnotator` boolean: Whether to run the summarization annotator. - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: Configuration for summarization. - `conversationProfile` string: Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - `generator` string: The resource name of the existing created generator. Format: projects//locations//generators/ - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0': Default summarization model to be used. - `createTime` string, google-datetime: Output only. The time at which the analysis was created, which occurs when the long-running operation completes. - `name` string: Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - `requestTime` string, google-datetime: Output only. The time at which the analysis was requested. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `latestSummary` GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: Conversation summarization suggestion data. - `answerRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `confidence` number, float: The confidence score of the summarization. - `conversationModel` string: The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model} - `generatorId` string: Agent Assist generator ID. - `metadata` object: A map that contains metadata about the summarization and the document from which it originates. - `text` string: The summarization content that is concatenated into one string. - `textSections` object: 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. - `medium` 'MEDIUM_UNSPECIFIED' | 'PHONE_CALL' | 'CHAT': Immutable. The conversation medium. - `metadataJson` string: 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. - `name` string: Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} - `obfuscatedUserId` string: Obfuscated user ID which the customer sent to us. - `qualityMetadata` GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: Conversation metadata related to quality management. - `agentInfo` GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo[]: Information about agents involved in the call. - `agentId` string: A user-specified string representing the agent. - `agentType` 'ROLE_UNSPECIFIED' | 'HUMAN_AGENT' | 'AUTOMATED_AGENT' | 'END_USER' | 'ANY_AGENT': The agent type, e.g. HUMAN_AGENT. - `deploymentDisplayName` string: The agent's deployment display name. Only applicable to automated agents. - `deploymentId` string: The agent's deployment ID. Only applicable to automated agents. - `displayName` string: The agent's name. - `dispositionCode` string: A user-provided string indicating the outcome of the agent's segment of the call. - `entrySubagentDisplayName` string: The entry subagent's display name. - `entrySubagentId` string: The entry subagent's ID. - `location` string: The agent's location. - `studyArmId` string: The study arm ID associated with the conversation. Only applicable to automated agents. - `studyId` string: The study ID associated with the conversation. Only applicable to automated agents. - `team` string: A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. - `teams` string[]: User-specified strings representing the agent's teams. - `versionDisplayName` string: The agent's version display name. Only applicable to automated agents. - `versionId` string: The agent's version ID. Only applicable to automated agents. - `customerSatisfactionRating` integer: An arbitrary integer value indicating the customer's satisfaction rating. - `feedbackLabels` GoogleCloudContactcenterinsightsV1FeedbackLabel[]: Input only. The feedback labels associated with the conversation. - `createTime` string, google-datetime: Output only. Create time of the label. - `label` string: String label used for Topic Modeling. - `labeledResource` string: Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` - `name` string: Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - `qaAnswerLabel` GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue: Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. - `boolValue` boolean: Boolean value. - `key` string: A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. - `naValue` boolean: A value of "Not Applicable (N/A)". Should only ever be `true`. - `normalizedScore` number, double: Output only. Normalized score of the questions. Calculated as score / potential_score. - `numValue` number, double: Numerical value. - `potentialScore` number, double: Output only. The maximum potential score of the question. - `score` number, double: Output only. Numerical score of the answer. - `skipValue` boolean: Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. - `strValue` string: String value. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `updateTime` string, google-datetime: Output only. Update time of the label. - `menuPath` string: An arbitrary string value specifying the menu path the customer took. - `waitDuration` string, google-duration: The amount of time the customer waited to connect with an agent. - `runtimeAnnotations` GoogleCloudContactcenterinsightsV1RuntimeAnnotation[]: Output only. The annotations that were generated during the customer and agent interaction. - `annotationId` string: The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - `answerFeedback` GoogleCloudContactcenterinsightsV1AnswerFeedback: The feedback that the customer has about a certain answer in the conversation. - `clicked` boolean: Indicates whether an answer or item was clicked by the human agent. - `correctnessLevel` 'CORRECTNESS_LEVEL_UNSPECIFIED' | 'NOT_CORRECT' | 'PARTIALLY_CORRECT' | 'FULLY_CORRECT': The correctness level of an answer. - `displayed` boolean: Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. - `articleSuggestion` GoogleCloudContactcenterinsightsV1ArticleSuggestionData: Agent Assist Article Suggestion data. - `confidenceScore` number, float: 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). - `metadata` object: Map that contains metadata about the Article Suggestion and the document that it originates from. - `queryRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `source` string: The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - `title` string: Article title. - `uri` string: Article URI. - `cesEndSessionAnnotation` GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation: The CES end session annotation. - `endSession` GoogleCloudCesV1mainEndSession: 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. - `metadata` object: Optional. Provides additional information about the end session signal, such as the reason for ending the session. - `cesTurnAnnotation` GoogleCloudContactcenterinsightsV1CesTurnAnnotation: The CES diagnostic information. - `messages` GoogleCloudCesV1mainMessage[]: The messages in the turn. - `chunks` GoogleCloudCesV1mainChunk[]: Optional. Content of the message as a series of chunks. - … - `eventTime` string, google-datetime: Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example. - `role` string: Optional. The role within the conversation, e.g., user, agent. - `rootSpan` GoogleCloudCesV1mainSpan: A span is a unit of work or a single operation during the request processing. - `attributes` object: Output only. Key-value attributes associated with the span. - `childSpans` GoogleCloudCesV1mainSpan[]: Output only. The child spans that are nested under this span. - `duration` string, google-duration: Output only. The duration of the span. - `endTime` string, google-datetime: Output only. The end time of the span. - `name` string: Output only. The name of the span. - `startTime` string, google-datetime: Output only. The start time of the span. - `conversationSummarizationSuggestion` GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: Conversation summarization suggestion data. - `answerRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `confidence` number, float: The confidence score of the summarization. - `conversationModel` string: The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model} - `generatorId` string: Agent Assist generator ID. - `metadata` object: A map that contains metadata about the summarization and the document from which it originates. - `text` string: The summarization content that is concatenated into one string. - `textSections` object: 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. - `createTime` string, google-datetime: The time at which this annotation was created. - `dialogflowInteraction` GoogleCloudContactcenterinsightsV1DialogflowInteractionData: Dialogflow interaction data. - `confidence` number, float: The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - `dialogflowIntentId` string: The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} - `endBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary: A point in a conversation that marks the start or the end of an annotation. - `transcriptIndex` integer: The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `wordIndex` integer: The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `faqAnswer` GoogleCloudContactcenterinsightsV1FaqAnswerData: Agent Assist frequently-asked-question answer data. - `answer` string: The piece of text from the `source` knowledge base document. - `confidenceScore` number, float: 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). - `metadata` object: Map that contains metadata about the FAQ answer and the document that it originates from. - `queryRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `question` string: The corresponding FAQ question. - `source` string: The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - `smartComposeSuggestion` GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: Agent Assist Smart Compose suggestion data. - `confidenceScore` number, double: The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - `metadata` object: Map that contains metadata about the Smart Compose suggestion and the document from which it originates. - `queryRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `suggestion` string: The content of the suggestion. - `smartReply` GoogleCloudContactcenterinsightsV1SmartReplyData: Agent Assist Smart Reply data. - `confidenceScore` number, double: The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - `metadata` object: Map that contains metadata about the Smart Reply and the document from which it originates. - `queryRecord` string: The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `reply` string: The content of the reply. - `startBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary: A point in a conversation that marks the start or the end of an annotation. - `transcriptIndex` integer: The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `wordIndex` integer: The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `userInput` GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: Explicit input used for generating the answer - `generatorName` string: The resource name of associated generator. Format: `projects//locations//generators/` - `query` string: Query text. Article Search uses this to store the input query used to generate the search results. - `querySource` 'QUERY_SOURCE_UNSPECIFIED' | 'AGENT_QUERY' | 'SUGGESTED_QUERY': Query source for the answer. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `startTime` string, google-datetime: The time at which the conversation started. - `transcript` GoogleCloudContactcenterinsightsV1ConversationTranscript: A message representing the transcript of a conversation. - `transcriptSegments` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment[]: A list of sequential transcript segments that comprise the conversation. - `channelTag` integer: 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. - `confidence` number, float: 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. - `dialogflowSegmentMetadata` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: Metadata from Dialogflow relating to the current transcript segment. - `smartReplyAllowlistCovered` boolean: Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist. - `languageCode` string: The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". - `messageTime` string, google-datetime: The time that the message occurred, if provided. - `parts` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart[]: Optional. The structured parts that make up this transcript segment. - `citation` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart: A citation part. - … - `customPayload` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart: A custom payload part. - … - `image` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart: A media part. - … - `link` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart: A link part. - … - `list` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart: A list part. - … - `productCollection` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart: A product collection part. - … - `suggestionChips` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart: A suggestion chips part. - … - `table` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart: A table part. - … - `text` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart: A text part. - … - `thought` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart: A thought part. - … - `video` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart: A media part. - … - `segmentParticipant` GoogleCloudContactcenterinsightsV1ConversationParticipant: The call participant speaking for a given utterance. - `dialogflowParticipant` string: Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - `dialogflowParticipantName` string: The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - `obfuscatedExternalUserId` string: Obfuscated user ID from Dialogflow. - `role` 'ROLE_UNSPECIFIED' | 'HUMAN_AGENT' | 'AUTOMATED_AGENT' | 'END_USER' | 'ANY_AGENT': The role of the participant. - `userId` string: A user-specified ID representing the participant. - `sentiment` GoogleCloudContactcenterinsightsV1SentimentData: The data for a sentiment annotation. - `magnitude` number, float: A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float: The sentiment score between -1.0 (negative) and 1.0 (positive). - `text` string: The text of this segment. - `turnLevelAudio` GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio: A wrapper for holding the audio for any given turn. - `audioDuration` string, google-duration: The duration of the audio. - `audioGcsUri` string: The Cloud Storage URI of the audio for any given turn. - `words` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo[]: A list of the word-specific information for each word in the segment. - `confidence` number, float: 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. - `endOffset` string, google-duration: Time offset of the end of this word relative to the beginning of the total conversation. - `startOffset` string, google-duration: Time offset of the start of this word relative to the beginning of the total conversation. - `word` string: The word itself. Includes punctuation marks that surround the word. - `ttl` string, google-duration: Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. - `turnCount` integer: Output only. The number of turns in the conversation. - `updateTime` string, google-datetime: Output only. The most recent time at which the conversation was updated. - `correlationConfig` GoogleCloudContactcenterinsightsV1CorrelationConfig: A configuration that defines how to correlate conversations for a given a given project. - `createTime` string, google-datetime: Output only. The time at which the correlation config was created. - `fullConversationConfig` GoogleCloudContactcenterinsightsV1CorrelationTypeConfig: A list of correlation rules for a given correlation type. - `correlationRules` GoogleCloudContactcenterinsightsV1CorrelationRule[]: A list of correlation rules to be evaluated for correlation. - `active` boolean: Optional. Whether the config is active to be evaluated. - `constraintExpression` string: Optional. A cel expression (go/cel) to be evaluated as a boolean value. Two variables conversation_a and conversation_b will be available for evaluation. This expression should evaluate to true if conversation_a and conversation_b should be joined. This is used as an extra constraint on top of the join_key_expression to further refine the group of conversations that are joined together and will be evaluated in both directions. for two conversations c1 and c2 and the result will be OR'd. We will evaluate: f(c1, c2) OR f(c2, c1) - `joinKeyExpression` string: Optional. A cel expression (go/cel) to be evaluated as a string value. This string value will be used as the join key for the correlation. - `ruleId` string: Required. The unique identifier of the rule. - `name` string: Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig - `updateTime` string, google-datetime: Output only. The time at which the correlation config was last updated. - `filter` string: Optional. Filter to select conversations to test correlation against. Conversations matching this filter will be sampled based on start time. The most recent `max_sample_count` conversations will be selected. If no conversations match the filter, the request will fail with an `INVALID_ARGUMENT` error. - `maxSampleCount` integer: Optional. The maximum number of conversations to sample when using the `filter`. If not set, defaults to 1000. Values greater than 1000 are coerced to 1000. This field is ignored if `conversations` is provided. ## Response `200` Successful response - GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call. - `done` boolean: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - `error` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `metadata` object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - `name` string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - `response` object: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. --- [API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)