--- title: "POST /v1/{+location}:testCorrelationConfig" method: POST path: "/v1/{+location}:testCorrelationConfig" tags: ["projects"] --- # POST /v1/{+location}:testCorrelationConfig `POST /v1/{+location}:testCorrelationConfig` Tests correlation config on a conversation. ## Path parameters - `location` string, required ## Request body - GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest — The request to test correlation config. - `conversations` GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations — Wrapper for a list of conversations. - `conversations` GoogleCloudContactcenterinsightsV1Conversation[] — Optional. The conversations. - `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} - `callMetadata` GoogleCloudContactcenterinsightsV1ConversationCallMetadata — Call-specific metadata. - `agentChannel` integer — The audio channel that contains the agent. - `customerChannel` integer — The audio channel that contains the customer. - `ttl` string, google-duration — Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. - `name` string — Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} - `dataSource` GoogleCloudContactcenterinsightsV1ConversationDataSource — The conversation source, which is a combination of transcript and audio. - `dialogflowSource` GoogleCloudContactcenterinsightsV1DialogflowSource — A Dialogflow source of conversation data. - `dialogflowConversation` string — Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} - `audioUri` string — Cloud Storage URI that points to a file that contains the conversation audio. - `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. - `audioGcsUri` string — The Cloud Storage URI of the audio for any given turn. - `audioDuration` string, google-duration — The duration of the audio. - `gcsSource` GoogleCloudContactcenterinsightsV1GcsSource — A Cloud Storage source of conversation data. - `audioUri` string — Cloud Storage URI that points to a file that contains the conversation audio. - `transcriptUri` string — Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. - `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. - `segmentParticipant` GoogleCloudContactcenterinsightsV1ConversationParticipant — The call participant speaking for a given utterance. - `obfuscatedExternalUserId` string — Obfuscated user ID from Dialogflow. - `dialogflowParticipantName` string — The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - `dialogflowParticipant` string — Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - `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). - `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. - `turnLevelAudio` GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio — A wrapper for holding the audio for any given turn. - `audioGcsUri` string — The Cloud Storage URI of the audio for any given turn. - `audioDuration` string, google-duration — The duration of the audio. - `messageTime` string, google-datetime — The time that the message occurred, if provided. - `text` string — The text of this segment. - `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". - `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. - `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. - `words` GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo[] — A list of the word-specific information for each word in the segment. - `word` string — The word itself. Includes punctuation marks that surround the word. - `endOffset` string, google-duration — Time offset of the end of this word relative to the beginning of the total conversation. - `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. - `startOffset` string, google-duration — Time offset of the start of this word relative to the beginning of the total conversation. - `updateTime` string, google-datetime — Output only. The most recent time at which the conversation was updated. - `agentId` string — An opaque, user-specified string representing the human agent who handled the conversation. - `correlationInfo` GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo — Info for correlating across conversations. - `mergedFullConversationCorrelationId` string — Output only. The full conversation correlation id this conversation is a merged conversation of. - `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. - `latestSummary` GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData — Conversation summarization suggestion data. - `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. - `metadata` object — A map that contains metadata about the summarization and the document from which it originates. - `confidence` number, float — The confidence score of the summarization. - `answerRecord` string — The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `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. - `createTime` string, google-datetime — Output only. The time at which the conversation was created. - `turnCount` integer — Output only. The number of turns in the conversation. - `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. - `runtimeAnnotations` GoogleCloudContactcenterinsightsV1RuntimeAnnotation[] — Output only. The annotations that were generated during the customer and agent interaction. - `userInput` GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput — Explicit input used for generating the answer - `generatorName` string — The resource name of associated generator. Format: `projects//locations//generators/` - `querySource` 'QUERY_SOURCE_UNSPECIFIED' | 'AGENT_QUERY' | 'SUGGESTED_QUERY' — Query source for the answer. - `query` string — Query text. Article Search uses this to store the input query used to generate the search results. - `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. - `suggestion` string — The content of the suggestion. - `queryRecord` string — The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `endBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary — A point in a conversation that marks the start or the end of an annotation. - `wordIndex` integer — The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `transcriptIndex` integer — The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `conversationSummarizationSuggestion` GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData — Conversation summarization suggestion data. - `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. - `metadata` object — A map that contains metadata about the summarization and the document from which it originates. - `confidence` number, float — The confidence score of the summarization. - `answerRecord` string — The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `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. - `cesTurnAnnotation` GoogleCloudContactcenterinsightsV1CesTurnAnnotation — The CES diagnostic information. - `rootSpan` GoogleCloudCesV1mainSpan — A span is a unit of work or a single operation during the request processing. - `startTime` string, google-datetime — Output only. The start time of the span. - `childSpans` GoogleCloudCesV1mainSpan[] — Output only. The child spans that are nested under this span. - `name` string — Output only. The name of the span. - `endTime` string, google-datetime — Output only. The end time of the span. - `duration` string, google-duration — Output only. The duration of the span. - `attributes` object — Output only. Key-value attributes associated with the span. - `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. - `createTime` string, google-datetime — The time at which this annotation was created. - `answerFeedback` GoogleCloudContactcenterinsightsV1AnswerFeedback — The feedback that the customer has about a certain answer in the conversation. - `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. - `clicked` boolean — Indicates whether an answer or item was clicked by the human agent. - `startBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary — A point in a conversation that marks the start or the end of an annotation. - `wordIndex` integer — The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `transcriptIndex` integer — The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `articleSuggestion` GoogleCloudContactcenterinsightsV1ArticleSuggestionData — Agent Assist Article Suggestion data. - `title` string — Article title. - `source` string — The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - `uri` string — Article URI. - `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} - `faqAnswer` GoogleCloudContactcenterinsightsV1FaqAnswerData — Agent Assist frequently-asked-question answer data. - `question` string — The corresponding FAQ question. - `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). - `answer` string — The piece of text from the `source` knowledge base document. - `source` string — The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - `queryRecord` string — The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `metadata` object — Map that contains metadata about the FAQ answer and the document that it originates from. - `smartReply` GoogleCloudContactcenterinsightsV1SmartReplyData — Agent Assist Smart Reply data. - `queryRecord` string — The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - `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. - `reply` string — The content of the reply. - `dialogflowInteraction` GoogleCloudContactcenterinsightsV1DialogflowInteractionData — Dialogflow interaction data. - `dialogflowIntentId` string — The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent} - `confidence` number, float — The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - `annotationId` string — The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - `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. - `latestAnalysis` GoogleCloudContactcenterinsightsV1Analysis — The analysis resource. - `analysisResult` GoogleCloudContactcenterinsightsV1AnalysisResult — The result of an analysis. - `endTime` string, google-datetime — The time at which the analysis ended. - `callAnalysisMetadata` GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata — Call-specific metadata created during analysis. - `annotations` GoogleCloudContactcenterinsightsV1CallAnnotation[] — A list of call annotations that apply to this call. - … - `sentiments` GoogleCloudContactcenterinsightsV1ConversationLevelSentiment[] — Overall conversation-level sentiment for each channel of the call. - … - `silence` GoogleCloudContactcenterinsightsV1ConversationLevelSilence — Conversation-level silence data. - … - `intents` object — All the matched intents in the call. - `issueModelResult` GoogleCloudContactcenterinsightsV1IssueModelResult — Issue Modeling result on a conversation. - … - `entities` object — All the entities in the call. - `phraseMatchers` object — All the matched phrase matchers in the call. - `qaScorecardResults` GoogleCloudContactcenterinsightsV1QaScorecardResult[] — Results of scoring QaScorecards. - … - `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. - `createTime` string, google-datetime — Output only. The time at which the analysis was created, which occurs when the long-running operation completes. - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector — Selector of all available annotators and phrase matchers to run. - `runEntityAnnotator` boolean — Whether to run the entity annotator. - `runPhraseMatcherAnnotator` boolean — Whether to run the active phrase matcher annotator(s). - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig — Configuration for the QA feature. - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList — Container for a list of scorecards. - … - `runIntentAnnotator` boolean — Whether to run the intent annotator. - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig — Configuration for summarization. - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0' — Default summarization model to be used. - `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/ - `runSilenceAnnotator` boolean — Whether to run the silence annotator. - `runIssueModelAnnotator` boolean — Whether to run the issue model annotator. A model should have already been deployed for this to take effect. - `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. - `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. - `runQaAnnotator` boolean — Whether to run the QA annotator. - `runSentimentAnnotator` boolean — Whether to run the sentiment annotator. - `runSummarizationAnnotator` boolean — Whether to run the summarization annotator. - `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} - `runInterruptionAnnotator` boolean — Whether to run the interruption annotator. - `medium` 'MEDIUM_UNSPECIFIED' | 'PHONE_CALL' | 'CHAT' — Immutable. The conversation medium. - `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. - `qualityMetadata` GoogleCloudContactcenterinsightsV1ConversationQualityMetadata — Conversation metadata related to quality management. - `customerSatisfactionRating` integer — An arbitrary integer value indicating the customer's satisfaction rating. - `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. - `feedbackLabels` GoogleCloudContactcenterinsightsV1FeedbackLabel[] — Input only. The feedback labels associated with the conversation. - `qaAnswerLabel` GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue — Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. - `key` string — A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key. - `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. - `naValue` boolean — A value of "Not Applicable (N/A)". Should only ever be `true`. - `strValue` string — String value. - `potentialScore` number, double — Output only. The maximum potential score of the question. - `normalizedScore` number, double — Output only. Normalized score of the questions. Calculated as score / potential_score. - `score` number, double — Output only. Numerical score of the answer. - `numValue` number, double — Numerical value. - `boolValue` boolean — Boolean value. - `updateTime` string, google-datetime — Output only. Update time of the label. - `name` string — Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} - `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}` - `agentInfo` GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo[] — Information about agents involved in the call. - `teams` string[] — User-specified strings representing the agent's teams. - `deploymentDisplayName` string — The agent's deployment display name. Only applicable to automated agents. - `displayName` string — The agent's name. - `versionId` string — The agent's version ID. Only applicable to automated agents. - `versionDisplayName` string — The agent's version display name. Only applicable to automated agents. - `entrySubagentDisplayName` string — The entry subagent's display name. - `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. - `entrySubagentId` string — The entry subagent's ID. - `deploymentId` string — The agent's deployment ID. Only applicable to automated agents. - `dispositionCode` string — A user-provided string indicating the outcome of the agent's segment of the call. - `location` string — The agent's location. - `team` string — A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. - `obfuscatedUserId` string — Obfuscated user ID which the customer sent to us. - `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. - `correlationConfig` GoogleCloudContactcenterinsightsV1CorrelationConfig — A configuration that defines how to correlate conversations for a given a given project. - `updateTime` string, google-datetime — Output only. The time at which the correlation config was last updated. - `name` string — Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig - `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. - `ruleId` string — Required. The unique identifier of the rule. - `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. - `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 --- [API](https://skmtc.net/google/apis/contactcenterinsights.md) · [All operations](https://skmtc.net/google/apis/contactcenterinsights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/contactcenterinsights/versions/e071ddf4dfc3/schema)