{ "rootUrl": "https://contactcenterinsights.googleapis.com/", "batchPath": "batch", "fullyEncodeReservedExpansion": true, "description": "", "schemas": { "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "properties": { "payload": { "description": "Optional. Arbitrary structured payload.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "payloadType": { "description": "Optional. Type identifier for the payload.", "type": "string" } }, "description": "A custom payload part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "description": "The original request for undeployment." } }, "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "type": "object", "properties": { "silencePercentage": { "format": "float", "description": "Percentage of the total conversation spent in silence.", "type": "number" }, "silenceDuration": { "type": "string", "description": "Amount of time calculated to be in silence.", "format": "google-duration" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "properties": { "labelKey": { "type": "string", "description": "Optional. The label key." }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata", "type": "object", "description": "Metadata for testing correlation config.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "The statistics for the operation." } } }, "GoogleCloudContactcenterinsightsV1alpha1AssistantSession": { "properties": { "name": { "description": "Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}", "type": "string" }, "updateTime": { "description": "Output only. The time the session was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the session was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "state": { "enumDescriptions": [ "Unspecified state.", "Agent is working.", "Waiting for user input." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "IDLE" ], "type": "string", "description": "Output only. The status of the session." }, "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage" }, "type": "array", "description": "Optional. History of messages in the session." }, "requester": { "type": "string", "readOnly": true, "description": "Output only. The user who initiated the session." }, "displayName": { "description": "Optional. The display name of the session.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession", "type": "object", "description": "Represents a conversation session with the Assistant Agent." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "type": "string", "description": "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "type": "object", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." } }, "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "channelTag": { "format": "int32", "description": "The channel of the audio that the data applies to.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "type": "object", "description": "Metadata from Dialogflow relating to the current transcript segment.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "properties": { "playbookId": { "type": "string", "description": "Optional. The dialogflow playbook ID." }, "playbookDisplayName": { "type": "string", "description": "Optional. The dialogflow playbook display name." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse", "properties": {}, "type": "object", "description": "The response for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "properties": { "nextPageToken": { "description": "The next page token.", "type": "string" }, "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse", "type": "object", "description": "Response to list assistant sessions.", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.", "type": "string" }, "assistantSessions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "description": "The assistant sessions.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainDimension": { "id": "GoogleCloudContactcenterinsightsV1mainDimension", "properties": { "issueDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" }, "labelDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension." }, "conversationalAgentsToolDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension.", "readOnly": true }, "qaScorecardDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "readOnly": true }, "agentDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, "qaQuestionAnswerDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata" }, "dimensionKey": { "description": "The key of the dimension.", "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "type": "string", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ] }, "conversationProfileDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "description": "Output only. Metadata about the conversation profile dimension." }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" } }, "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "type": "object", "properties": { "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "dialogflowParticipantName": { "type": "string", "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "role": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "description": "The role of the participant." }, "userId": { "type": "string", "description": "A user-specified ID representing the participant." } }, "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1mainIntent": { "id": "GoogleCloudContactcenterinsightsV1mainIntent", "properties": { "displayName": { "type": "string", "description": "The human-readable name of the intent." }, "id": { "type": "string", "description": "The unique identifier of the intent." } }, "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "type": "object", "description": "Configs for the input data used to create the issue model.", "properties": { "medium": { "type": "string", "deprecated": true, "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "description": "Output only. Number of conversations used in training. Output only.", "format": "int64", "readOnly": true, "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "description": "A message representing the transcript of a conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "annotatorSelector": { "readOnly": true, "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." } }, "type": "object", "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup": { "description": "A message representing a rule in the phrase matcher.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup", "properties": { "phraseMatchRules": { "description": "A list of phrase match rules that are included in this group.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" }, "type": "array" }, "type": { "type": "string", "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rules or there is no match.", "If any of the phrase match rules are met, there is a match." ], "description": "Required. The type of this phrase match rule group.", "enum": [ "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse", "description": "The response to an SampleConversations operation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "properties": { "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "properties": { "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "properties": { "errorMessages": { "items": { "$ref": "GoogleRpcStatus" }, "description": "The error message when the generative insights request fails.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "type": "object", "properties": { "entities": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" }, "description": "All the entities in the call." }, "silence": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "sentiments": { "type": "array", "description": "Overall conversation-level sentiment for each channel of the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" } }, "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "description": "A list of call annotations that apply to this call.", "type": "array" }, "phraseMatchers": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "description": "All the matched phrase matchers in the call." }, "intents": { "type": "object", "description": "All the matched intents in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" } }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "qaScorecardResults": { "type": "array", "description": "Results of scoring QaScorecards.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" } } }, "description": "Call-specific metadata created during analysis.", "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "properties": { "payload": { "type": "object", "description": "Optional. Arbitrary structured payload.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "payloadType": { "type": "string", "description": "Optional. Type identifier for the payload." } }, "description": "A custom payload part." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "properties": {}, "description": "The response to an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the label.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Update time of the label.", "readOnly": true, "format": "google-datetime" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "label": { "type": "string", "description": "String label used for Topic Modeling." }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Whether this resource is zone isolated.", "type": "boolean" }, "labeledResource": { "description": "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}`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "type": "object", "properties": { "smartReplyAllowlistCovered": { "type": "boolean", "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "Metadata from Dialogflow relating to the current transcript segment." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "answerValue": { "type": "string", "description": "Optional. The full body of the question." }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } }, "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "type": "object", "properties": { "qaScorecardRevisions": { "type": "array", "description": "List of QaScorecardRevisions.", "items": { "type": "string" } } }, "description": "Container for a list of scorecards." }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "description": "Agent Assist Smart Compose suggestion data.", "properties": { "suggestion": { "type": "string", "description": "The content of the suggestion." }, "confidenceScore": { "description": "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).", "format": "double", "type": "number" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "description": "A suggestion chips part.", "properties": { "chips": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "type": "array", "description": "Optional. List of suggestion chips." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo", "type": "object", "properties": { "dispositionCode": { "type": "string", "description": "A user-provided string indicating the outcome of the agent's segment of the call." }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "deploymentDisplayName": { "type": "string", "description": "The agent's deployment display name. Only applicable to automated agents." }, "team": { "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "type": "string" }, "deploymentId": { "type": "string", "description": "The agent's deployment ID. Only applicable to automated agents." }, "agentType": { "type": "string", "description": "The agent type, e.g. HUMAN_AGENT.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "location": { "type": "string", "description": "The agent's location." }, "teams": { "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" }, "type": "array" }, "displayName": { "type": "string", "description": "The agent's name." }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" } }, "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "properties": { "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "description": "The source of the audio and transcription for the conversation." }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "duration": { "description": "Output only. The duration of the conversation.", "type": "string", "readOnly": true, "format": "google-duration" }, "callMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "description": "Call-specific metadata." }, "runtimeAnnotations": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction." }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "correlationInfo": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "description": "Output only. Info for correlating across conversations." }, "languageCode": { "type": "string", "description": "A user-specified language code for the conversation." }, "labels": { "type": "object", "description": "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.", "additionalProperties": { "type": "string" } }, "metadataJson": { "type": "string", "description": "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." }, "medium": { "description": "Immutable. The conversation medium.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "type": "string" }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Whether this resource is zone isolated.", "readOnly": true }, "transcript": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "description": "Output only. The conversation transcript." }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "turnCount": { "readOnly": true, "type": "integer", "description": "Output only. The number of turns in the conversation.", "format": "int32" }, "dialogflowIntents": { "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "type": "object" }, "ttl": { "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated." }, "expireTime": { "type": "string", "format": "google-datetime", "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted." }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone separated." }, "createTime": { "description": "Output only. The time at which the conversation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "The conversation resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "properties": { "totalFilesWritten": { "format": "int32", "type": "integer", "description": "Total number of files written to the provided Cloud Storage bucket." }, "fileNames": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Full name of the files written to Cloud storage." }, "processedObjectCount": { "description": "The number of objects processed during the download operation.", "format": "int32", "type": "integer" }, "successfulDownloadCount": { "type": "integer", "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", "format": "int32" } }, "description": "Statistics for BulkDownloadFeedbackLabels operation." }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "properties": { "issue": { "type": "string", "description": "Resource name of the assigned issue." }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "score": { "type": "number", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "format": "double" } }, "type": "object", "description": "Information about the issue.", "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData", "properties": {}, "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource", "properties": { "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" }, "score": { "type": "number", "description": "The overall numerical score of the result.", "format": "double" }, "sourceType": { "description": "What created the score.", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ] }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" } }, "potentialScore": { "format": "double", "type": "number", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." } }, "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores." }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "properties": { "confidenceScore": { "format": "double", "type": "number", "description": "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)." }, "reply": { "description": "The content of the reply.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "description": "Agent Assist Smart Reply data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse": { "type": "object", "properties": { "assessmentRules": { "description": "The assessment rules that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "The response of listing assessment rules.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "properties": { "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "type": "object", "description": "The request to undeploy an issue model.", "properties": { "name": { "type": "string", "description": "Required. The issue model to undeploy." } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "properties": { "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call.", "type": "array" }, "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer", "format": "int32" }, "waitDuration": { "format": "google-duration", "type": "string", "description": "The amount of time the customer waited to connect with an agent." }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "description": "Request to upload a conversation.", "type": "object", "properties": { "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings." }, "conversationId": { "type": "string", "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation." }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings." } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "readOnly": true, "description": "Output only. The original request for ingest." }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "sampledConversations": { "type": "array", "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true, "items": { "type": "string" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "type": "object", "description": "The request to sample conversations to a dataset.", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "parent": { "type": "string", "description": "Required. The parent resource of the dataset." } } }, "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse": { "description": "The response of listing views.", "properties": { "views": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "The views that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "type": "object", "properties": { "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" }, "textType": { "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "description": "The type of text output.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output." }, "GoogleCloudCesV1mainToolsetTool": { "type": "object", "properties": { "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" }, "toolset": { "type": "string", "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`" } }, "description": "A tool that is created from a toolset.", "id": "GoogleCloudCesV1mainToolsetTool" }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "type": "object", "description": "A wrapper for holding the audio for any given turn.", "properties": { "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" }, "audioGcsUri": { "type": "string", "description": "The Cloud Storage URI of the audio for any given turn." } } }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "properties": { "agentDeploymentDisplayName": { "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDeploymentId": { "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentVersionDisplayName": { "type": "string", "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDisplayName": { "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { "type": "string", "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." } }, "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "type": "object", "description": "Metadata used for export issue model.", "properties": { "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "readOnly": true, "description": "Output only. The original request for initialization." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." } }, "description": "Metadata for initializing a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModel", "type": "object", "properties": { "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "trainingStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "description": "Output only. Immutable. The issue model's label statistics on its training data." }, "state": { "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "type": "string", "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string", "readOnly": true }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "format": "int64", "type": "string", "readOnly": true }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "modelType": { "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "description": "Type of the model.", "type": "string" }, "inputDataConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "description": "Configs for the input data that used to create the issue model." }, "languageCode": { "description": "Language of the model.", "type": "string" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" } }, "description": "The issue model resource." }, "GoogleCloudContactcenterinsightsV1alpha1Chart": { "properties": { "displayName": { "description": "User provided display name of the chart.", "type": "string" }, "chartVisualizationType": { "enum": [ "CHART_VISUALIZATION_TYPE_UNSPECIFIED", "BAR", "LINE", "AREA", "PIE", "SCATTER", "TABLE", "SCORE_CARD", "SUNBURST", "GAUGE", "SANKEY" ], "type": "string", "description": "Chart visualization type.", "enumDescriptions": [ "Unspecified chart visualization type.", "Bar chart.", "Line chart.", "Area chart.", "Pie chart.", "Scatter chart.", "Table chart.", "Score card chart.", "Sunburst chart.", "Gauge chart.", "Sankey chart." ] }, "dateRangeConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range config applied to the chart." }, "createTime": { "format": "google-datetime", "description": "Output only. Chart create time.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Chart last update time.", "type": "string" }, "chartType": { "type": "string", "enum": [ "CHART_TYPE_UNSPECIFIED", "SYSTEM_DEFINED", "USER_DEFINED" ], "enumDescriptions": [ "Unspecified chart type.", "Pre-defined chart type.", "Configurable chart type." ], "description": "Output only. Chart type.", "readOnly": true }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "action": { "description": "Optional action to be taken when the chart is clicked.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartAction" }, "description": { "description": "Chart description", "type": "string" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource" }, "width": { "description": "The width of the chart in grid units.", "format": "int32", "type": "integer" }, "height": { "format": "int32", "description": "The height of the chart in grid units.", "type": "integer" }, "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" } }, "description": "Configurable dashboard's widget that displays data as a chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1Chart", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "properties": { "type": { "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "description": "The type of the text message.", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] }, "texts": { "description": "The parts of the message.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "A text output message from the system." }, "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse": { "description": "Response of querying an issue model's statistics.", "type": "object", "properties": { "currentStats": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "description": "The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "properties": { "name": { "type": "string", "description": "Required. The issue model to deploy." } }, "description": "The request to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { "type": "object", "properties": { "timeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" }, "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimension" } } }, "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The original request for deletion." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", "description": "Configuration for the QA feature." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "properties": { "templateQaScorecardId": { "items": { "type": "string" }, "type": "array", "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored." }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "maxDownloadCount": { "type": "integer", "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded." }, "filter": { "description": "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", "type": "string" }, "sheetsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "A sheets document destination." }, "feedbackLabelType": { "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "type": "string" }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "description": "Metadata about the Conversational Agents tool dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "type": "string", "description": "Optional. The dialogflow tool display name." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "type": "array", "description": "The feedback labels that match the request." } }, "description": "The response for listing all feedback labels.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "properties": { "conversation": { "type": "string", "description": "The conversation resource name that had an error during correlation." }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "type": "object", "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse": { "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "qaScorecards": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "The QaScorecards under the parent.", "type": "array" } }, "description": "The response from a ListQaScorecards request.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse", "description": "The response for generative insights.", "properties": { "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" }, "generativeResponses": { "type": "array", "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "properties": { "products": { "description": "Optional. List of products.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "type": "array" } }, "description": "A product collection part.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest", "properties": { "maxSampleCount": { "description": "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.", "format": "int32", "type": "integer" }, "filter": { "description": "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.", "type": "string" }, "correlationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig", "description": "Required. The correlation config to test." }, "conversations": { "description": "Optional. A list of conversations to test against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" } }, "description": "The request to test correlation config." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct", "type": "object", "description": "A product in a product collection.", "properties": { "price": { "$ref": "GoogleTypeMoney", "description": "Optional. Product price." }, "imageUris": { "items": { "type": "string" }, "description": "Optional. Product image URLs.", "type": "array" }, "uri": { "type": "string", "description": "Optional. Product URL or deep link." }, "description": { "type": "string", "description": "Optional. Product description." }, "id": { "type": "string", "description": "Optional. Product ID." }, "displayName": { "type": "string", "description": "Optional. Product display name." } } }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "properties": { "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversation" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" } }, "type": "object", "description": "Request to upload a conversation.", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "properties": {}, "description": "The response to undeploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output.", "properties": { "text": { "type": "array", "items": { "type": "string" }, "description": "The text output from the LLM." }, "textType": { "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "type": "string", "description": "The type of text output." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "type": "object", "properties": { "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "format": "double", "type": "number" }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "format": "double", "type": "number" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "conversationAiCoachSuggestionCount": { "type": "integer", "description": "Count of conversations that has Ai Coach Suggestions.", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "format": "int32", "type": "integer" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "format": "double", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "format": "double" }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "type": "number", "format": "double" }, "knowledgeSearchSuggestedQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "format": "int32", "type": "integer" }, "dialogflowWebhookFailureRatio": { "type": "number", "description": "Proportion of dialogflow webhook calls that failed.", "format": "double" }, "aiCoachSuggestionMessageTriggerRatio": { "type": "number", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "double" }, "averageDuration": { "description": "The average duration.", "format": "google-duration", "type": "string" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "conversationAiCoachSuggestionRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions." }, "dialogflowAverageWebhookLatency": { "type": "number", "format": "double", "description": "Average latency of dialogflow webhook calls." }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "format": "int32", "type": "integer" }, "averageQaNormalizedScore": { "format": "double", "type": "number", "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "knowledgeSearchResultCount": { "format": "int32", "type": "integer", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user." }, "averageQaQuestionNormalizedScore": { "format": "double", "type": "number", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID." }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "format": "double", "type": "number" }, "qaTagScores": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array", "description": "Average QA normalized score for all the tags." }, "knowledgeSearchAgentQuerySourceRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "knowledgeSearchUriClickRatio": { "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "format": "double" }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "format": "int32", "type": "integer" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "dialogflowInteractionsNoMatchRatio": { "format": "double", "type": "number", "description": "Proportion of dialogflow interactions that has no intent match for the input." }, "conversationalAgentsAverageEndToEndLatency": { "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "format": "double", "type": "number" }, "averageSilencePercentage": { "type": "number", "description": "The average silence percentage.", "format": "float" }, "summarizationSuggestionEditRatio": { "type": "number", "format": "double", "description": "Proportion of summarization suggestions that were manually edited." }, "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "averageClientSentimentScore": { "format": "float", "type": "number", "description": "The average client's sentiment score." }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "description": "The number of conversations transferred to a human agent.", "type": "integer" }, "averageSummarizationSuggestionNormalizedEditDistance": { "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "type": "integer", "description": "Count of customer messages that triggered an Ai Coach Suggestion." }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "dialogflowConversationsEscalationRatio": { "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "conversationTotalAgentMessageCount": { "type": "integer", "format": "int32", "description": "The agent message count." }, "conversationTotalCustomerMessageCount": { "type": "integer", "format": "int32", "description": "The customer message count." }, "averageSummarizationSuggestionEditDistance": { "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "format": "double", "type": "number" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "format": "double", "type": "number" }, "knowledgeAssistNegativeFeedbackRatio": { "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "format": "double" }, "conversationCount": { "type": "integer", "format": "int32", "description": "The conversation count." }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "type": "integer", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "aaSupervisorMonitoredConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations scanned by the AA human supervisor." }, "avgConversationClientTurnSentimentEma": { "type": "number", "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "format": "double" }, "averageAgentSentimentScore": { "format": "float", "type": "number", "description": "The average agent's sentiment score." }, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, "aiCoachSuggestionAgentUsageRatio": { "type": "number", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "format": "double" } }, "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" }, "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk": { "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk", "properties": { "text": { "description": "Optional. Text data.", "type": "string" } }, "description": "A chunk of data in an assistant message.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", "properties": {}, "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse", "type": "object", "description": "The response for a bulk analyze conversations operation.", "properties": { "successfulAnalysisCount": { "type": "integer", "description": "Count of successful analyses.", "format": "int32" }, "failedAnalysisCount": { "type": "integer", "description": "Count of failed analyses.", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "runSummarizationAnnotator": { "type": "boolean", "description": "Whether to run the summarization annotator." }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runIntentAnnotator": { "type": "boolean", "description": "Whether to run the intent annotator." }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" }, "runSentimentAnnotator": { "type": "boolean", "description": "Whether to run the sentiment annotator." }, "issueModels": { "items": { "type": "string" }, "description": "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.", "type": "array" }, "runInterruptionAnnotator": { "type": "boolean", "description": "Whether to run the interruption annotator." }, "runIssueModelAnnotator": { "type": "boolean", "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect." }, "phraseMatchers": { "type": "array", "description": "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}", "items": { "type": "string" } }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" }, "runAutoLabelingAnnotator": { "description": "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.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined.", "properties": { "type": { "type": "string", "description": "The type of the predefined question.", "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE", "CONVERSATION_OUTCOME_AI_AVERSION" ], "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent.", "Classifies whether the customer demonstrates AI aversion by instantly requesting escalation to a human agent without attempting to work with the AI agent." ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "description": "A link part.", "properties": { "text": { "type": "string", "description": "Optional. Anchor or display text." }, "uri": { "type": "string", "description": "Optional. Target URI." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "type": "object", "description": "A citation part.", "properties": { "snippet": { "description": "Optional. Snippet of the cited text.", "type": "string" }, "sourceUri": { "description": "Optional. The cited source URI.", "type": "string" }, "sourceTitle": { "type": "string", "description": "Optional. The cited source title." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "type": "object", "properties": { "text": { "type": "string", "description": "Optional. The text content." } }, "description": "A text part." }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "A Dialogflow source of conversation data.", "properties": { "dialogflowConversation": { "readOnly": true, "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "items": { "type": "string" }, "description": "List of QaScorecardRevisions.", "type": "array" } }, "description": "Container for a list of scorecards." }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule": { "properties": { "updateTime": { "description": "Output only. The most recent time at which this analysis rule was updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", "type": "boolean" }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Whether this resource is zone isolated.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, "displayName": { "description": "Display Name of the analysis rule.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this analysis rule was created." }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run." }, "analysisPercentage": { "format": "double", "type": "number", "description": "Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation." }, "conversationFilter": { "type": "string", "description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule", "description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { "properties": { "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" } }, "timeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]" }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "description": "An answer to a QaQuestion.", "properties": { "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "items": { "type": "string" }, "type": "array" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" } }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "type": "object", "description": "Configuration that applies to all conversations.", "properties": { "agentId": { "type": "string", "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`." }, "customerChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer", "format": "int32" }, "agentChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "type": "object", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "description": "The metadata from querying metrics.", "properties": { "resultIsTruncated": { "type": "boolean", "description": "Whether the result rows were truncated because the result row size is too large to materialize." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." } }, "description": "The response of testing correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } } }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "properties": { "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "constraintMet": { "type": "boolean", "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A)." }, "ruleId": { "description": "The rule ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult", "type": "object", "description": "The result of a single constraint rule on the pair of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1View": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1View", "description": "The View resource.", "properties": { "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time at which this view was created." }, "name": { "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "type": "string" }, "displayName": { "type": "string", "description": "The human-readable display name of the view." }, "value": { "type": "string", "description": "A filter to reduce conversation results to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details." }, "updateTime": { "description": "Output only. The most recent time at which the view was updated.", "format": "google-datetime", "readOnly": true, "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "properties": { "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "format": "int32", "type": "integer" }, "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "The data for an issue match annotation.", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "properties": { "text": { "description": "Optional. The text of the list item.", "type": "string" }, "subItems": { "description": "Optional. Nested sub-items.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem", "description": "An item in a list.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse": { "type": "object", "description": "The response message for listing auto labeling rules.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "autoLabelingRules": { "description": "The auto labeling rules.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecard": { "properties": { "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the scorecard was updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "The user-specified display name of the scorecard." }, "isDefault": { "type": "boolean", "description": "Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "createTime": { "description": "Output only. The time at which this scorecard was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "description": { "type": "string", "description": "A text description explaining the intent of the scorecard." }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "source": { "type": "string", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment.", "The scorecard is derived from the custom intent taxonomy. Customers can edit question content, but cannot delete the scorecard or add/remove questions." ], "description": "Output only. The source of the scorecard.", "readOnly": true, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard", "description": "A QaScorecard represents a collection of questions to be scored during analysis." }, "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { "type": "object", "description": "The feedback that the customer has about a certain answer in the conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "properties": { "clicked": { "type": "boolean", "description": "Indicates whether an answer or item was clicked by the human agent." }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "correctnessLevel": { "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer." } } }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation.", "properties": { "successfulAnalysisCount": { "format": "int32", "type": "integer", "description": "Count of successful analyses." }, "failedAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of failed analyses." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "properties": { "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage URI to export the issue model to." }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "description": "Request to export an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata", "type": "object", "description": "The metadata for deleting a QaQuestionTag Resource.", "properties": { "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "id": "GoogleCloudContactcenterinsightsV1RedactionConfig", "properties": { "deidentifyTemplate": { "type": "string", "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`" }, "inspectTemplate": { "type": "string", "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "type": "string", "format": "google-duration", "description": "The duration of the audio." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult", "properties": { "conversationA": { "type": "string", "description": "The first conversation resource name." }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse", "description": "The response to list analyses.", "properties": { "analyses": { "description": "The analyses that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition", "description": "A definition for a metric to be calculated during analysis.", "properties": { "displayName": { "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "readOnly": true, "type": "string" }, "sourceId": { "type": "string", "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "type": "object", "properties": { "payloadType": { "type": "string", "description": "Optional. Type identifier for the payload." }, "payload": { "description": "Optional. Arbitrary structured payload.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "description": "A custom payload part." }, "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { "description": "The response for listing all feedback labels.", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "type": "object", "properties": { "interval": { "$ref": "GoogleTypeInterval", "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" }, "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval." }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "type": "array", "description": "A message from the system in response to the user." } }, "description": "A wrapper for system messages per turn.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "GoogleCloudCesV1mainSpan": { "description": "A span is a unit of work or a single operation during the request processing.", "properties": { "attributes": { "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. Key-value attributes associated with the span." }, "startTime": { "description": "Output only. The start time of the span.", "type": "string", "readOnly": true, "format": "google-datetime" }, "duration": { "type": "string", "description": "Output only. The duration of the span.", "readOnly": true, "format": "google-duration" }, "endTime": { "format": "google-datetime", "description": "Output only. The end time of the span.", "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true, "description": "Output only. The name of the span." }, "childSpans": { "readOnly": true, "description": "Output only. The child spans that are nested under this span.", "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "type": "array" } }, "type": "object", "id": "GoogleCloudCesV1mainSpan" }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet": { "properties": { "createTime": { "description": "Output only. Create time.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "displayName": { "type": "string", "description": "Display Name. Limit 64 characters." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. Update time.", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "properties": { "boolValue": { "description": "Boolean value.", "type": "boolean" }, "potentialScore": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. The maximum potential score of the question." }, "key": { "type": "string", "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key." }, "skipValue": { "type": "boolean", "readOnly": true, "description": "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." }, "score": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. Numerical score of the answer." }, "normalizedScore": { "readOnly": true, "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "strValue": { "type": "string", "description": "String value." }, "numValue": { "format": "double", "type": "number", "description": "Numerical value." } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "type": "object", "properties": { "agentId": { "type": "string", "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`." }, "customerChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "agentChannel": { "type": "integer", "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The request to delete an issue model.", "properties": { "name": { "type": "string", "description": "Required. The name of the issue model to delete." } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "type": "object", "description": "The metadata for an IngestConversations operation.", "properties": { "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "sampledConversations": { "items": { "type": "string" }, "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array" }, "partialErrors": { "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true, "type": "array" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "description": "Output only. The original request for ingest.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "type": "string", "description": "Optional. The dialogflow playbook display name." } }, "description": "Metadata about the Conversational Agents playbook dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval": { "type": "object", "properties": { "startTime": { "format": "google-datetime", "description": "The start time of this interval.", "type": "string" }, "conversationCount": { "format": "int32", "description": "The number of conversations created in this interval.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval", "description": "A single interval in a time series." }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse", "type": "object", "properties": { "analysisRules": { "description": "The analysis_rule that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "The response of listing views." }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec" } }, "type": "object", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "description": "Response for an export insights operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "properties": { "issueStats": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name." }, "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "format": "int64", "type": "string" }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "type": "object", "description": "One channel of conversation-level sentiment data.", "properties": { "channelTag": { "type": "integer", "description": "The channel of the audio that the data applies to.", "format": "int32" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule": { "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the rule was updated.", "readOnly": true, "type": "string" }, "active": { "description": "Whether the rule is active.", "type": "boolean" }, "labelKey": { "description": "The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which this rule was created." }, "name": { "type": "string", "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}" }, "displayName": { "type": "string", "description": "The user-provided display name of the rule." }, "labelKeyType": { "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "description": "The type of the label key.", "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ], "type": "string" }, "conditions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition" }, "type": "array", "description": "Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used." }, "description": { "description": "The description of the rule.", "type": "string" } }, "type": "object", "description": "Rule for auto-labeling conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "type": "object", "description": "Statistics for IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "properties": { "processedObjectCount": { "format": "int32", "type": "integer", "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true }, "duplicatesSkippedCount": { "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer", "readOnly": true, "format": "int32" }, "successfulIngestCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of new conversations added during this ingest operation." }, "failedIngestCount": { "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "format": "int32", "type": "integer", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "properties": { "normalizedScore": { "format": "double", "description": "The normalized score, which is the score divided by the potential score.", "type": "number" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "sourceType": { "description": "What created the score.", "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ] }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result." }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } } }, "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "properties": { "labeledConversationsCount": { "format": "int64", "description": "Number of conversations attached to the issue at this point in time.", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "issue": { "type": "string", "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", "type": "object" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "type": "object", "description": "The response to initialize a location-level encryption specification.", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "type": "object", "properties": { "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "readOnly": true }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Whether this resource is zone separated." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes." }, "requestTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was requested." }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "description": "The analysis resource." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata", "properties": { "errorMessages": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "The error message when the generative insights request fails." } }, "description": "The metadata for generative insights.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "properties": { "analysisPercentage": { "type": "number", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "format": "float" }, "relabel": { "deprecated": true, "type": "boolean", "description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations." }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "type": "object", "description": "The request to analyze conversations in bulk." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics": { "properties": { "request": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "type": "object", "description": "Request data that use the existing QueryMetrics.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics" }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "properties": {}, "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } }, "description": "Configuration for the QA feature.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest": { "description": "The request for querying metrics.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest", "properties": { "timeGranularity": { "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "enum": [ "TIME_GRANULARITY_UNSPECIFIED", "NONE", "DAILY", "HOURLY", "PER_MINUTE", "PER_5_MINUTES", "MONTHLY" ], "type": "string", "enumDescriptions": [ "The time granularity is unspecified and will default to NONE.", "No time granularity. The response won't contain a time series. This is the default value if no time granularity is specified.", "Data points in the time series will aggregate at a daily granularity. 1 day means [midnight to midnight).", "Data points in the time series will aggregate at a daily granularity. 1 HOUR means [01:00 to 02:00).", "Data points in the time series will aggregate at a daily granularity. PER_MINUTE means [01:00 to 01:01).", "Data points in the time series will aggregate at a 1 minute granularity. PER_5_MINUTES means [01:00 to 01:05).", "Data points in the time series will aggregate at a monthly granularity. 1 MONTH means [01st of the month to 1st of the next month)." ] }, "dimensions": { "description": "The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "type": "array" }, "filter": { "description": "Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). ", "type": "string" }, "measureMask": { "type": "string", "format": "google-fieldmask", "description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\"." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Container": { "description": "Configurable dashboard's container. Container can contain multiple widgets.", "id": "GoogleCloudContactcenterinsightsV1alpha1Container", "properties": { "height": { "description": "The height of the container in grid units.", "format": "int32", "type": "integer" }, "displayName": { "description": "User provided display name of the Container.", "type": "string" }, "width": { "description": "The width of the container in grid units.", "format": "int32", "type": "integer" }, "description": { "description": "Container description", "type": "string" }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "dateRangeConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range config applied to all charts in the container." }, "containerId": { "readOnly": true, "type": "string", "description": "Output only. Unique ID for the container." }, "widgets": { "type": "array", "description": "Widgets in the Container.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Widget" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "type": "object", "properties": { "correlationTypes": { "type": "array", "readOnly": true, "description": "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.", "items": { "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "type": "string", "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] } }, "fullConversationCorrelationId": { "readOnly": true, "type": "string", "description": "Output only. The full conversation correlation id this conversation is a segment of." }, "mergedFullConversationCorrelationId": { "readOnly": true, "type": "string", "description": "Output only. The full conversation correlation id this conversation is a merged conversation of." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "description": "Info for correlating across conversations." }, "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage": { "description": "A message in an assistant session.", "properties": { "eventTime": { "format": "google-datetime", "description": "Required. Timestamp when the message was sent or received.", "type": "string" }, "chunks": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk" }, "type": "array", "description": "Required. Content of the message." }, "role": { "enumDescriptions": [ "Default value for unspecified.", "The user role.", "The model role." ], "enum": [ "ROLE_UNSPECIFIED", "USER", "MODEL" ], "description": "Required. Role within the conversation.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage", "type": "object" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "type": "object", "description": "Metadata for initializing a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "properties": { "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "request": { "description": "Output only. The original request for initialization.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." } } }, "GoogleIamV1TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "type": "object", "id": "GoogleIamV1TestIamPermissionsResponse", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." } }, "description": "The measure related to dialogflow interactions.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "description": "Agent Assist Smart Reply data.", "type": "object", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object" }, "confidenceScore": { "type": "number", "description": "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).", "format": "double" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "properties": { "errorMessages": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "The error message when the generative insights request fails." } }, "description": "The metadata for generative insights.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "readOnly": true, "format": "google-datetime" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "type": "object", "properties": { "issueId": { "type": "string", "description": "The issue ID." }, "issueDisplayName": { "type": "string", "description": "The issue display name." }, "issueModelId": { "type": "string", "description": "The parent issue model ID." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "properties": { "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "annotatorSelector": { "readOnly": true, "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "Metadata for a create analysis operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "description": "Response from export issue model", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { "properties": { "sourceType": { "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer." }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "properties": {}, "type": "object", "description": "The response to deploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher", "properties": { "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "revisionId": { "description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", "readOnly": true, "type": "string" }, "activationUpdateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The most recent time at which the activation status was updated.", "type": "string" }, "roleMatch": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "type": "string" }, "phraseMatchRuleGroups": { "type": "array", "description": "A list of phase match rule groups that are included in this matcher.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" } }, "updateTime": { "description": "Output only. The most recent time at which the phrase matcher was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "string" }, "type": { "enum": [ "PHRASE_MATCHER_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ], "type": "string", "description": "Required. The type of this phrase matcher.", "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rule groups or there is no match.", "If any of the phrase match rule groups are met, there is a match." ] }, "versionTag": { "description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.", "type": "string" }, "revisionCreateTime": { "readOnly": true, "description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", "type": "string", "format": "google-datetime" } }, "description": "The phrase matcher resource." }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "type": "object", "description": "The conversation source, which is a combination of transcript and audio.", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "properties": { "dialogflowSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "The source when the conversation comes from Dialogflow." }, "turnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "description": "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.", "type": "array" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource", "description": "A Cloud Storage location specification for the audio and transcript." }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData", "description": "The data for a silence annotation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource": { "description": "The request data for visualizing the dataset in the chart.", "properties": { "generativeInsights": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "description": "Use natural language query to generate the chart." }, "queryMetrics": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics", "description": "Use the existing QueryMetrics to generate the chart." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "properties": { "sourceType": { "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "description": "What created the answer.", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ] }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource", "type": "object", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "type": "object", "description": "Aggregated statistics about an issue model.", "properties": { "issueStats": { "type": "object", "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" } }, "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string", "format": "int64" }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "type": "object", "description": "The measure related to conversations.", "properties": { "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "summarizationSuggestionResultCount": { "type": "integer", "format": "int32", "description": "Count of summarization suggestions results." }, "averageTurnCount": { "format": "float", "type": "number", "description": "The average turn count." }, "knowledgeAssistResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user." }, "averageCustomerSatisfactionRating": { "type": "number", "format": "double", "description": "The average customer satisfaction rating." }, "knowledgeAssistUriClickRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "format": "double", "type": "number" }, "dialogflowConversationsEscalationRatio": { "type": "number", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "format": "double" }, "knowledgeSearchUriClickRatio": { "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "format": "double" }, "knowledgeSearchAgentQuerySourceRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "conversationalAgentsAverageEndToEndLatency": { "type": "number", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "averageQaQuestionNormalizedScore": { "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", "format": "double", "type": "number" }, "dialogflowConversationsEscalationCount": { "type": "number", "description": "count of conversations that was handed off from virtual agent to human agent.", "format": "double" }, "averageSummarizationSuggestionNormalizedEditDistance": { "format": "double", "type": "number", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length)." }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "averageSilencePercentage": { "type": "number", "description": "The average silence percentage.", "format": "float" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "aaSupervisorDroppedConversationsCount": { "type": "integer", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "format": "int32" }, "averageAgentSentimentScore": { "type": "number", "description": "The average agent's sentiment score.", "format": "float" }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "averageSummarizationSuggestionEditDistance": { "type": "number", "format": "double", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion." }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were escalated to an AA human supervisor for intervention." }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "format": "double", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "format": "int32", "type": "integer" }, "averageDuration": { "format": "google-duration", "type": "string", "description": "The average duration." }, "knowledgeSearchSuggestedQuerySourceRatio": { "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "format": "double" }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number" }, "averageQaNormalizedScore": { "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, "knowledgeAssistNegativeFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "qaTagScores": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags." }, "conversationAiCoachSuggestionCount": { "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "format": "double", "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number" }, "conversationTotalCustomerMessageCount": { "type": "integer", "format": "int32", "description": "The customer message count." }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "format": "double", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "type": "number", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "format": "double" }, "dialogflowAverageWebhookLatency": { "type": "number", "description": "Average latency of dialogflow webhook calls.", "format": "double" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "format": "double", "type": "number" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "format": "int32", "type": "integer" }, "averageClientSentimentScore": { "format": "float", "description": "The average client's sentiment score.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "conversationAiCoachSuggestionRatio": { "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "format": "double", "type": "number" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "format": "double", "type": "number" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "knowledgeSearchResultCount": { "type": "integer", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "format": "int32" }, "aaSupervisorAssignedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were assigned to an AA human supervisor." }, "conversationalAgentsAverageLlmCallLatency": { "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "format": "double", "type": "number" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "format": "double", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "description": "The request to ingest conversations.", "properties": { "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." }, "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication." }, "parent": { "type": "string", "description": "Required. The parent resource for new conversations." }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainIssue": { "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1mainIssue", "type": "object", "properties": { "sampleUtterances": { "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated." }, "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "displayName": { "type": "string", "description": "The representative name for the issue." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time at which this issue was created.", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "type": "object", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string" }, "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." } }, "description": "Metadata for initializing a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse", "type": "object", "properties": { "dashboards": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "description": "The dashboards under the parent.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data." } }, "description": "The response of listing dashboards." }, "GoogleCloudContactcenterinsightsV1alpha1UserInfo": { "description": "Information about a user.", "id": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "properties": { "username": { "description": "The user's username.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "properties": {}, "type": "object", "description": "Response for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "type": "object", "properties": { "text": { "description": "Optional. The thought or reasoning text.", "type": "string" } }, "description": "A thought part." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "properties": { "agentId": { "type": "string", "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`." }, "customerChannel": { "type": "integer", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "format": "int32" }, "agentChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "type": "object", "description": "Request to export an issue model.", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination" }, "name": { "type": "string", "description": "Required. The issue model to export." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1SilenceData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1SilenceData", "properties": {}, "description": "The data for a silence annotation." }, "GoogleTypeMoney": { "id": "GoogleTypeMoney", "type": "object", "description": "Represents an amount of money with its currency type.", "properties": { "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "units": { "type": "string", "format": "int64", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar." }, "nanos": { "format": "int32", "type": "integer", "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000." } } }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "properties": { "cesEndSessionAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "description": "The CES end session annotation." }, "answerFeedback": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "description": "The feedback that the customer has about the answer in `data`." }, "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "annotationId": { "type": "string", "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "smartComposeSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data." }, "startBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "cesTurnAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "description": "The CES turn annotation." }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" } }, "description": "An annotation that was generated during the customer and agent interaction.", "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "properties": { "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "description": "Output only. The original request for delete." }, "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest", "properties": {}, "description": "The message to appeal an assessment." }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse", "description": "The response from a ListAuthorizedViews request.", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "authorizedViews": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "description": "The AuthorizedViews under the parent." } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "description": "All the matched issues.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse": { "description": "The response of listing issues.", "properties": { "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "type": "array", "description": "The issues that match the request." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "type": "object", "description": "Info for correlating across conversations.", "properties": { "fullConversationCorrelationId": { "type": "string", "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of." }, "correlationTypes": { "readOnly": true, "items": { "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "type": "string" }, "description": "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.", "type": "array" }, "mergedFullConversationCorrelationId": { "type": "string", "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "type": "object", "properties": { "text": { "type": "string", "description": "A message from the user that is interacting with the system." } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage", "description": "The user message.", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "type": "object", "description": "Metadata about the conversation medium dimension.", "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { "properties": { "disableWordTimeOffsets": { "type": "boolean", "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false." }, "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "type": "object", "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint." }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "id": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "type": "object", "properties": { "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone isolated." }, "name": { "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Whether this resource is zone separated.", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The most recent time at which the question tag was updated." }, "createTime": { "description": "Output only. The time at which the question tag was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "qaQuestionIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional." } }, "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse": { "properties": { "qaQuestions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "type": "array", "description": "The QaQuestions under the parent." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse", "description": "The response from a ListQaQuestions request." }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "properties": { "type": { "description": "The type of the entity mention.", "type": "string", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ] }, "entityUniqueId": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "Sentiment expressed for this mention of the entity." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "type": "object", "description": "The request to analyze conversations in bulk.", "properties": { "analysisPercentage": { "type": "number", "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "relabel": { "description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "deprecated": true, "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "type": "object", "description": "A text output message from the system.", "properties": { "textType": { "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "type": "string", "description": "The type of the text message.", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] }, "text": { "description": "The parts of the message.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "type": "string", "description": "Optional. The dialogflow playbook display name." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "type": "object", "properties": { "kmsKey": { "type": "string", "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}" }, "exportSchemaVersion": { "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "description": "Optional. Version of the export schema.", "type": "string" }, "writeDisposition": { "description": "Options for what to do if the destination table already exists.", "type": "string", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ] }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "type": "object", "description": "Statistics for IngestConversations operation.", "properties": { "failedIngestCount": { "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer", "readOnly": true, "format": "int32" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32", "readOnly": true }, "processedObjectCount": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. The number of objects processed during the ingest operation." }, "duplicatesSkippedCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "type": "object", "properties": { "constraintMet": { "type": "boolean", "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A)." }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "type": "string", "description": "The rule ID." } }, "description": "The result of a single constraint rule on the pair of conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "properties": {}, "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The original request for bulk delete." }, "partialErrors": { "type": "array", "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations": { "type": "object", "description": "Wrapper for a list of conversations.", "properties": { "conversations": { "type": "array", "description": "Optional. The conversations.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "type": "object", "description": "The conversation transcript for the chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "properties": { "createTime": { "type": "string", "readOnly": true, "description": "Output only. The create time of the conversation.", "format": "google-datetime" }, "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" }, "description": "Ordered list of messages, including user inputs and system responses.", "type": "array" }, "updateTime": { "type": "string", "description": "Output only. The update time of the conversation.", "readOnly": true, "format": "google-datetime" }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata", "properties": { "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created." }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "type": "object", "description": "Metadata for testing correlation config." }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule": { "type": "object", "description": "A correlation rule that defines how to join conversations for a given correlation type.", "properties": { "active": { "description": "Optional. Whether the config is active to be evaluated.", "type": "boolean" }, "joinKeyExpression": { "description": "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.", "type": "string" }, "ruleId": { "description": "Required. The unique identifier of the rule.", "type": "string" }, "constraintExpression": { "description": "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)", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { "properties": { "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. User provided chart spec" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec from LLM", "type": "object" } }, "type": "object", "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "properties": { "text": { "type": "string", "description": "Optional. Anchor or display text." }, "uri": { "description": "Optional. Target URI.", "type": "string" } }, "type": "object", "description": "A link part." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "properties": { "name": { "type": "string", "description": "Required. The name of the issue model to delete." } }, "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "type": "object", "description": "The request to delete an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" }, "analysisResult": { "readOnly": true, "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult" }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone separated." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes." }, "requestTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time at which the analysis was requested." }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Whether this resource is zone isolated.", "type": "boolean" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." } }, "description": "The analysis resource.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "properties": { "sampleConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "description": "Output only. Statistics for SampleConversations operation." }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", "type": "object", "description": "The metadata for an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1Dataset": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset", "properties": { "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "description": "Dataset usage type." }, "createTime": { "type": "string", "description": "Output only. Dataset create time.", "readOnly": true, "format": "google-datetime" }, "ttl": { "description": "Optional. Option TTL for the dataset.", "format": "google-duration", "type": "string" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dataset update time." }, "description": { "description": "Dataset description.", "type": "string" }, "displayName": { "description": "Display name for the dataaset", "type": "string" } }, "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "type": "object", "description": "Explicit input used for generating the answer", "properties": { "querySource": { "type": "string", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "description": "Query source for the answer.", "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ] }, "query": { "type": "string", "description": "Query text. Article Search uses this to store the input query used to generate the search results." }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "properties": { "exportSchemaVersion": { "type": "string", "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "description": "Optional. Version of the export schema.", "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ] }, "kmsKey": { "type": "string", "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}" }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties." }, "writeDisposition": { "type": "string", "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "description": "Options for what to do if the destination table already exists." }, "parent": { "type": "string", "description": "Required. The parent resource to export data from." } }, "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "properties": { "uri": { "type": "string", "description": "Optional. URI or URL to the media." }, "alternativeText": { "type": "string", "description": "Optional. Alternative text description." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "type": "object", "description": "A media part." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "type": "object", "description": "Metadata about conversation labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "properties": { "labelValue": { "type": "string", "description": "Optional. The label value." }, "labelKey": { "type": "string", "description": "Optional. The label key." } } }, "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "type": "object", "description": "Conversation summarization suggestion data.", "properties": { "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "text": { "type": "string", "description": "The summarization content that is concatenated into one string." }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "confidence": { "description": "The confidence score of the summarization.", "format": "float", "type": "number" }, "textSections": { "additionalProperties": { "type": "string" }, "description": "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.", "type": "object" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" } } }, "GoogleCloudCesV1mainToolResponse": { "type": "object", "description": "The execution result of a specific tool from the client or the agent.", "properties": { "agentName": { "type": "string", "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.", "readOnly": true }, "parentToolCallId": { "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.", "type": "string", "readOnly": true }, "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" }, "toolsetTool": { "$ref": "GoogleCloudCesV1mainToolsetTool", "description": "Optional. The toolset tool that got executed." }, "displayName": { "type": "string", "readOnly": true, "description": "Output only. Display name of the tool." }, "response": { "description": "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.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" } }, "id": "GoogleCloudCesV1mainToolResponse" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata", "properties": { "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array" } }, "description": "Metadata for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." }, "failedAnalysesCount": { "type": "integer", "format": "int32", "description": "The number of requested analyses that have failed so far." }, "relabel": { "description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "deprecated": true, "type": "boolean", "readOnly": true }, "completedAnalysesCount": { "type": "integer", "description": "The number of requested analyses that have completed successfully so far.", "format": "int32" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "partialErrors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete." }, "totalRequestedAnalysesCount": { "type": "integer", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "description": "A row in a table.", "type": "object", "properties": { "cells": { "description": "Optional. The cell values in the row.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow" }, "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig", "type": "object", "description": "Regex match configuration.", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "properties": { "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "Data specifying sentiment." }, "channelTag": { "type": "integer", "format": "int32", "description": "The channel of the audio that the data applies to." } } }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The original request for deletion." } }, "description": "Metadata for deleting an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "type": "object", "description": "The result of testing a constraint expression on a pair of conversations.", "properties": { "conversationA": { "type": "string", "description": "The first conversation resource name." }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" }, "type": "array", "description": "The results for each applicable constraint rule." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } } }, "GoogleCloudContactcenterinsightsV1mainDataset": { "id": "GoogleCloudContactcenterinsightsV1mainDataset", "type": "object", "properties": { "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "description": "Output only. Dataset create time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. Dataset update time.", "format": "google-datetime" }, "ttl": { "type": "string", "description": "Optional. Option TTL for the dataset.", "format": "google-duration" }, "name": { "type": "string", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" }, "satisfiesPzs": { "description": "Output only. Whether this resource is zone separated.", "readOnly": true, "type": "boolean" }, "type": { "type": "string", "description": "Dataset usage type.", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" } }, "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "properties": { "alwaysPrintEmptyFields": { "type": "boolean", "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format." }, "recordsPerFileCount": { "type": "string", "description": "Optional. The number of records per file. Applicable for either format.", "format": "int64" }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "format": { "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "type": "string", "description": "Required. File format in which the labels will be exported.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "type": "object", "properties": { "dialogflowConversation": { "readOnly": true, "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "audioUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation audio." } } }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "labeledConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations attached to the issue at this point in time." }, "displayName": { "description": "Display name of the issue.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "type": "object", "properties": { "confidence": { "format": "float", "type": "number", "description": "The confidence score of the summarization." }, "textSections": { "type": "object", "description": "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.", "additionalProperties": { "type": "string" } }, "generatorId": { "type": "string", "description": "Agent Assist generator ID." }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that contains metadata about the summarization and the document from which it originates." }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issueModel": { "type": "string", "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "issues": { "type": "array", "description": "All the matched issues.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "GoogleCloudCesV1mainMessage": { "type": "object", "description": "A message within a conversation.", "id": "GoogleCloudCesV1mainMessage", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "chunks": { "items": { "$ref": "GoogleCloudCesV1mainChunk" }, "type": "array", "description": "Optional. Content of the message as a series of chunks." }, "eventTime": { "type": "string", "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "description": "The original export request." } } }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1Entity": { "id": "GoogleCloudContactcenterinsightsV1Entity", "properties": { "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "type": { "description": "The entity type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ] }, "salience": { "type": "number", "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient." }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "question": { "type": "string", "description": "The corresponding FAQ question." }, "confidenceScore": { "description": "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).", "type": "number", "format": "float" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest": { "properties": { "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest", "type": "object", "description": "The request for calculating conversation statistics." }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "type": "object", "description": "The response for querying performance overview.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart", "properties": { "table": { "description": "Optional. Tabular data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "productCollection": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart", "description": "Optional. Product collection or carousel." }, "video": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "Optional. Video media." }, "suggestionChips": { "description": "Optional. Suggestion chips or interactive buttons.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" }, "link": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "description": "Optional. Web link or URL." }, "thought": { "description": "Optional. Model thought or internal reasoning.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart" }, "text": { "description": "Optional. Plain text content.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart" }, "list": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart", "description": "Optional. Ordered or unordered list." }, "citation": { "description": "Optional. Citation or reference to grounding material.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart" }, "image": { "description": "Optional. Image media.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "customPayload": { "description": "Optional. Generic custom structured payload.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart" } }, "type": "object", "description": "A structured component/part of a transcript segment." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "messageTime": { "format": "google-datetime", "type": "string", "description": "The time that the message occurred, if provided." }, "words": { "type": "array", "description": "A list of the word-specific information for each word in the segment.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" } }, "text": { "type": "string", "description": "The text of this segment." }, "channelTag": { "type": "integer", "format": "int32", "description": "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." }, "parts": { "description": "Optional. The structured parts that make up this transcript segment.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart" }, "type": "array" }, "languageCode": { "type": "string", "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\"." }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "confidence": { "type": "number", "format": "float", "description": "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." }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "type": "object", "properties": { "sentimentCategory": { "type": "string", "description": "Optional. The client sentiment category." } }, "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest", "properties": { "maxDownloadCount": { "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer", "format": "int32" }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "A sheets document destination." }, "templateQaScorecardId": { "items": { "type": "string" }, "type": "array", "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored." }, "feedbackLabelType": { "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "type": "string", "description": "Optional. The type of feedback labels that will be downloaded." }, "filter": { "description": "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", "type": "string" } }, "description": "Request for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "type": "object", "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "description": "An error that occurred during correlation for a specific conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The next page token." }, "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } } }, "description": "The response for listing feedback labels." }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "description": "The CES diagnostic information.", "properties": { "messages": { "type": "array", "description": "The messages in the turn.", "items": { "$ref": "GoogleCloudCesV1mainMessage" } }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "properties": { "imageUris": { "type": "array", "description": "Optional. Product image URLs.", "items": { "type": "string" } }, "uri": { "description": "Optional. Product URL or deep link.", "type": "string" }, "displayName": { "description": "Optional. Product display name.", "type": "string" }, "id": { "description": "Optional. Product ID.", "type": "string" }, "price": { "description": "Optional. Product price.", "$ref": "GoogleTypeMoney" }, "description": { "description": "Optional. Product description.", "type": "string" } }, "type": "object", "description": "A product in a product collection.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "type": "object", "properties": { "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" }, "alwaysPrintEmptyFields": { "type": "boolean", "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format." }, "format": { "type": "string", "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "description": "Required. File format in which the labels will be exported.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] }, "addWhitespace": { "type": "boolean", "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format." } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1Note": { "type": "object", "description": "The conversation assessment note resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Note", "properties": { "content": { "description": "The note content.", "type": "string" }, "noteCreator": { "description": "Output only. The user that created the note.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1UserInfo" }, "conversationTurnNote": { "description": "The note is associated with a conversation turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the note was created.", "readOnly": true }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote" }, "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "updateTime": { "description": "Output only. The time at which the note was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "type": "object", "description": "Metadata about the Conversational Agents tool dimension.", "properties": { "toolId": { "type": "string", "description": "Optional. The dialogflow tool ID." }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { "type": "object", "properties": { "bucketObjectType": { "type": "string", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ] }, "transcriptBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`." }, "customMetadataKeys": { "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "items": { "type": "string" }, "type": "array" }, "audioBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`." }, "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "metadataBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`." } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "duplicatesSkippedCount": { "readOnly": true, "type": "integer", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "format": "int32" }, "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "format": "int32", "readOnly": true, "type": "integer" }, "failedIngestCount": { "readOnly": true, "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse": { "description": "The response from a ListAuthorizedViews request.", "type": "object", "properties": { "authorizedViews": { "description": "The AuthorizedViews under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "properties": { "name": { "type": "string", "description": "Required. The issue model to undeploy." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "properties": { "id": { "description": "Optional. Product ID.", "type": "string" }, "imageUris": { "type": "array", "items": { "type": "string" }, "description": "Optional. Product image URLs." }, "description": { "type": "string", "description": "Optional. Product description." }, "uri": { "type": "string", "description": "Optional. Product URL or deep link." }, "displayName": { "description": "Optional. Product display name.", "type": "string" }, "price": { "description": "Optional. Product price.", "$ref": "GoogleTypeMoney" } }, "type": "object", "description": "A product in a product collection.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } }, "description": "The request for deleting a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "type": "object", "description": "Conversation-level silence data.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "properties": { "silencePercentage": { "format": "float", "description": "Percentage of the total conversation spent in silence.", "type": "number" }, "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "properties": { "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "type": "string", "description": "Required. The medium transcript objects represent.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "type": "object", "description": "Configuration for processing transcript objects." }, "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec", "type": "object", "properties": { "kmsKey": { "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", "type": "string" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" } }, "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "properties": {}, "description": "The response to an SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleRule": { "properties": { "conversationFilter": { "type": "string", "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations." }, "samplePercentage": { "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number" }, "sampleRow": { "type": "string", "description": "Number of the conversations that we should sample based on the dimension.", "format": "int64" }, "dimension": { "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleRule", "description": "Message for sampling conversations." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "properties": { "text": { "description": "Optional. The thought or reasoning text.", "type": "string" } }, "description": "A thought part.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "properties": { "summarizationModel": { "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used." }, "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "GoogleCloudContactcenterinsightsV1SpeechConfig": { "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SpeechConfig", "properties": { "speechRecognizer": { "type": "string", "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`" }, "disableWordTimeOffsets": { "type": "boolean", "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "properties": { "text": { "type": "string", "description": "A message from the user that is interacting with the system." } }, "description": "The user message.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "type": "object", "properties": { "text": { "type": "string", "description": "Optional. The text of the list item." }, "subItems": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "type": "array", "description": "Optional. Nested sub-items." } }, "description": "An item in a list.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "description": "The request to export insights.", "properties": { "parent": { "type": "string", "description": "Required. The parent resource to export data from." }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties." }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" }, "writeDisposition": { "description": "Options for what to do if the destination table already exists.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "type": "string" }, "kmsKey": { "type": "string", "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}" }, "exportSchemaVersion": { "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "description": "Optional. Version of the export schema.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "appliedRedactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Output only. The redaction config applied to the uploaded conversation.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "analysisOperation": { "type": "string", "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation." }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "description": "Call-specific metadata.", "properties": { "customerChannel": { "type": "integer", "format": "int32", "description": "The audio channel that contains the customer." }, "agentChannel": { "description": "The audio channel that contains the agent.", "format": "int32", "type": "integer" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "properties": { "skipValue": { "type": "boolean", "description": "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.", "readOnly": true }, "normalizedScore": { "readOnly": true, "type": "number", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "format": "double" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "numValue": { "format": "double", "type": "number", "description": "Numerical value." }, "score": { "readOnly": true, "type": "number", "description": "Output only. Numerical score of the answer.", "format": "double" }, "potentialScore": { "format": "double", "description": "Output only. The maximum potential score of the question.", "readOnly": true, "type": "number" }, "strValue": { "type": "string", "description": "String value." }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" } }, "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "properties": { "failedExportCount": { "description": "The number of conversations that failed to be exported.", "format": "int32", "type": "integer" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "completedExportCount": { "description": "The number of conversations that were exported successfully.", "format": "int32", "type": "integer" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation was created." }, "endTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" } }, "description": "Metadata for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse", "properties": { "issueMatches": { "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "additionalProperties": { "type": "integer", "format": "int32" }, "deprecated": true, "type": "object" }, "averageTurnCount": { "type": "integer", "format": "int32", "description": "The average number of turns per conversation." }, "conversationCountTimeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "description": "A time series representing the count of conversations created over time that match that requested filter criteria." }, "smartHighlighterMatches": { "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "issueMatchesStats": { "type": "object", "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" } }, "conversationCount": { "format": "int32", "description": "The total number of conversations.", "type": "integer" }, "averageDuration": { "description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration.", "type": "string", "format": "google-duration" }, "customHighlighterMatches": { "additionalProperties": { "format": "int32", "type": "integer" }, "description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", "type": "object" } }, "description": "The response for calculating conversation statistics." }, "GoogleCloudContactcenterinsightsV1IssueModel": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModel", "properties": { "modelType": { "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model." }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "state": { "type": "string", "description": "Output only. State of the model.", "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "format": "google-datetime" }, "languageCode": { "type": "string", "description": "Language of the model." }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string", "readOnly": true }, "issueCount": { "format": "int64", "description": "Output only. Number of issues in this issue model.", "type": "string", "readOnly": true }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "readOnly": true } }, "description": "The issue model resource." }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "type": "object", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "properties": { "phraseMatcher": { "type": "string", "description": "The unique identifier (the resource name) of the phrase matcher." }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest", "description": "The message to publish an assessment. Draft and appealed assessments can be published. Publishing simply changes the state of the assessment to published, allowing the console and authorized views to filter on the state." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "properties": { "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "force": { "description": "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.", "type": "boolean" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { "confidence": { "description": "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.", "type": "number", "format": "float" }, "endOffset": { "type": "string", "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation." }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "description": "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", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "description": "Request for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1IntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "properties": { "intentUniqueId": { "type": "string", "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "properties": { "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer", "format": "int32" }, "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "format": "int32", "type": "integer" } }, "type": "object", "description": "A point in a conversation that marks the start or the end of an annotation.", "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "GoogleCloudContactcenterinsightsV1Intent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" }, "id": { "description": "The unique identifier of the intent.", "type": "string" } }, "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1Intent" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue", "description": "Required. The values for the new issue." } }, "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "type": "object", "properties": { "medium": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "description": "Required. The medium transcript objects represent.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] } }, "description": "Configuration for processing transcript objects." }, "GoogleCloudContactcenterinsightsV1alpha1ChartAction": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "type": "object", "description": "The action to be taken when the chart is clicked.", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" }, "conversationFilter": { "type": "string", "description": "The conversation filter string." } } }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "properties": { "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "intentMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData", "description": "Data specifying an intent match." }, "annotationStartBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "format": "int32", "type": "integer" }, "issueMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData", "description": "Data specifying an issue match." }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1HoldData" }, "interruptionData": { "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData", "description": "Data specifying an interruption." }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1SilenceData" }, "entityMentionData": { "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData", "description": "Data specifying an entity mention." }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1CallAnnotation", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "issueModels": { "items": { "type": "string" }, "type": "array", "description": "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." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runAutoLabelingAnnotator": { "type": "boolean", "description": "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": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "qaConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig", "description": "Configuration for the QA annotator." }, "runIssueModelAnnotator": { "type": "boolean", "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect." }, "runInterruptionAnnotator": { "type": "boolean", "description": "Whether to run the interruption annotator." }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "phraseMatchers": { "description": "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}", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "type": "object", "properties": { "maxDownloadCount": { "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "templateQaScorecardId": { "type": "array", "items": { "type": "string" }, "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored." }, "filter": { "type": "string", "description": "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" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "feedbackLabelType": { "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string" } }, "description": "Request for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip", "properties": { "actionUri": { "description": "Optional. Optional action or destination URI triggered by the chip.", "type": "string" }, "text": { "description": "Optional. The chip label or text.", "type": "string" } }, "description": "A suggestion chip.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "properties": { "summaryText": { "type": "string", "description": "The summary text of the performance." } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse", "description": "The response for querying performance overview.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "id": "GoogleCloudContactcenterinsightsV1alpha1Issue", "properties": { "createTime": { "type": "string", "description": "Output only. The time at which this issue was created.", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "The representative name for the issue." }, "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "sampleUtterances": { "type": "array", "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "items": { "type": "string" }, "readOnly": true }, "updateTime": { "type": "string", "description": "Output only. The most recent time that this issue was updated.", "format": "google-datetime", "readOnly": true }, "displayDescription": { "type": "string", "description": "Representative description of the issue." } }, "description": "The issue resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse": { "properties": { "qaQuestionTags": { "type": "array", "description": "The parent resource of the questions.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse", "type": "object", "description": "The response from a ListQaQuestionTags request." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "properties": { "dataset": { "type": "string", "description": "The dataset used for sampling conversations." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." }, "stats": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "The statistics for the operation." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata", "type": "object", "description": "Metadata for testing correlation config." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest", "description": "Request to import an issue model.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage source message." } } }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { "properties": { "sourceType": { "type": "string", "description": "What created the answer.", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ] }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "type": "object", "properties": { "points": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval" }, "type": "array", "description": "An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window." }, "intervalDuration": { "format": "google-duration", "type": "string", "description": "The duration of each interval." } }, "description": "A time series representing conversations over time." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage", "type": "object", "description": "The message in the conversation.", "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "format": "google-datetime" }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse", "properties": { "slices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "type": "array", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request." }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "location": { "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" }, "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "type": "string" } }, "type": "object", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "description": "Response from import issue model", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "description": "A row in a table.", "properties": { "cells": { "items": { "type": "string" }, "type": "array", "description": "Optional. The cell values in the row." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "type": "object", "description": "Metadata for creating an issue.", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "description": "The original request for creation." } } }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "properties": { "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "description": "The results for each applicable constraint rule.", "type": "array" }, "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" } }, "description": "The result of testing a constraint expression on a pair of conversations." }, "GoogleRpcStatus": { "description": "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).", "id": "GoogleRpcStatus", "properties": { "message": { "type": "string", "description": "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." }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest": { "description": "The request message for testing auto labeling rules.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest", "properties": { "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "description": "Required. Conversation data to test rules against." }, "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip": { "description": "A suggestion chip.", "properties": { "actionUri": { "description": "Optional. Optional action or destination URI triggered by the chip.", "type": "string" }, "text": { "type": "string", "description": "Optional. The chip label or text." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip", "type": "object" }, "GoogleIamV1AuditLogConfig": { "properties": { "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, "logType": { "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "type": "string", "description": "The log type that this config enables.", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] } }, "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "GoogleIamV1AuditLogConfig", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "description": "The response for querying metrics.", "properties": { "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, "type": "array" }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" }, "location": { "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "properties": { "annotationId": { "type": "string", "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}" }, "dialogflowInteraction": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData", "description": "Dialogflow interaction data." }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time at which this annotation was created." }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "userInput": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer" }, "answerFeedback": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "description": "The feedback that the customer has about the answer in `data`." }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "endBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "startBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { "properties": { "confidence": { "format": "float", "type": "number", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" } }, "type": "object", "description": "Dialogflow interaction data.", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "type": "object", "properties": { "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "force": { "description": "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.", "type": "boolean" }, "filter": { "type": "string", "description": "Filter used to select the subset of conversations to delete." }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } }, "description": "The request to delete conversations in bulk.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse", "properties": { "assessments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "The assessments that match the request." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "The response of listing assessments." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "properties": { "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } }, "textType": { "type": "string", "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } }, "type": "object", "description": "A text output message from the system.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "properties": { "agentChannel": { "type": "integer", "format": "int32", "description": "The audio channel that contains the agent." }, "customerChannel": { "description": "The audio channel that contains the customer.", "format": "int32", "type": "integer" } }, "description": "Call-specific metadata.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "properties": { "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "type": "array", "description": "The messages in the turn." }, "rootSpan": { "$ref": "GoogleCloudCesV1mainSpan", "description": "The root span of the action processing." } }, "description": "The CES diagnostic information.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "properties": { "qaQuestionTag": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "description": "Required. The QaQuestionTag to update." }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" } }, "type": "object" }, "GoogleTypeExpr": { "properties": { "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." } }, "id": "GoogleTypeExpr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "properties": { "partialErrors": { "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "type": "integer", "format": "int32" }, "conversationCorrelationErrors": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "description": "A list of errors that occurred during correlation, one for each conversation that failed." }, "failedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed correlation." }, "correlatedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations correlated." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "properties": { "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." }, "magnitude": { "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig": { "type": "object", "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig", "description": "Exact match configuration." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "failedConversationsCount": { "format": "int32", "description": "The number of conversations that failed correlation.", "type": "integer" }, "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" }, "partialErrors": { "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "conversationCorrelationErrors": { "type": "array", "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "format": "int32", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "properties": { "text": { "type": "string", "description": "Optional. The text content." } }, "description": "A text part." }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" } }, "type": "object", "description": "Metadata used for import issue model.", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { "type": "object", "description": "The request for updating a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "properties": { "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string", "format": "google-fieldmask" }, "qaQuestionTag": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "description": "Required. The QaQuestionTag to update." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "properties": { "dimensions": { "type": "array", "description": "A unique combination of dimensions that this slice represents.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" } }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" } }, "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, "GoogleTypeInterval": { "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "type": "object", "id": "GoogleTypeInterval", "properties": { "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "format": "google-datetime" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start." } } }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange": { "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange", "type": "object", "properties": { "quantity": { "description": "Required. The quantity of units in the past.", "format": "int64", "type": "string" }, "unit": { "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "type": "string", "description": "Required. The unit of time.", "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] } }, "description": "Relative date range configuration." }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "type": "object", "description": "An answer to a QaQuestion.", "properties": { "qaQuestion": { "type": "string", "description": "The QaQuestion answered by this answer." }, "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer." }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "answerSources": { "type": "array", "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" } } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { "type": "object", "description": "Google Cloud Storage Object URI to save the issue model to.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." }, "p99": { "format": "double", "type": "number", "description": "The 99th percentile value." }, "p50": { "format": "double", "type": "number", "description": "The 50th percentile value." } }, "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th." }, "GoogleCloudContactcenterinsightsV1GcsSource": { "properties": { "audioUris": { "description": "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).", "items": { "type": "string" }, "type": "array" }, "audioUri": { "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "deprecated": true, "type": "string" }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" } }, "description": "A Cloud Storage source of conversation data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GcsSource" }, "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "properties": { "intentUniqueId": { "type": "string", "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information." } }, "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences." }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "completedExportCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were exported successfully." } }, "description": "Metadata for an export insights operation." }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "readOnly": true, "description": "Output only. The original request." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "description": "The request to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest": { "properties": {}, "type": "object", "description": "The request to undeploy a QaScorecardRevision", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "properties": { "languageCode": { "type": "string", "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\"." }, "words": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, "description": "A list of the word-specific information for each word in the segment." }, "text": { "description": "The text of this segment.", "type": "string" }, "confidence": { "type": "number", "description": "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.", "format": "float" }, "parts": { "description": "Optional. The structured parts that make up this transcript segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart" } }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "channelTag": { "description": "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.", "format": "int32", "type": "integer" }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant" }, "messageTime": { "type": "string", "format": "google-datetime", "description": "The time that the message occurred, if provided." } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "type": "object", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "properties": { "medium": { "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "deprecated": true, "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. Number of conversations used in training. Output only." } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "A media part.", "properties": { "uri": { "description": "Optional. URI or URL to the media.", "type": "string" }, "alternativeText": { "type": "string", "description": "Optional. Alternative text description." } }, "type": "object" }, "GoogleProtobufEmpty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "GoogleProtobufEmpty" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "properties": { "title": { "type": "string", "description": "Optional. Optional title for the table." }, "headers": { "description": "Optional. Table column headers.", "type": "array", "items": { "type": "string" } }, "rows": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow" }, "type": "array", "description": "Optional. Table rows." } }, "description": "A table part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "properties": { "conversationFilter": { "type": "string", "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations." }, "dimension": { "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", "type": "string" }, "samplePercentage": { "type": "number", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "format": "double" }, "sampleRow": { "format": "int64", "type": "string", "description": "Number of the conversations that we should sample based on the dimension." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "description": "Message for sampling conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "properties": {}, "type": "object", "description": "The metadata for querying performance overview.", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata" }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "type": "object", "properties": { "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "correctnessLevel": { "type": "string", "description": "The correctness level of an answer.", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ] }, "clicked": { "type": "boolean", "description": "Indicates whether an answer or item was clicked by the human agent." } }, "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "description": "The feedback that the customer has about a certain answer in the conversation." }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "id": "GoogleCloudContactcenterinsightsV1InterruptionData", "properties": {}, "type": "object", "description": "The data for an interruption annotation." }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig", "type": "object", "properties": { "updateTime": { "description": "Output only. The time at which the correlation config was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "name": { "type": "string", "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig" }, "fullConversationConfig": { "description": "The correlation type config for full conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" }, "createTime": { "description": "Output only. The time at which the correlation config was created.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "description": "A configuration that defines how to correlate conversations for a given a given project." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "type": "object", "description": "The response for generative insights.", "properties": { "generativeResponses": { "type": "array", "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "type": "object", "description": "The response for a bulk analyze conversations operation.", "properties": { "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" }, "failedAnalysisCount": { "description": "Count of failed analyses.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse" }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "type": "object", "description": "The call participant speaking for a given utterance.", "properties": { "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "dialogflowParticipantName": { "type": "string", "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" }, "role": { "description": "The role of the participant.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "userId": { "type": "string", "description": "A user-specified ID representing the participant." }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant" }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "description": "Output only. The original request for sample conversations to dataset." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "sampleConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "description": "Output only. Statistics for SampleConversations operation." }, "partialErrors": { "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata", "description": "The metadata for an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "type": "object", "properties": { "sourceUri": { "description": "Optional. The cited source URI.", "type": "string" }, "sourceTitle": { "description": "Optional. The cited source title.", "type": "string" }, "snippet": { "description": "Optional. Snippet of the cited text.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "description": "A citation part." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "description": "Response from export issue model", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "description": "The data for an interruption annotation." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "type": "object", "properties": { "dataPoints": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series ." } }, "description": "A time series of metric values." }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "properties": { "silence": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "sentiments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" }, "type": "array", "description": "Overall conversation-level sentiment for each channel of the call." }, "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" }, "type": "array", "description": "A list of call annotations that apply to this call." }, "issueModelResult": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "description": "Overall conversation-level issue modeling result." }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "type": "object" }, "phraseMatchers": { "type": "object", "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" } }, "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" }, "type": "object", "description": "All the matched intents in the call." }, "qaScorecardResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" }, "description": "Results of scoring QaScorecards.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "type": "object", "description": "Call-specific metadata created during analysis." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "description": "Request to export an issue model.", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "type": "object", "properties": { "rows": { "description": "Optional. Table rows.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow" } }, "headers": { "description": "Optional. Table column headers.", "type": "array", "items": { "type": "string" } }, "title": { "description": "Optional. Optional title for the table.", "type": "string" } }, "description": "A table part." }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "properties": { "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "format": "google-duration", "type": "string" }, "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "format": "int32", "type": "integer" }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "type": "array", "description": "Input only. The feedback labels associated with the conversation." }, "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" }, "type": "array", "description": "Information about agents involved in the call." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip": { "properties": { "text": { "type": "string", "description": "Optional. The chip label or text." }, "actionUri": { "description": "Optional. Optional action or destination URI triggered by the chip.", "type": "string" } }, "description": "A suggestion chip.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip", "type": "object" }, "GoogleLongrunningOperation": { "properties": { "done": { "description": "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.", "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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`.", "type": "object" }, "name": { "description": "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}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleLongrunningOperation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { "type": "object", "description": "Dialogflow interaction data.", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "type": "number", "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "type": "string", "description": "The human-readable name of the phrase matcher." } }, "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "GoogleCloudCesV1mainAgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "id": "GoogleCloudCesV1mainAgentTransfer", "properties": { "targetAgent": { "description": "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}`", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. Display name of the agent.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "properties": { "constraintMet": { "type": "boolean", "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A)." }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "type": "string", "description": "The rule ID." } }, "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "properties": { "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" }, "channelTag": { "format": "int32", "type": "integer", "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated." }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" }, "annotationEndBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" } }, "type": "object", "description": "A piece of metadata that applies to a window of a call.", "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" }, "GoogleCloudContactcenterinsightsV1Issue": { "type": "object", "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1Issue", "properties": { "updateTime": { "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "sampleUtterances": { "items": { "type": "string" }, "type": "array", "readOnly": true, "description": "Output only. Resource names of the sample representative utterances that match to this issue." }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time at which this issue was created." }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "properties": { "updateTime": { "type": "string", "readOnly": true, "description": "Output only. The update time of the conversation.", "format": "google-datetime" }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "type": "array" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The create time of the conversation.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "properties": { "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } }, "textType": { "type": "string", "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "properties": { "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentDeploymentId": { "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { "type": "string", "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "agentVersionDisplayName": { "type": "string", "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "agentDisplayName": { "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDeploymentDisplayName": { "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", "type": "string" } }, "description": "Metadata about the agent dimension." }, "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest": { "properties": { "filter": { "type": "string", "description": "Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc." }, "validateOnly": { "description": "Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest", "description": "Request for TuneQaScorecardRevision endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1RedirectAction": { "properties": { "relativePath": { "type": "string", "description": "The relative path to redirect to." }, "queryParams": { "description": "The query params to be added to the redirect path.", "additionalProperties": { "type": "string" }, "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction", "type": "object", "description": "The redirect action to be taken when the chart is clicked." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "format": "double", "description": "Average tag normalized score per tag.", "type": "number" } }, "description": "Average QA normalized score for the tag." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart.", "properties": { "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response." }, "chartSpec": { "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textOutput": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "type": "string", "deprecated": true }, "generatedSqlQuery": { "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource.", "type": "string" } } }, "GoogleCloudCesV1mainChunk": { "type": "object", "description": "A chunk of content within a message.", "properties": { "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "GoogleCloudCesV1mainAgentTransfer" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "toolResponse": { "$ref": "GoogleCloudCesV1mainToolResponse", "description": "Optional. Tool execution response." }, "payload": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Custom payload data." }, "blob": { "description": "Optional. Blob data.", "$ref": "GoogleCloudCesV1mainBlob" }, "text": { "type": "string", "description": "Optional. Text data." }, "image": { "description": "Optional. Image data.", "$ref": "GoogleCloudCesV1mainImage" }, "updatedVariables": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct represents variables that were updated in the conversation, keyed by variable names." }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "GoogleCloudCesV1mainToolCall" }, "defaultVariables": { "type": "object", "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "id": "GoogleCloudCesV1mainChunk" }, "GoogleCloudContactcenterinsightsV1mainEntity": { "properties": { "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number", "format": "float" }, "type": { "description": "The entity type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ] }, "displayName": { "type": "string", "description": "The representative name for the entity." }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below." }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The aggregate sentiment expressed for this entity in the conversation." } }, "id": "GoogleCloudContactcenterinsightsV1mainEntity", "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", "properties": { "spreadsheetUri": { "type": "string", "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata." }, "sheetTitle": { "type": "string", "description": "Optional. The title of the new sheet to write the feedback labels to." } }, "type": "object", "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "type": "object", "description": "A suggestion chips part.", "properties": { "chips": { "description": "Optional. List of suggestion chips.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" }, "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse", "description": "The response of listing notes.", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "notes": { "description": "The notes that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "type": "object", "description": "Metadata about the QA question dimension.", "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "properties": { "sourceTitle": { "type": "string", "description": "Optional. The cited source title." }, "sourceUri": { "type": "string", "description": "Optional. The cited source URI." }, "snippet": { "type": "string", "description": "Optional. Snippet of the cited text." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "description": "A citation part." }, "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse": { "type": "object", "description": "The response to list datasets.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "datasets": { "description": "The datasets that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" } } } }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "properties": { "joinKeyResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" }, "type": "array", "description": "A list of join key correlation results for each conversation tested." }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "type": "object", "properties": { "silenceDuration": { "type": "string", "description": "Amount of time calculated to be in silence.", "format": "google-duration" }, "silencePercentage": { "type": "number", "description": "Percentage of the total conversation spent in silence.", "format": "float" } }, "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "properties": { "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" }, "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "type": "object" }, "GoogleIamV1Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "GoogleIamV1Binding", "type": "object", "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "condition": { "$ref": "GoogleTypeExpr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "items": { "type": "string" }, "type": "array", "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`." } } }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "appliedRedactionConfig": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "description": "Output only. The redaction config applied to the uploaded conversation." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." }, "analysisOperation": { "type": "string", "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" } } }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "channelTag": { "type": "integer", "format": "int32", "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated." }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "issueMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "Data specifying an issue match." }, "annotationStartBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "holdData": { "$ref": "GoogleCloudContactcenterinsightsV1mainHoldData", "description": "Data specifying a hold." }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1mainInterruptionData" }, "phraseMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "description": "Data specifying a phrase match." }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" } } }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "type": "object", "description": "Dialogflow interaction data.", "properties": { "confidence": { "format": "float", "type": "number", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "GoogleCloudCesV1mainBlob": { "description": "Represents a blob input or output in the conversation.", "type": "object", "id": "GoogleCloudCesV1mainBlob", "properties": { "data": { "format": "byte", "description": "Required. Raw bytes of the blob.", "type": "string" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "description": "A table part.", "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow" }, "description": "Optional. Table rows." }, "title": { "type": "string", "description": "Optional. Optional title for the table." }, "headers": { "description": "Optional. Table column headers.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris": { "properties": { "signedGcsAudioUris": { "description": "Output only. The signed URIs for the audio from the Cloud Storage conversation source when multiple audio files exist (e.g. multi-leg conversations).", "type": "array", "readOnly": true, "items": { "type": "string" } }, "signedGcsAudioUri": { "description": "The signed URI for the audio from the Cloud Storage conversation source.", "type": "string" }, "signedTurnLevelAudios": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "description": "The signed URI for the audio corresponding to each turn in the conversation." }, "signedDialogflowAudioUri": { "description": "The signed URI for the audio from the Dialogflow conversation source.", "type": "string" } }, "description": "Signed audio URIs for a conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "properties": { "updateTime": { "description": "Output only. The update time of the conversation.", "type": "string", "readOnly": true, "format": "google-datetime" }, "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" }, "type": "array" }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The create time of the conversation.", "readOnly": true, "type": "string" } }, "description": "The conversation transcript for the chart." }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "description": "Output only. The original request.", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "properties": { "clicked": { "type": "boolean", "description": "Indicates whether an answer or item was clicked by the human agent." }, "correctnessLevel": { "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "type": "string" }, "displayed": { "type": "boolean", "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI." } } }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime" }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "format": "google-duration", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput", "properties": { "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" }, "generatorName": { "type": "string", "description": "The resource name of associated generator. Format: `projects//locations//generators/`" }, "querySource": { "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "description": "Query source for the answer.", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "type": "string" } }, "description": "Explicit input used for generating the answer", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "type": "object", "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } }, "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "description": "The request to sample conversations to a dataset.", "properties": { "destinationDataset": { "$ref": "GoogleCloudContactcenterinsightsV1mainDataset", "description": "The dataset resource to copy the sampled conversations to." }, "parent": { "type": "string", "description": "Required. The parent resource of the dataset." }, "sampleRule": { "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule", "description": "Optional. The sample rule used for sampling conversations." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart", "properties": { "products": { "description": "Optional. List of products.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "type": "array" } }, "description": "A product collection part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn.", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "properties": { "issueDisplayName": { "type": "string", "description": "The issue display name." }, "issueModelId": { "type": "string", "description": "The parent issue model ID." }, "issueId": { "description": "The issue ID.", "type": "string" } }, "description": "Metadata about the issue dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "type": "object", "properties": { "totalFilesWritten": { "type": "integer", "format": "int32", "description": "Total number of files written to the provided Cloud Storage bucket." }, "fileNames": { "description": "Output only. Full name of the files written to Cloud storage.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "processedObjectCount": { "format": "int32", "description": "The number of objects processed during the download operation.", "type": "integer" }, "successfulDownloadCount": { "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", "type": "integer", "format": "int32" } }, "description": "Statistics for BulkDownloadFeedbackLabels operation." }, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "properties": { "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "format": "float", "type": "number" }, "displayName": { "type": "string", "description": "The representative name for the entity." }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "The aggregate sentiment expressed for this entity in the conversation." }, "type": { "description": "The entity type.", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ], "type": "string" }, "metadata": { "type": "object", "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "additionalProperties": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "description": "Google Cloud Storage Object URI to save the issue model to.", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer", "properties": { "query": { "type": "string", "description": "Query text. Article Search uses this to store the input query used to generate the search results." }, "querySource": { "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "type": "string", "description": "Query source for the answer." }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "properties": { "transcriptSegments": { "type": "array", "description": "A list of sequential transcript segments that comprise the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint." }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "type": "object", "properties": { "conversationProfileId": { "type": "string", "description": "Optional. The conversation profile ID." } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote": { "description": "A note about the entire parent assessment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time at which the analysis ended." } }, "description": "The result of an analysis.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "properties": { "numValue": { "type": "number", "format": "double", "description": "Numerical value." }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`." }, "score": { "type": "number", "format": "double", "description": "Output only. Numerical score of the answer.", "readOnly": true }, "normalizedScore": { "format": "double", "type": "number", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "readOnly": true }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "skipValue": { "type": "boolean", "description": "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.", "readOnly": true }, "strValue": { "description": "String value.", "type": "string" }, "key": { "type": "string", "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key." }, "potentialScore": { "format": "double", "type": "number", "readOnly": true, "description": "Output only. The maximum potential score of the question." } }, "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { "type": "object", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "properties": { "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Update time of the label.", "readOnly": true }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "description": "QaAnswer label used for Quality AI example conversations." }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "labeledResource": { "description": "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}`", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the label.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats", "type": "object", "description": "Aggregated statistics about an issue.", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "format": "int64", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", "type": "object", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest": { "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } }, "description": "The request for deleting a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "type": "object", "properties": { "runtimeIntegrationAnalysisPercentage": { "format": "double", "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "type": "number" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "uploadConversationAnalysisPercentage": { "format": "double", "type": "number", "description": "Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100]." } }, "description": "Default configuration when creating Analyses in Insights." }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "type": "string", "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Whether this resource is zone separated.", "readOnly": true }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "properties": { "agentChannel": { "format": "int32", "type": "integer", "description": "The audio channel that contains the agent." }, "customerChannel": { "type": "integer", "description": "The audio channel that contains the customer.", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "description": "Call-specific metadata.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "description": "Configs for the input data used to create the issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "properties": { "medium": { "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "deprecated": true, "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "readOnly": true, "description": "Output only. Number of conversations used in training. Output only.", "format": "int64", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView": { "properties": { "conversationFilter": { "type": "string", "description": "A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has." }, "createTime": { "type": "string", "description": "Output only. The time at which the authorized view was created.", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "Display Name. Limit 64 characters." }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The most recent time at which the authorized view was updated.", "format": "google-datetime" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string" }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true } }, "type": "object", "description": "An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.", "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "type": "object", "properties": { "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "updateTime": { "type": "string", "description": "The metrics last update time.", "format": "google-datetime" }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "slices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, "type": "array", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request." } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "description": "The metadata for querying performance overview.", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "type": "object", "description": "The data for an issue match annotation.", "properties": { "issueAssignment": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment", "description": "Information about the issue's assignment." } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation.", "properties": { "successfulSampleCount": { "format": "int32", "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "readOnly": true }, "failedSampleCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field." } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "description": "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", "type": "string" } }, "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "description": "The response to deploy an issue model.", "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage", "properties": { "textOutput": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "description": "A direct natural language response to the user message." }, "generatedSqlQuery": { "type": "string", "description": "Raw SQL from LLM, before templatization" }, "chartSpec": { "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system." }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "type": "object", "properties": { "suggestion": { "type": "string", "description": "The content of the suggestion." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "type": "number", "description": "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).", "format": "double" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "properties": { "failedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that failed correlation." }, "sampledConversationsCount": { "type": "integer", "description": "The number of conversations sampled.", "format": "int32" }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "format": "int32", "type": "integer" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata", "description": "Metadata for an export insights operation.", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "description": "The original request for export." }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "failedExportCount": { "format": "int32", "description": "The number of conversations that failed to be exported.", "type": "integer" }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion", "description": "A single question to be scored by the Insights QA feature.", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The most recent time at which the question was updated." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time at which this question was created." }, "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "predefinedQuestionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig", "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined." }, "answerChoices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" }, "type": "array", "description": "A list of valid answers to the question, which the LLM must choose from." }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone separated." }, "name": { "type": "string", "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}" }, "questionType": { "enum": [ "QA_QUESTION_TYPE_UNSPECIFIED", "CUSTOMIZABLE", "PREDEFINED" ], "description": "The type of question.", "type": "string", "enumDescriptions": [ "The type of the question is unspecified.", "The default question type. The question is fully customizable by the user.", "The question type is using a predefined model provided by CCAI teams. Users are not allowed to edit the question_body, answer_choices, upload feedback labels for the question nor fine-tune the question. However, users may edit other fields like question tags, question order, etc." ] }, "order": { "format": "int32", "description": "Defines the order of the question within its parent scorecard revision.", "type": "integer" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" }, "answerInstructions": { "type": "string", "description": "Instructions describing how to determine the answer." }, "abbreviation": { "type": "string", "description": "Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., \"Greeting\"." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "metrics": { "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question." }, "tuningMetadata": { "description": "Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { "type": "object", "description": "Options for configuring what metadata is included in the conversation data used in QAI and Discovery Engine.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions", "properties": { "includeDialogflowInteractionData": { "type": "boolean", "description": "Whether to include the per turn Dialogflow interaction data in conversation transcript." } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "properties": { "partialErrors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "ingestConversationsStats": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Output only. Statistics for IngestConversations operation.", "readOnly": true }, "sampledConversations": { "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true, "items": { "type": "string" }, "type": "array" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "description": "Output only. The original request for ingest." } }, "description": "The metadata for an IngestConversations operation." }, "GoogleIamV1AuditConfig": { "properties": { "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." }, "auditLogConfigs": { "type": "array", "items": { "$ref": "GoogleIamV1AuditLogConfig" }, "description": "The configuration for logging of each type of permission." } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object", "id": "GoogleIamV1AuditConfig" }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource", "type": "object", "description": "Google Sheets document details to get the feedback label file from.", "properties": { "spreadsheetUri": { "type": "string", "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA." } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote": { "id": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote", "description": "A note about a QA question.", "type": "object", "properties": { "qaQuestion": { "type": "string", "description": "The question resource that the note is associated with." } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" } }, "description": "Metadata for creating an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "description": "Average QA normalized score for the tag.", "properties": { "averageTagNormalizedScore": { "format": "double", "description": "Average tag normalized score per tag.", "type": "number" }, "tag": { "type": "string", "description": "Tag name." } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "properties": { "qaQuestionIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional." }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The most recent time at which the question tag was updated." }, "name": { "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. The time at which the question tag was created.", "format": "google-datetime" }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone separated." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "displayName": { "type": "string", "description": "Required. A user-specified display name for the tag." } }, "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference.", "properties": { "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, "table": { "type": "string", "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error." }, "dataset": { "description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1Settings": { "type": "object", "description": "The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) and change the settings with [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).", "properties": { "conversationTtl": { "type": "string", "description": "The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.", "format": "google-duration" }, "analysisConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "description": "Default analysis settings." }, "timeZone": { "type": "string", "description": "Optional. The time zone applied to the project. This is a string representation of the time zone, for example, \"America/New_York\". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the settings was created." }, "redactionConfig": { "description": "Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the settings were last updated." }, "languageCode": { "description": "A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to \"en-US\" if it is neither specified on the segment nor here.", "type": "string" }, "speechConfig": { "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "diagnosticMetricConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "description": "Optional. Configuration for diagnostic metrics." }, "pubsubNotificationSettings": { "type": "object", "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. * \"update-or-analyze-conversation\": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "additionalProperties": { "type": "string" } }, "screenRecordingBucketUri": { "type": "string", "description": "Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field." }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "properties": { "table": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "dataset": { "type": "string", "description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error." }, "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" } }, "description": "A BigQuery Table Reference.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "type": "object", "properties": { "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" }, "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule." }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "type": "object", "properties": { "dataPoints": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series ." } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "type": "object", "properties": { "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "The issue model that was imported." } }, "description": "Response from import issue model", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1Widget": { "id": "GoogleCloudContactcenterinsightsV1alpha1Widget", "type": "object", "properties": { "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "chart": { "description": "A chart widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "chartReference": { "type": "string", "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}" }, "container": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container", "description": "A container widget." } }, "description": "Represents a dashboard element, could be a nested Container or Chart." }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "type": "string", "description": "The next page token." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", "type": "object", "description": "The response for listing feedback labels." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "properties": { "cells": { "items": { "type": "string" }, "type": "array", "description": "Optional. The cell values in the row." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow", "description": "A row in a table." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "type": "object", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "description": "The request to sample conversations to a dataset." }, "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote": { "description": "A note about a conversation turn.", "properties": { "turnIndex": { "format": "int32", "type": "integer", "description": "The conversation turn index that the note is associated with." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation": { "type": "object", "description": "The conversation used to generate the chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation", "properties": { "messages": { "type": "array", "description": "Ordered list of messages, including user inputs and system responses.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "updateTime": { "description": "The update time of the conversation.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "description": "The create time of the conversation.", "format": "google-datetime" } } }, "GoogleCloudCesV1mainImage": { "type": "object", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" }, "altText": { "type": "string", "description": "Optional. The alternative text for the image." }, "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" } }, "id": "GoogleCloudCesV1mainImage", "description": "Represents an image input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig": { "properties": { "absoluteDateRange": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "An absolute date range." }, "relativeDateRange": { "description": "A relative date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange" } }, "description": "Date range configuration for dashboard charts.", "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "description": "A thought part.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "type": "object", "properties": { "text": { "type": "string", "description": "Optional. The thought or reasoning text." } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "type": "object", "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse", "type": "object", "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "description": "The CES end session annotation.", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "properties": { "dataPoints": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series ." } }, "description": "A time series of metric values.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest", "description": "Request to stream chat.", "properties": { "message": { "description": "Required. The message to send to the assistant.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "type": "object", "properties": { "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" } }, "conversation": { "type": "string", "description": "The conversation resource name." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "properties": { "textType": { "type": "string", "description": "The type of text output.", "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] }, "text": { "description": "The text output from the LLM.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult", "type": "object", "properties": { "conversation": { "type": "string", "description": "The conversation resource name." }, "ruleResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule." } } }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`" } }, "id": "GoogleIamV1SetIamPolicyRequest" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "properties": { "relabel": { "description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "deprecated": true, "type": "boolean" }, "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "filter": { "type": "string", "description": "Required. Filter used to select the subset of conversations to analyze." }, "parent": { "type": "string", "description": "Required. The parent resource to create analyses in." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1QueryInterval": { "description": "A time window for querying conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "properties": { "startTime": { "format": "google-datetime", "description": "Required. The start time of the time window.", "type": "string" }, "endTime": { "description": "Required. The end time of the time window.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." }, "confidenceScore": { "description": "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).", "type": "number", "format": "float" }, "metadata": { "type": "object", "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "question": { "type": "string", "description": "The corresponding FAQ question." }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}." } }, "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "id": "GoogleLongrunningListOperationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "type": "object", "properties": { "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "description": "Google Cloud Storage source message." } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest", "description": "Request to import an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "description": "Information about an agent involved in the conversation.", "properties": { "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "entrySubagentDisplayName": { "type": "string", "description": "The entry subagent's display name." }, "team": { "type": "string", "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field." }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "teams": { "type": "array", "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" } }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "deploymentDisplayName": { "type": "string", "description": "The agent's deployment display name. Only applicable to automated agents." }, "versionId": { "type": "string", "description": "The agent's version ID. Only applicable to automated agents." }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." }, "location": { "description": "The agent's location.", "type": "string" }, "agentType": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult", "type": "object", "description": "The result of a single correlation rule.", "properties": { "correlationId": { "type": "string", "description": "The correlation ID generated by the join key expression." }, "ruleId": { "type": "string", "description": "The rule ID." }, "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the join key expression failed to evaluate." } } }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running." }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { "type": "object", "description": "The metadata from querying metrics.", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "description": "A list part.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart", "properties": { "listType": { "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ], "description": "Optional. The type of list.", "type": "string" }, "items": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "description": "Optional. List items.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1QaQuestionTag": { "id": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "type": "object", "properties": { "updateTime": { "type": "string", "readOnly": true, "description": "Output only. The most recent time at which the question tag was updated.", "format": "google-datetime" }, "satisfiesPzs": { "description": "Output only. Whether this resource is zone separated.", "type": "boolean", "readOnly": true }, "displayName": { "type": "string", "description": "Required. A user-specified display name for the tag." }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Whether this resource is zone isolated.", "readOnly": true }, "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "items": { "type": "string" }, "type": "array" }, "name": { "type": "string", "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the question tag was created." } }, "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "properties": { "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" }, "description": "List of all individual score sets.", "type": "array" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "qaTagResults": { "type": "array", "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" } }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist." }, "name": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "format": "double", "type": "number" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp that the revision was created.", "type": "string", "format": "google-datetime" }, "score": { "type": "number", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "format": "double" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" } }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource": { "properties": { "agentId": { "type": "string", "description": "Required. Agent id to query performance overview for." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource", "type": "object", "description": "The entity whose performance is being queried is a single agent." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "properties": { "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" }, "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse", "description": "The response for generative insights." }, "GoogleCloudContactcenterinsightsV1alpha1Dimension": { "type": "object", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", "properties": { "issueDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" }, "qaScorecardDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Output only. Metadata about the QA scorecard dimension." }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" }, "mediumDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension." }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension." }, "qaQuestionAnswerDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension." }, "conversationProfileDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the conversation profile dimension." }, "qaQuestionDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the QA question dimension." }, "dimensionKey": { "type": "string", "description": "The key of the dimension.", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ] }, "conversationalAgentsPlaybookDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "GoogleIamV1TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "type": "object", "id": "GoogleIamV1TestIamPermissionsRequest", "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "type": "object", "properties": { "correlationTypes": { "items": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] }, "readOnly": true, "description": "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.", "type": "array" }, "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" }, "mergedFullConversationCorrelationId": { "type": "string", "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a merged conversation of." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "description": "Info for correlating across conversations." }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", "properties": { "endTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest", "description": "The original request for undeployment." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." } }, "type": "object", "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse", "type": "object", "properties": { "phraseMatchers": { "description": "The phrase matchers that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "The response of listing phrase matchers." }, "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "id": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "type": "object", "properties": { "labelKey": { "type": "string", "description": "Optional. The label key." }, "labelValue": { "description": "Optional. The label value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "properties": { "type": { "type": "string", "description": "The type of the entity mention.", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ] }, "entityUniqueId": { "type": "string", "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to." }, "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { "description": "The request to create an issue model.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "description": "Required. The issue model to create." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "type": "object", "description": "Metadata for deploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", "description": "The original request for deployment." } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "type": "object", "properties": { "percentileLlmCallLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileAudioInAudioOutLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level." }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "properties": { "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "type": "integer", "description": "The number of conversations transferred to a human agent.", "format": "int32" }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "aiCoachSuggestionMessageTriggerRatio": { "type": "number", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "double" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "format": "double", "type": "number" }, "knowledgeSearchNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback." }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback." }, "knowledgeSearchUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations scanned by the AA human supervisor." }, "averageDuration": { "description": "The average duration.", "format": "google-duration", "type": "string" }, "knowledgeSearchResultCount": { "format": "int32", "type": "integer", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user." }, "averageCustomerSatisfactionRating": { "format": "double", "type": "number", "description": "The average customer satisfaction rating." }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "int32" }, "summarizationSuggestionEditRatio": { "type": "number", "description": "Proportion of summarization suggestions that were manually edited.", "format": "double" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "format": "double", "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number" }, "conversationCount": { "type": "integer", "format": "int32", "description": "The conversation count." }, "conversationalAgentsAverageLlmCallLatency": { "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "format": "double", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, "averageClientSentimentScore": { "type": "number", "format": "float", "description": "The average client's sentiment score." }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "format": "int32", "type": "integer" }, "aaSupervisorAssignedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor." }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "format": "double", "type": "number" }, "averageQaNormalizedScore": { "format": "double", "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number" }, "knowledgeSearchAgentQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "averageSummarizationSuggestionNormalizedEditDistance": { "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", "format": "double", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "averageSummarizationSuggestionEditDistance": { "type": "number", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "format": "double" }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "format": "double", "type": "number" }, "conversationalAgentsAverageTtsLatency": { "format": "double", "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number" }, "containedConversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were contained." }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "conversationAiCoachSuggestionCount": { "type": "integer", "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions." }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "format": "float", "type": "number" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "type": "number", "description": "Proportion of conversations that has Ai Coach Suggestions.", "format": "double" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "format": "double", "type": "number" }, "qaTagScores": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags.", "type": "array" }, "conversationalAgentsAverageEndToEndLatency": { "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number", "format": "double" }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer" }, "dialogflowWebhookFailureRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that failed.", "type": "number" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "knowledgeSearchSuggestedQuerySourceRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made." }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "avgConversationClientTurnSentimentEma": { "format": "double", "type": "number", "description": "The exponential moving average of the sentiment score of client turns in the conversation." }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "format": "int32", "type": "integer" }, "knowledgeAssistNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number" }, "averageQaQuestionNormalizedScore": { "type": "number", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", "format": "double" } }, "type": "object", "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig", "properties": { "exactMatchConfig": { "description": "The configuration for the exact match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig" }, "regexMatchConfig": { "description": "The configuration for the regex match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig" } }, "description": "Configuration information of a phrase match rule." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart", "description": "A product collection part.", "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "description": "Optional. List of products." } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "type": "object", "description": "The request to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "type": "object", "description": "Response from import issue model", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse", "properties": { "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel", "description": "The issue model that was imported." } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "description": "Metadata about the QA question dimension.", "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "partialErrors": { "type": "array", "readOnly": true, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "totalRequestedAnalysesCount": { "type": "integer", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "format": "int32" }, "relabel": { "readOnly": true, "deprecated": true, "description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "format": "int32", "type": "integer" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "createTime": { "type": "string", "description": "The time the operation was created.", "format": "google-datetime" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse": { "description": "The response from a ListAuthorizedViewSet request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse", "properties": { "authorizedViewSets": { "description": "The AuthorizedViewSets under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "type": "object", "description": "A Cloud Storage source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "properties": { "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUris": { "description": "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).", "type": "array", "items": { "type": "string" } }, "audioUri": { "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "deprecated": true, "type": "string" } } }, "GoogleCloudContactcenterinsightsV1Analysis": { "properties": { "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone isolated." }, "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" }, "satisfiesPzs": { "description": "Output only. Whether this resource is zone separated.", "readOnly": true, "type": "boolean" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "format": "google-datetime" }, "requestTime": { "type": "string", "readOnly": true, "description": "Output only. The time at which the analysis was requested.", "format": "google-datetime" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "analysisResult": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true } }, "description": "The analysis resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1Analysis" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "type": "object", "description": "Container for a list of scorecards.", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "properties": { "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "conversation": { "type": "string", "readOnly": true, "description": "Output only. The Conversation that this Analysis Operation belongs to." } }, "description": "Metadata for a create analysis operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { "properties": { "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "uri": { "type": "string", "description": "Article URI." }, "title": { "description": "Article title.", "type": "string" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "confidenceScore": { "type": "number", "format": "float", "description": "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)." } }, "description": "Agent Assist Article Suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "properties": { "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest", "description": "The original request for undeployment." } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "type": "object", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "description": "The original import request." }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", "description": "Metadata used for import issue model." }, "GoogleIamV1Policy": { "type": "object", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "GoogleIamV1Policy", "properties": { "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "GoogleIamV1Binding" }, "type": "array" }, "etag": { "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte" }, "version": { "format": "int32", "type": "integer", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "auditConfigs": { "type": "array", "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "GoogleIamV1AuditConfig" } } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources.", "properties": { "customMetadataKeys": { "items": { "type": "string" }, "type": "array", "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation." }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "bucketObjectType": { "type": "string", "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ] }, "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "type": "object", "properties": { "transcriptSegments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" }, "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array" } }, "description": "A message representing the transcript of a conversation." }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "description": "The request for deleting a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } } }, "GoogleCloudContactcenterinsightsV1mainConversation": { "properties": { "dialogflowIntents": { "type": "object", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "description": "The source of the audio and transcription for the conversation." }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "medium": { "description": "Immutable. The conversation medium.", "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "latestAnalysis": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis", "description": "Output only. The conversation's latest analysis, if one exists." }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "metadataJson": { "type": "string", "description": "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." }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string", "format": "google-duration" }, "duration": { "readOnly": true, "format": "google-duration", "description": "Output only. The duration of the conversation.", "type": "string" }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone isolated." }, "runtimeAnnotations": { "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "readOnly": true }, "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "correlationInfo": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "description": "Output only. Info for correlating across conversations." }, "labels": { "description": "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "createTime": { "description": "Output only. The time at which the conversation was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "turnCount": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The number of turns in the conversation." }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time at which the conversation started." }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "readOnly": true, "type": "string" }, "expireTime": { "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversation", "type": "object", "description": "The conversation resource." }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "type": "object", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { "description": "The request to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "properties": { "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "confidence": { "description": "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.", "type": "number", "format": "float" }, "endOffset": { "type": "string", "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation." }, "startOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the start of this word relative to the beginning of the total conversation." } }, "description": "Word-level info for words in a transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "Required. The issue model to create." } }, "description": "The request to create an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "type": "object", "description": "Metadata about the QA scorecard dimension." }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", "description": "The response to deploy an issue model.", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource", "type": "object", "properties": { "dialogflowConversation": { "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "readOnly": true, "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "description": "A link part.", "properties": { "uri": { "description": "Optional. Target URI.", "type": "string" }, "text": { "description": "Optional. Anchor or display text.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "type": "object", "description": "The metadata for an SampleConversations operation.", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "readOnly": true, "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest", "properties": { "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssue" }, "parent": { "type": "string", "description": "Required. The parent resource of the issue." } }, "type": "object", "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "properties": { "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "audioBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`." }, "bucketObjectType": { "type": "string", "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ] }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "customMetadataKeys": { "type": "array", "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "items": { "type": "string" } } }, "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" } }, "description": "Metadata for deploying an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse": { "description": "The response of listing charts.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse", "properties": { "charts": { "description": "The charts under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The value returned by the last `ListChartsResponse`. This value indicates that this is a continuation of a prior `ListCharts` call and that the system should return the next page of data." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "properties": { "medium": { "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Required. The medium transcript objects represent.", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "type": "string" } }, "description": "Configuration for processing transcript objects." }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "type": "object", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "properties": { "scorecardList": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "description": "A manual list of scorecards to score." } }, "type": "object", "description": "Configuration for the QA feature.", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse": { "description": "The response from a ListQaScorecardRevisions request.", "properties": { "qaScorecardRevisions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "The QaScorecards under the parent." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" }, "GoogleCloudContactcenterinsightsV1mainFeedbackLabel": { "properties": { "label": { "type": "string", "description": "String label used for Topic Modeling." }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "QaAnswer label used for Quality AI example conversations." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string" }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "readOnly": true, "type": "boolean" }, "createTime": { "description": "Output only. Create time of the label.", "format": "google-datetime", "readOnly": true, "type": "string" }, "labeledResource": { "type": "string", "description": "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}`" }, "satisfiesPzs": { "description": "Output only. Whether this resource is zone separated.", "readOnly": true, "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel", "type": "object", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization." }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "properties": { "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "readOnly": true }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true }, "analysisOperation": { "readOnly": true, "type": "string", "description": "Output only. The operation name for a successfully created analysis operation, if any." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "type": "object", "properties": { "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" }, "teams": { "type": "array", "items": { "type": "string" }, "description": "User-specified strings representing the agent's teams." }, "location": { "type": "string", "description": "The agent's location." }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "deploymentId": { "type": "string", "description": "The agent's deployment ID. Only applicable to automated agents." }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "team": { "type": "string", "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field." }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "versionDisplayName": { "type": "string", "description": "The agent's version display name. Only applicable to automated agents." }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "agentType": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The agent type, e.g. HUMAN_AGENT." }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." } }, "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" } }, "description": "Metadata for creating an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" }, "endTime": { "type": "string", "description": "The time at which the analysis ended.", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "description": "The result of an analysis.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Dashboard": { "type": "object", "description": "Configurable dashboard", "properties": { "readOnly": { "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.", "type": "boolean", "readOnly": true }, "displayName": { "description": "User provided display name of the dashboard.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}" }, "description": { "description": "Dashboard description", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dashboard creation time." }, "filter": { "type": "string", "description": "Filter applied to all charts in the dashboard. Should support scope later." }, "rootContainer": { "description": "The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "dateRangeConfig": { "description": "Date range config applied to all charts in the dashboard.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Dashboard last update time." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult", "properties": { "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" } }, "conversation": { "description": "The conversation resource name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "properties": { "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" } }, "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1EntityMentionData": { "id": "GoogleCloudContactcenterinsightsV1EntityMentionData", "type": "object", "properties": { "type": { "description": "The type of the entity mention.", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "type": "string", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ] }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "Sentiment expressed for this mention of the entity." }, "entityUniqueId": { "type": "string", "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to." } }, "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo": { "properties": { "endTime": { "type": "string", "description": "End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.", "format": "google-datetime" }, "schedule": { "type": "string", "description": "The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ..." }, "startTime": { "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created.", "type": "string", "format": "google-datetime" }, "timeZone": { "description": "The timezone to use for the groc expression. If not specified, defaults to UTC.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo", "description": "Message for schedule info." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "properties": { "maxDeleteCount": { "type": "integer", "description": "Maximum number of conversations to delete.", "format": "int32" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "force": { "type": "boolean", "description": "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." }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk." }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "properties": { "intents": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "description": "All the matched intents in the call." }, "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" }, "description": "A list of call annotations that apply to this call.", "type": "array" }, "sentiments": { "type": "array", "description": "Overall conversation-level sentiment for each channel of the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" } }, "qaScorecardResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" }, "description": "Results of scoring QaScorecards." }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "type": "object" }, "silence": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" } } }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "type": "object", "description": "The CES end session annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "properties": { "magnitude": { "type": "number", "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score." }, "score": { "format": "float", "type": "number", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." } }, "description": "The data for a sentiment annotation." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "properties": {}, "description": "Response for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object", "description": "The response of testing correlation config.", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse" }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "properties": { "potentialScore": { "type": "number", "format": "double", "description": "The potential score the tag applies to." }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "format": "double", "description": "The score the tag applies to.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "description": "Tags and their corresponding results.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse", "description": "The response of testing correlation config.", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse": { "properties": { "statusMessage": { "description": "A status message.", "type": "string" }, "chunk": { "description": "A chunk of the assistant response message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk" }, "eventId": { "type": "string", "description": "The unique ID of the event." }, "eventTime": { "format": "google-datetime", "type": "string", "description": "The time when the event occurred." } }, "type": "object", "description": "Response from streaming chat.", "id": "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "properties": { "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runSilenceAnnotator": { "type": "boolean", "description": "Whether to run the silence annotator." }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "runSummarizationAnnotator": { "type": "boolean", "description": "Whether to run the summarization annotator." }, "runAutoLabelingAnnotator": { "description": "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.", "type": "boolean" }, "runSentimentAnnotator": { "type": "boolean", "description": "Whether to run the sentiment annotator." }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "phraseMatchers": { "items": { "type": "string" }, "description": "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}", "type": "array" }, "runInterruptionAnnotator": { "type": "boolean", "description": "Whether to run the interruption annotator." }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "issueModels": { "type": "array", "items": { "type": "string" }, "description": "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." }, "runEntityAnnotator": { "type": "boolean", "description": "Whether to run the entity annotator." } }, "type": "object", "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ] }, "generator": { "type": "string", "description": "The resource name of the existing created generator. Format: projects//locations//generators/" } } }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "properties": { "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "format": "google-fieldmask", "type": "string" }, "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "properties": { "metadataUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation metadata." }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1GcsSource" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource" }, "turnLevelAudios": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" } } }, "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest": { "properties": { "agentPerformanceSource": { "description": "Conversations are from a single agent.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource" }, "filter": { "description": "Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.", "type": "string" }, "queryInterval": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "Required. The time window of the conversations to derive performance stats from." }, "comparisonQueryInterval": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "The time window of the conversations to compare the performance to." } }, "description": "The request for summarizing performance according to different metrics for conversations over a specified time window.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint": { "type": "object", "description": "The current chart checkpoint state.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint", "properties": { "sessionId": { "description": "The session id of the chart.", "type": "string" }, "revisionId": { "description": "The revision id of the chart.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p99": { "format": "double", "description": "The 99th percentile value.", "type": "number" }, "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p90": { "type": "number", "description": "The 90th percentile value.", "format": "double" } }, "type": "object", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart": { "type": "object", "properties": { "productCollection": { "description": "Optional. Product collection or carousel.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "image": { "description": "Optional. Image media.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "customPayload": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "description": "Optional. Generic custom structured payload." }, "citation": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "description": "Optional. Citation or reference to grounding material." }, "suggestionChips": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "description": "Optional. Suggestion chips or interactive buttons." }, "table": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "description": "Optional. Tabular data." }, "thought": { "description": "Optional. Model thought or internal reasoning.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart" }, "link": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "description": "Optional. Web link or URL." }, "video": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "Optional. Video media." }, "list": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart", "description": "Optional. Ordered or unordered list." }, "text": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "description": "Optional. Plain text content." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart", "description": "A structured component/part of a transcript segment." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "type": "object", "description": "Aggregated statistics about an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "properties": { "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64", "type": "string" }, "unclassifiedConversationsCount": { "type": "string", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "format": "int64" }, "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "type": "object", "properties": { "request": { "description": "Output only. The original request for delete.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during deletion operation that might cause the operation output to be incomplete." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "type": "object", "properties": { "downloadStats": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true }, "partialErrors": { "type": "array", "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request for download.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" } }, "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "properties": { "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "parent": { "type": "string", "description": "Required. The parent resource for new conversations." }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." } }, "description": "The request to ingest conversations.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "type": "object" }, "GoogleCloudCesV1mainToolCall": { "type": "object", "properties": { "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" }, "tool": { "type": "string", "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "agentName": { "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.", "readOnly": true, "type": "string" }, "parentToolCallId": { "type": "string", "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.", "readOnly": true }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "GoogleCloudCesV1mainToolsetTool" }, "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } }, "description": "Request for the client or the agent to execute the specified tool.", "id": "GoogleCloudCesV1mainToolCall" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "type": "object", "description": "The metadata for a bulk analyze conversations operation.", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "totalRequestedAnalysesCount": { "format": "int32", "type": "integer", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "completedAnalysesCount": { "type": "integer", "format": "int32", "description": "The number of requested analyses that have completed successfully so far." }, "relabel": { "type": "boolean", "readOnly": true, "deprecated": true, "description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations." }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "readOnly": true }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "failedAnalysesCount": { "format": "int32", "type": "integer", "description": "The number of requested analyses that have failed so far." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage": { "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "description": "For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "format": "google-datetime" }, "systemMessage": { "description": "A message from the system in response to the user.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage" }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage" } }, "description": "The message in the conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart", "properties": { "listType": { "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "description": "Optional. The type of list.", "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ], "type": "string" }, "items": { "description": "Optional. List items.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem" } } }, "description": "A list part." }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "properties": { "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer", "format": "int32" }, "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "description": "Request to upload a conversation.", "type": "object", "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" }, "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation", "description": "Required. The conversation resource to create." }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" } } }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "properties": {}, "description": "The data for an interruption annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "type": "object", "description": "Configuration for summarization.", "properties": { "summarizationModel": { "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ] }, "generator": { "type": "string", "description": "The resource name of the existing created generator. Format: projects//locations//generators/" }, "conversationProfile": { "type": "string", "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "type": "object", "properties": { "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "sqlQuery": { "type": "string", "description": "SQL query used to generate the chart." }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec for the chart.", "type": "object" }, "chartConversations": { "readOnly": true, "deprecated": true, "description": "Output only. The chart conversations used to generate the chart.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" }, "type": "array" }, "request": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "sqlComparisonKey": { "type": "string", "description": "Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset." } }, "description": "Request that use natural language query to generate the chart." }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "properties": { "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "confidenceScore": { "description": "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).", "type": "number", "format": "float" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from." }, "uri": { "description": "Article URI.", "type": "string" }, "title": { "type": "string", "description": "Article title." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } } }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "description": "Information about the issue.", "type": "object", "properties": { "score": { "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "type": "object", "description": "Metadata about the QA question dimension.", "properties": { "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "properties": { "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "metadata": { "type": "object", "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" } }, "title": { "description": "Article title.", "type": "string" }, "confidenceScore": { "description": "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).", "format": "float", "type": "number" }, "uri": { "type": "string", "description": "Article URI." }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" } } }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig": { "type": "object", "properties": { "correlationRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" }, "description": "A list of correlation rules to be evaluated for correlation.", "type": "array" } }, "description": "A list of correlation rules for a given correlation type.", "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "properties": { "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone isolated." }, "kmsKey": { "type": "string", "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "name": { "type": "string", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse", "properties": { "generatedSqlQuery": { "type": "string", "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource." }, "textOutput": { "type": "string", "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "deprecated": true }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format." }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput", "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response." } }, "type": "object", "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudContactcenterinsightsV1alpha1Assessment": { "properties": { "agentInfo": { "description": "Information about the agent the assessment is for.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time at which the assessment was last updated." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time at which the assessment was created.", "format": "google-datetime" }, "state": { "enum": [ "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED", "APPEALED", "FINALIZED" ], "readOnly": true, "description": "Output only. The state of the assessment.", "enumDescriptions": [ "The state is unspecified. This value should not be used.", "The default state of all new assessments.", "The assessment has been published.", "The assessment has been appealed.", "The assessment has been finalized." ], "type": "string" }, "name": { "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", "type": "string" } }, "description": "The assessment resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Assessment", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { "type": "object", "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "properties": { "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentVersionDisplayName": { "type": "string", "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "agentDisplayName": { "type": "string", "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "agentDeploymentDisplayName": { "type": "string", "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions." }, "agentDeploymentId": { "type": "string", "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions." } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "properties": { "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" }, "segmentParticipant": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant", "description": "The participant of this segment." }, "dialogflowSegmentMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "CCAI metadata relating to the current transcript segment." }, "channelTag": { "type": "integer", "format": "int32", "description": "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." }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "parts": { "description": "Optional. The structured parts that make up this transcript segment.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart" }, "type": "array" }, "text": { "description": "The text of this segment.", "type": "string" }, "confidence": { "format": "float", "description": "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.", "type": "number" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage", "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "properties": { "userProvidedChartSpec": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. User provided chart spec" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "chartSpec": { "type": "object", "description": "Chart spec from LLM", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "properties": { "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest", "description": "The original request for creation." } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" }, "type": "array" }, "constraintResults": { "type": "array", "description": "A list of constraint evaluation results for each pair of conversations.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" } } }, "description": "Wrapper for detailed, step-by-step results.", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "description": "Information about the issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "properties": { "score": { "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "format": "double", "type": "number" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "type": "object", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "properties": { "phraseMatcher": { "type": "string", "description": "The unique identifier (the resource name) of the phrase matcher." }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "properties": { "p90": { "format": "double", "description": "The 90th percentile value.", "type": "number" }, "p50": { "description": "The 50th percentile value.", "format": "double", "type": "number" }, "p99": { "format": "double", "type": "number", "description": "The 99th percentile value." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule": { "description": "The data for a phrase match rule.", "type": "object", "properties": { "config": { "description": "Provides additional information about the rule that specifies how to apply the rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig" }, "negated": { "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", "type": "boolean" }, "query": { "description": "Required. The phrase to be matched.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "type": "object", "description": "The metadata for a bulk delete conversations operation.", "properties": { "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "description": "Agent Assist Smart Reply data.", "properties": { "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "reply": { "description": "The content of the reply.", "type": "string" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "confidenceScore": { "type": "number", "format": "double", "description": "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)." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "type": "object", "description": "Metadata about the conversation profile dimension.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "type": "string", "description": "Optional. The conversation profile ID." } } }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation", "description": "An annotation that was generated during the customer and agent interaction.", "properties": { "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData" }, "answerFeedback": { "$ref": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "description": "The feedback that the customer has about the answer in `data`." }, "cesEndSessionAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "description": "The CES end session annotation." }, "startBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "faqAnswer": { "$ref": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "description": "Agent Assist FAQ answer data." }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "dialogflowInteraction": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "description": "Dialogflow interaction data." }, "userInput": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "description": "Response from export issue model", "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "properties": { "dataset": { "type": "string", "description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error." }, "table": { "type": "string", "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error." }, "projectId": { "type": "string", "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used." } }, "type": "object", "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition": { "properties": { "value": { "type": "string", "description": "CEL expression to be evaluated as the value." }, "condition": { "type": "string", "description": "A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition", "description": "Condition for auto-labeling conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "type": "object", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete." }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "type": "object", "properties": { "alternativeText": { "description": "Optional. Alternative text description.", "type": "string" }, "uri": { "description": "Optional. URI or URL to the media.", "type": "string" } }, "description": "A media part.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "type": "object", "properties": { "chips": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "type": "array", "description": "Optional. List of suggestion chips." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "description": "A suggestion chips part." }, "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest": { "type": "object", "description": "The request to deploy a QaScorecardRevision", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "description": "Metadata for creating an issue model.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "description": "The original request for creation." }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "type": "object", "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication." }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "parent": { "type": "string", "description": "Required. The parent resource for new conversations." }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "conversationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations." }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." } }, "description": "The request to ingest conversations.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", "type": "object", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "description": "The metadata from querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart", "type": "object", "description": "A structured component/part of a transcript segment.", "properties": { "image": { "description": "Optional. Image media.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "thought": { "description": "Optional. Model thought or internal reasoning.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart" }, "customPayload": { "description": "Optional. Generic custom structured payload.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart" }, "suggestionChips": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "description": "Optional. Suggestion chips or interactive buttons." }, "text": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "description": "Optional. Plain text content." }, "video": { "description": "Optional. Video media.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "list": { "description": "Optional. Ordered or unordered list.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "link": { "description": "Optional. Web link or URL.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart" }, "table": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "description": "Optional. Tabular data." }, "productCollection": { "description": "Optional. Product collection or carousel.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "citation": { "description": "Optional. Citation or reference to grounding material.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "type": "object", "description": "The conversation source, which is a combination of transcript and audio.", "properties": { "turnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "description": "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.", "type": "array" }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GcsSource" }, "metadataUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation metadata." }, "dialogflowSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource", "description": "The source when the conversation comes from Dialogflow." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "type": "object", "description": "An error that occurred during correlation for a specific conversation.", "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { "description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.", "properties": { "accuracy": { "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "type": "number", "format": "double", "readOnly": true } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision": { "description": "A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.", "properties": { "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Whether this resource is zone isolated." }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Whether this resource is zone separated." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EDITABLE", "TRAINING", "TRAINING_FAILED", "READY", "DELETING", "TRAINING_CANCELLED" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "The scorecard revision can be edited.", "Scorecard model training is in progress.", "Scorecard revision model training failed.", "The revision can be used in analysis.", "Scorecard is being deleted.", "Scorecard model training was explicitly cancelled by the user." ], "description": "Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis." }, "createTime": { "readOnly": true, "description": "Output only. The timestamp that the revision was created.", "type": "string", "format": "google-datetime" }, "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "name": { "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, "alternateIds": { "items": { "type": "string" }, "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "type": "array", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision", "type": "object" }, "GoogleCloudCesV1mainEndSession": { "properties": { "metadata": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "id": "GoogleCloudCesV1mainEndSession", "description": "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "description": "Message for sampling conversations.", "properties": { "conversationFilter": { "type": "string", "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations." }, "samplePercentage": { "format": "double", "type": "number", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100]." }, "sampleRow": { "format": "int64", "description": "Number of the conversations that we should sample based on the dimension.", "type": "string" }, "dimension": { "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleRule" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "properties": { "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" }, "tag": { "type": "string", "description": "The tag the score applies to." }, "score": { "format": "double", "type": "number", "description": "The score the tag applies to." }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" } }, "description": "Tags and their corresponding results.", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "properties": { "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" }, "description": "List of all individual score sets.", "type": "array" }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "type": "array" }, "score": { "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number", "format": "double" }, "name": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist." }, "agentId": { "type": "string", "description": "ID of the agent that handled the conversation." }, "conversation": { "type": "string", "description": "The conversation scored by this result." }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" } }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "properties": { "feedbackLabels": { "type": "array", "description": "Input only. The feedback labels associated with the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "menuPath": { "type": "string", "description": "An arbitrary string value specifying the menu path the customer took." }, "customerSatisfactionRating": { "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer" }, "agentInfo": { "type": "array", "description": "Information about agents involved in the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" } }, "waitDuration": { "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent.", "type": "string" } }, "description": "Conversation metadata related to quality management.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions", "description": "Options for configuring the data used to generate the QA question.", "type": "object", "properties": { "conversationDataOptions": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions", "description": "Options for configuring the conversation data used to generate the QA question." } } }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time at which the analysis ended." } }, "type": "object", "description": "The result of an analysis." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "properties": { "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "format": { "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "type": "string", "description": "Required. File format in which the labels will be exported." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "description": "Average QA normalized score for the tag.", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "type": "number", "description": "Average tag normalized score per tag.", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "properties": { "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "type": "string", "description": "ID of the agent that handled the conversation." }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "format": "double", "type": "number" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" } }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "type": "array" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "format": "double", "type": "number" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array", "description": "Collection of tags and their scores." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp that the revision was created.", "type": "string" }, "qaScorecardRevision": { "type": "string", "description": "The QaScorecardRevision scored by this result." }, "score": { "type": "number", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "format": "double" } }, "type": "object", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "properties": { "duration": { "readOnly": true, "format": "google-duration", "description": "Output only. The duration of the conversation.", "type": "string" }, "latestAnalysis": { "$ref": "GoogleCloudContactcenterinsightsV1Analysis", "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "turnCount": { "format": "int32", "readOnly": true, "description": "Output only. The number of turns in the conversation.", "type": "integer" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time at which the conversation started." }, "qualityMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "description": "Conversation metadata related to quality management." }, "labels": { "description": "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "correlationInfo": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "readOnly": true, "description": "Output only. Info for correlating across conversations." }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "readOnly": true, "type": "object" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the conversation was created." }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string", "format": "google-duration" }, "expireTime": { "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the conversation was updated.", "format": "google-datetime", "type": "string" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "latestSummary": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Output only. Latest summary of the conversation." }, "satisfiesPzs": { "description": "Output only. Whether this resource is zone separated.", "type": "boolean", "readOnly": true }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "metadataJson": { "description": "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.", "type": "string" }, "runtimeAnnotations": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction." }, "medium": { "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Immutable. The conversation medium.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true } }, "description": "The conversation resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", "properties": { "normalizedScore": { "type": "number", "description": "The normalized score, which is the score divided by the potential score.", "format": "double" }, "potentialScore": { "format": "double", "type": "number", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "score": { "description": "The overall numerical score of the result.", "format": "double", "type": "number" }, "qaTagResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores." }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation.", "properties": { "failedSampleCount": { "format": "int32", "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "readOnly": true }, "successfulSampleCount": { "type": "integer", "readOnly": true, "description": "Output only. The number of new conversations added during this sample operation.", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "description": "The issue model resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "properties": { "modelType": { "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model.", "type": "string" }, "displayName": { "type": "string", "description": "The representative name for the issue model." }, "languageCode": { "description": "Language of the model.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated.", "type": "string" }, "state": { "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "type": "string", "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true }, "inputDataConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "description": "Configs for the input data that used to create the issue model." }, "createTime": { "description": "Output only. The time at which this issue model was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "issueCount": { "type": "string", "format": "int64", "description": "Output only. Number of issues in this issue model.", "readOnly": true }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SentimentData": { "description": "The data for a sentiment annotation.", "properties": { "score": { "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number" }, "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SentimentData" }, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "type": "object", "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "properties": { "deidentifyTemplate": { "type": "string", "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`" }, "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "$ref": "GoogleCloudContactcenterinsightsV1Issue", "description": "Required. The values for the new issue." } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueRequest", "description": "The request to create an issue.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" } }, "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", "properties": { "issueModel": { "type": "string", "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "issues": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" }, "description": "All the matched issues." } }, "description": "Issue Modeling result on a conversation." }, "GoogleCloudContactcenterinsightsV1Dimension": { "id": "GoogleCloudContactcenterinsightsV1Dimension", "properties": { "clientSentimentCategoryDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true }, "issueDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the issue dimension." }, "labelDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about conversation labels." }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension." }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "conversationProfileDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the conversation profile dimension." }, "dimensionKey": { "type": "string", "description": "The key of the dimension.", "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ] }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension." }, "qaQuestionDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the QA question dimension." }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" } }, "type": "object", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "type": "object", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Output only. The original request for download.", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "downloadStats": { "readOnly": true, "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" } } }, "GoogleCloudContactcenterinsightsV1Dataset": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1Dataset", "properties": { "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Whether this resource is zone separated." }, "ttl": { "format": "google-duration", "type": "string", "description": "Optional. Option TTL for the dataset." }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "type": { "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "type": "string", "description": "Dataset usage type.", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string" }, "displayName": { "type": "string", "description": "Display name for the dataaset" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dataset update time." }, "name": { "type": "string", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" } }, "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "properties": { "successfulSampleCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of new conversations added during this sample operation." }, "failedSampleCount": { "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "format": "int32", "readOnly": true, "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig": { "type": "object", "properties": { "metrics": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition" }, "description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", "type": "object" } }, "description": "Configuration for diagnostic metrics.", "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "properties": { "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "type": "string", "description": "The rule ID." }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule.", "type": "object" }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "properties": { "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "question": { "type": "string", "description": "The corresponding FAQ question." }, "confidenceScore": { "description": "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).", "type": "number", "format": "float" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "description": "The data for a silence annotation.", "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSilenceData" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "type": "object", "properties": { "spreadsheetUri": { "type": "string", "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata." }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "properties": { "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" }, "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" } }, "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse", "description": "The response from a GenerateConversationSignedAudio request.", "properties": { "signedAudioUris": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris", "description": "The signed uris for the audio." } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "properties": { "userMessage": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "A message from the user that is interacting with the system." }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message." }, "messageId": { "type": "string", "description": "The message id of the message." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage", "properties": { "chartSpec": { "type": "object", "description": "Chart spec from LLM", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "userProvidedSqlQuery": { "type": "string", "description": "Optional. User provided SQL query" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "userProvidedChartSpec": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. User provided chart spec", "type": "object" } }, "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "properties": { "name": { "type": "string", "description": "Required. The issue model to deploy." } }, "description": "The request to deploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" } }, "description": "Metadata for deploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "description": "Metadata about the client sentiment category dimension.", "type": "object", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule": { "type": "object", "properties": { "createTime": { "description": "Output only. The time at which this assessment rule was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "displayName": { "description": "Display Name of the assessment rule.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which this assessment rule was updated.", "type": "string", "format": "google-datetime" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive.", "type": "boolean" }, "sampleRule": { "description": "The sample rule for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "satisfiesPzi": { "description": "Output only. Whether this resource is zone isolated.", "type": "boolean", "readOnly": true }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Whether this resource is zone separated.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule", "description": "The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage source message." }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" } }, "description": "Request to import an issue model.", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "type": "object", "description": "A list part.", "properties": { "items": { "type": "array", "description": "Optional. List items.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" } }, "listType": { "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ], "description": "Optional. The type of list.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "description": "Wrapper for detailed, step-by-step results.", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "joinKeyResults": { "type": "array", "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" } } } }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse": { "properties": { "labelResult": { "description": "The result of the test auto labeling rule.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse", "description": "The response message for testing auto labeling rules.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse": { "type": "object", "properties": { "conversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "The conversations that match the request.", "type": "array" }, "nextPageToken": { "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", "type": "string" } }, "description": "The response of listing conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "type": "object", "properties": { "objectUri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`" }, "format": { "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "description": "Required. File format which will be ingested.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "type": "string" } }, "description": "Google Cloud Storage Object details to get the feedback label file from." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "properties": { "spreadsheetUri": { "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" }, "sheetTitle": { "type": "string", "description": "Optional. The title of the new sheet to write the feedback labels to." } }, "description": "Google Sheets document details to write the feedback labels to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", "type": "object", "properties": { "messages": { "type": "array", "description": "The messages in the turn.", "items": { "$ref": "GoogleCloudCesV1mainMessage" } }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "description": "The CES diagnostic information." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "properties": { "totalValidLabelCount": { "description": "Total number of valid labels provided for the question at the time of tuining.", "type": "string", "format": "int64" }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" }, "datasetValidationWarnings": { "description": "A list of any applicable data validation warnings about the question's feedback labels.", "items": { "enumDescriptions": [ "Unspecified data validation warning.", "A non-trivial percentage of the feedback labels are invalid.", "The quantity of valid feedback labels provided is less than the recommended minimum.", "One or more of the answers have less than the recommended minimum of feedback labels.", "All the labels in the dataset come from a single answer choice." ], "enum": [ "DATASET_VALIDATION_WARNING_UNSPECIFIED", "TOO_MANY_INVALID_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", "type": "object", "properties": { "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score the tag applies to." }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "potentialScore": { "description": "The potential score the tag applies to.", "format": "double", "type": "number" }, "score": { "type": "number", "description": "The score the tag applies to.", "format": "double" } }, "description": "Tags and their corresponding results." }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "description": "The response to an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "The feedback labels that match the request.", "type": "array" } }, "description": "The response for listing all feedback labels." }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "properties": { "conversationModel": { "type": "string", "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}" }, "textSections": { "additionalProperties": { "type": "string" }, "description": "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.", "type": "object" }, "text": { "type": "string", "description": "The summarization content that is concatenated into one string." }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "metadata": { "type": "object", "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" } }, "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "confidence": { "type": "number", "description": "The confidence score of the summarization.", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "description": "Wrapper for storing the generative response for a chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse", "properties": { "textOutput": { "deprecated": true, "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "type": "string" }, "generatedSqlQuery": { "type": "string", "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource." }, "textMessage": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" }, "chartSpec": { "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "description": "The response to undeploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "description": "A text part.", "type": "object", "properties": { "text": { "type": "string", "description": "Optional. The text content." } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "description": "The data for an issue match annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "type": "object", "properties": { "issueAssignment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "description": "Information about the issue's assignment." } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest": { "description": "The request for bulk uploading feedback labels.", "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "description": "A cloud storage bucket source." }, "sheetsSource": { "description": "A sheets document source.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "type": "string", "description": "Optional. The conversation profile ID." } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "type": "object", "properties": { "text": { "description": "Optional. The text of the list item.", "type": "string" }, "subItems": { "description": "Optional. Nested sub-items.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem", "description": "An item in a list." }, "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse", "properties": { "issueModels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "The issue models that match the request.", "type": "array" } }, "description": "The response of listing issue models.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData", "properties": { "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "metadata": { "type": "object", "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "additionalProperties": { "type": "string" } }, "confidenceScore": { "description": "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).", "format": "double", "type": "number" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest": { "description": "The request for generative insights.", "properties": { "revisionId": { "type": "string", "description": "Optional. The revision id that maps to the state of the chart state revision. When specified, the backend will reload the chart with the sql and visual spec from that revision." }, "sqlComparisonKey": { "type": "string", "description": "Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset." }, "filter": { "description": "Filter for the data that can be specified in addition to the natural language query. Users are encouraged to use this field to populate time-windows.", "type": "string" }, "sessionId": { "description": "Optional. The session id of the conversation. If the session id is not specified, backend will generate a random session id. If the session id is specified, will associate user-provided user_query with the provided session id.", "type": "string" }, "chart": { "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "userProvidedChartSpec": { "type": "object", "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "sqlQuery": { "description": "Optional. The SQL query specified by the user. This query must be in BigQuery SQL dialect. The `filter` field will also be ignored, as it is assumed that any filtering is already included in the SQL query.", "type": "string" }, "naturalLanguageQuery": { "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored.", "type": "string" }, "comparisonFilter": { "description": "Optional. Filter for the data that can be specified in addition to the natural language query. This `filter` is specifically used for charts where comparisons are possible. For example, \"compare to last month\" or \"compare to previous quarter\".", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1mainConversationParticipant", "description": "The call participant speaking for a given utterance.", "properties": { "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "dialogflowParticipant": { "type": "string", "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true }, "obfuscatedExternalUserId": { "type": "string", "description": "Obfuscated user ID from Dialogflow." }, "role": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The role of the participant.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice", "description": "Message representing a possible answer to the question.", "properties": { "boolValue": { "description": "Boolean value.", "type": "boolean" }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations." }, "strValue": { "description": "String value.", "type": "string" }, "numValue": { "type": "number", "description": "Numerical value.", "format": "double" }, "key": { "type": "string", "description": "A short string used as an identifier." }, "score": { "format": "double", "type": "number", "description": "Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused." } } }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "properties": { "tags": { "items": { "type": "string" }, "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array" }, "qaQuestion": { "type": "string", "description": "The QaQuestion answered by this answer." }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" }, "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources." }, "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." } }, "description": "An answer to a QaQuestion.", "id": "GoogleCloudContactcenterinsightsV1QaAnswer", "type": "object" }, "GoogleCloudContactcenterinsightsV1HoldData": { "properties": {}, "description": "The data for a hold annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1HoldData" }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "description": "A Cloud Storage source of conversation data.", "properties": { "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUris": { "description": "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).", "type": "array", "items": { "type": "string" } }, "audioUri": { "type": "string", "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "deprecated": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "properties": { "systemMessages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user." } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the issue model to delete." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The request to delete an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo", "properties": { "endOffset": { "type": "string", "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "format": "google-duration" }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "format": "google-duration", "type": "string" }, "word": { "type": "string", "description": "The word itself. Includes punctuation marks that surround the word." }, "confidence": { "description": "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.", "type": "number", "format": "float" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", "type": "object" } }, "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "version": "v1alpha1", "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "version_module": true, "name": "contactcenterinsights", "basePath": "", "resources": { "projects": { "resources": { "locations": { "methods": { "bulkUploadFeedbackLabels": { "parameterOrder": [ "parent" ], "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" } }, "updateCorrelationConfig": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "parameterOrder": [ "name" ], "description": "Updates correlation config.", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "parameters": { "updateMask": { "location": "query", "description": "Optional. The list of fields to be updated.", "format": "google-fieldmask", "type": "string" }, "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "getSettings": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "httpMethod": "GET", "description": "Gets project-level settings.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string", "required": true, "description": "Required. The name of the settings resource to get.", "location": "path" } }, "id": "contactcenterinsights.projects.locations.getSettings", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "updateSettings": { "description": "Updates project-level settings.", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "parameters": { "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/settings$" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. The list of fields to be updated." } }, "id": "contactcenterinsights.projects.locations.updateSettings", "httpMethod": "PATCH" }, "bulkDownloadFeedbackLabels": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource for new feedback labels.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "testCorrelationConfig": { "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Tests correlation config on a conversation.", "path": "v1alpha1/{+location}:testCorrelationConfig", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig", "parameters": { "location": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}", "type": "string" } }, "parameterOrder": [ "location" ] }, "getEncryptionSpec": { "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "parameters": { "name": { "type": "string", "description": "Required. The name of the encryption spec resource to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets location-level encryption key specification." }, "generativeInsights": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generativeInsights", "parameterOrder": [ "location" ], "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "id": "contactcenterinsights.projects.locations.generativeInsights", "path": "v1alpha1/{+location}:generativeInsights" }, "bulkDeleteFeedbackLabels": { "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent resource for new feedback labels.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "description": "Delete feedback labels in bulk using a filter.", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "queryMetrics": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "description": "Query metrics.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "httpMethod": "POST", "parameterOrder": [ "location" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "location": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" } }, "id": "contactcenterinsights.projects.locations.queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+location}:queryMetrics" }, "listAllFeedbackLabels": { "description": "List all feedback labels by project number.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32", "location": "query" }, "parent": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of all feedback labels per project." } }, "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "parameterOrder": [ "parent" ] }, "queryPerformanceOverview": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "location": "path" } }, "description": "Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "path": "v1alpha1/{+parent}:queryPerformanceOverview", "httpMethod": "POST" }, "getCorrelationConfig": { "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "description": "Gets correlation config.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "location": "path", "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" } } } }, "resources": { "views": { "methods": { "create": { "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "id": "contactcenterinsights.projects.locations.views.create", "path": "v1alpha1/{+parent}/views", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "description": "Creates a view.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "id": "contactcenterinsights.projects.locations.views.list", "description": "Lists views.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "type": "integer" }, "parent": { "description": "Required. The parent resource of the views.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "type": "string", "description": "The value returned by the last `ListViewsResponse`; indicates that this is a continuation of a prior `ListViews` call and the system should return the next page of data.", "location": "query" } }, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/views", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "description": "Gets a view.", "parameters": { "name": { "description": "Required. The name of the view to get.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.views.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.views.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "description": "Required. The name of the view to delete." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Deletes a view.", "path": "v1alpha1/{+name}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "required": true, "location": "path" }, "updateMask": { "location": "query", "description": "The list of fields to be updated.", "type": "string", "format": "google-fieldmask" } }, "path": "v1alpha1/{+name}", "httpMethod": "PATCH", "description": "Updates a view.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "id": "contactcenterinsights.projects.locations.views.patch", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" } } } }, "conversations": { "methods": { "list": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists conversations.", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data." }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the conversation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "view": { "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ], "description": "The level of details of the conversation. Default is `BASIC`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "type": "string", "location": "query" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "id": "contactcenterinsights.projects.locations.conversations.list" }, "calculateStats": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "location": { "description": "Required. The location of the conversations.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string", "location": "query" } }, "httpMethod": "GET", "description": "Gets conversation statistics.", "id": "contactcenterinsights.projects.locations.conversations.calculateStats", "parameterOrder": [ "location" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", "path": "v1alpha1/{+location}/conversations:calculateStats" }, "bulkDelete": { "description": "Deletes multiple conversations in a single request.", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "path": "v1alpha1/{+parent}/conversations:bulkDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "parameterOrder": [ "parent" ] }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "conversationId": { "description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string", "location": "query" }, "parent": { "location": "path", "description": "Required. The parent resource of the conversation.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.create", "description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "path": "v1alpha1/{+parent}/conversations", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations" }, "get": { "httpMethod": "GET", "parameters": { "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "location": "query", "description": "The level of details of the conversation. Default is `FULL`.", "type": "string", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ] }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the conversation to get." } }, "id": "contactcenterinsights.projects.locations.conversations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}" }, "delete": { "parameters": { "force": { "type": "boolean", "description": "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.", "location": "query" }, "name": { "required": true, "description": "Required. The name of the conversation to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.conversations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "generateSignedAudio": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to sign." } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "path": "v1alpha1/{+name}:generateSignedAudio", "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "parameterOrder": [ "name" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.patch", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "name": { "required": true, "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" }, "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the conversation will be updated with auto labeling results." }, "allowMissing": { "type": "boolean", "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored.", "location": "query" }, "updateMask": { "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings`", "type": "string", "location": "query", "format": "google-fieldmask" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "parameterOrder": [ "name" ], "description": "Updates a conversation." }, "sample": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "id": "contactcenterinsights.projects.locations.conversations.sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+parent}/conversations:sample" }, "upload": { "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "path": "v1alpha1/{+parent}/conversations:upload", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.conversations.upload", "httpMethod": "POST", "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversation.", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "ingest": { "path": "v1alpha1/{+parent}/conversations:ingest", "description": "Imports conversations and processes them according to the user's configuration.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.ingest", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource for new conversations.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" } }, "bulkAnalyze": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "description": "Analyzes multiple conversations in a single request.", "path": "v1alpha1/{+parent}/conversations:bulkAnalyze", "httpMethod": "POST", "parameters": { "parent": { "required": true, "location": "path", "description": "Required. The parent resource to create analyses in.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "parameterOrder": [ "parent" ] } }, "resources": { "assessments": { "methods": { "appeal": { "path": "v1alpha1/{+name}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to appeal.", "location": "path", "required": true } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "parameterOrder": [ "name" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "description": "Appeal an Assessment.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "delete": { "parameterOrder": [ "name" ], "description": "Delete an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The name of the assessment to delete." }, "force": { "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "location": "query", "type": "boolean" } }, "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}" }, "finalize": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Finalize an Assessment.", "path": "v1alpha1/{+name}:finalize", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to finalize." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "create": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the assessment.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+parent}/assessments", "id": "contactcenterinsights.projects.locations.conversations.assessments.create", "description": "Create Assessment." }, "get": { "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "description": "Get Assessment.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the assessment to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}" }, "list": { "path": "v1alpha1/{+parent}/assessments", "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List Assessments.", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "required": true }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "location": "query", "type": "string" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "parameterOrder": [ "parent" ] }, "publish": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "description": "Required. The name of the assessment to publish.", "location": "path" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "path": "v1alpha1/{+name}:publish", "description": "Publish an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "notes": { "methods": { "list": { "path": "v1alpha1/{+parent}/notes", "parameters": { "pageSize": { "type": "integer", "description": "Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The parent resource of the notes.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "description": "List Notes.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "parameters": { "name": { "description": "Required. The name of the note to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the note.", "location": "path" } }, "path": "v1alpha1/{+parent}/notes", "description": "Create Note.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } } } } } }, "feedbackLabels": { "methods": { "delete": { "parameters": { "name": { "description": "Required. The name of the feedback label to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete" }, "list": { "parameterOrder": [ "parent" ], "description": "List feedback labels.", "parameters": { "parent": { "description": "Required. The parent resource of the feedback labels.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "location": "query", "format": "int32", "type": "integer" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "path": "v1alpha1/{+parent}/feedbackLabels", "parameters": { "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback label." } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "description": "Create feedback label.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "get": { "path": "v1alpha1/{+name}", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Get feedback label.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "description": "Required. The name of the feedback label to get.", "location": "path", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "location": "path" }, "updateMask": { "description": "Required. The list of fields to be updated.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ] } } }, "segments": { "methods": { "bulkAnalyze": { "parameterOrder": [ "parent" ], "description": "Analyzes multiple conversations in a single request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The parent resource to create analyses in.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "path": "v1alpha1/{+parent}/segments:bulkAnalyze" } } }, "analyses": { "methods": { "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the analysis to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "required": true } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "description": "Deletes an analysis." }, "create": { "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/analyses", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the analysis.", "required": true } }, "description": "Creates an analysis. The long running operation is done when the analysis has completed." }, "list": { "description": "Lists analyses.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse" }, "id": "contactcenterinsights.projects.locations.conversations.analyses.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/analyses", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "type": "integer" }, "pageToken": { "type": "string", "location": "query", "description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data." }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the analyses.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "location": "query" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "get": { "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "location": "path", "description": "Required. The name of the analysis to get.", "required": true } }, "description": "Gets an analysis.", "httpMethod": "GET" } } } } }, "insightsdata": { "methods": { "export": { "path": "v1alpha1/{+parent}/insightsdata:export", "description": "Export insights data to a destination defined in the request body.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.insightsdata.export", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource to export data from.", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "httpMethod": "POST" } } }, "datasets": { "methods": { "get": { "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "id": "contactcenterinsights.projects.locations.datasets.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the dataset to get." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "description": "Gets a dataset." }, "patch": { "description": "Updates a dataset.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "path": "v1alpha1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "location": "path", "type": "string" }, "updateMask": { "type": "string", "description": "Optional. The list of fields to update.", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "id": "contactcenterinsights.projects.locations.datasets.patch" }, "bulkUploadFeedbackLabels": { "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "description": "Required. The parent resource for new feedback labels.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } } }, "delete": { "id": "contactcenterinsights.projects.locations.datasets.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the dataset to delete.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true } }, "description": "Delete a dataset.", "httpMethod": "DELETE", "path": "v1alpha1/{+name}" }, "list": { "path": "v1alpha1/{+parent}/datasets", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "description": "List datasets matching the input.", "parameters": { "pageSize": { "description": "Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "location": "query", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number`" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset.", "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data.", "location": "query" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.datasets.list" }, "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "path": "v1alpha1/{+parent}/datasets", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.create", "description": "Creates a dataset.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "datasetId": { "description": "Optional. The ID to use for the dataset.", "type": "string", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent resource of the dataset.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "bulkDownloadFeedbackLabels": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource for new feedback labels." } }, "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "httpMethod": "POST", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels" }, "listAllFeedbackLabels": { "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", "parameters": { "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "pageToken": { "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string", "location": "query" }, "parent": { "required": true, "description": "Required. The parent resource of all feedback labels per project.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "httpMethod": "GET", "description": "List all feedback labels by project number.", "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "bulkDeleteFeedbackLabels": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "description": "Delete feedback labels in bulk using a filter." } }, "resources": { "insightsdata": { "methods": { "export": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "path": "v1alpha1/{+parent}/insightsdata:export", "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Export insights data to a destination defined in the request body.", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource to export data from." } } } } }, "conversations": { "resources": { "feedbackLabels": { "methods": { "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Get feedback label.", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get" }, "delete": { "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "description": "Delete feedback label.", "parameters": { "name": { "description": "Required. The name of the feedback label to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "create": { "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the feedback label.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path", "required": true }, "feedbackLabelId": { "type": "string", "location": "query", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." } }, "path": "v1alpha1/{+parent}/feedbackLabels", "httpMethod": "POST" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "location": "query" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List feedback labels.", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", "path": "v1alpha1/{+parent}/feedbackLabels" }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameterOrder": [ "name" ], "description": "Update feedback label.", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "updateMask": { "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "type": "string", "location": "query" } }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } } } }, "methods": { "bulkDelete": { "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "path": "v1alpha1/{+parent}/conversations:bulkDelete", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "get": { "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "path": "v1alpha1/{+name}", "description": "Gets a conversation.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "name": { "description": "Required. The name of the conversation to get.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" }, "view": { "description": "The level of details of the conversation. Default is `FULL`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "type": "string", "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ] } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "ingest": { "description": "Imports conversations and processes them according to the user's configuration.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "path": "v1alpha1/{+parent}/conversations:ingest", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "force": { "description": "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.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the conversation to delete.", "location": "path" } }, "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "sample": { "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the dataset.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample", "path": "v1alpha1/{+parent}/conversations:sample", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.sample" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists conversations.", "httpMethod": "GET", "path": "v1alpha1/{+parent}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", "parameters": { "pageToken": { "location": "query", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "type": "string" }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ], "type": "string", "description": "The level of details of the conversation. Default is `BASIC`.", "location": "query" }, "pageSize": { "location": "query", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "description": "Required. The parent resource of the conversation.", "location": "path" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "location": "query", "type": "string" } } }, "generateSignedAudio": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation.", "path": "v1alpha1/{+name}:generateSignedAudio", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the conversation to sign.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "calculateStats": { "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "httpMethod": "POST", "path": "v1alpha1/{+location}/conversations:calculateStats", "parameters": { "location": { "location": "path", "type": "string", "description": "Required. The location of the conversations.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } } } } } } }, "autoLabelingRules": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "description": "Deletes an auto labeling rule." }, "test": { "description": "Tests auto labeling rules against a conversation.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "parameters": { "parent": { "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "path": "v1alpha1/{+parent}/autoLabelingRules:test", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "parameterOrder": [ "parent" ] }, "list": { "path": "v1alpha1/{+parent}/autoLabelingRules", "parameterOrder": [ "parent" ], "description": "Lists auto labeling rules.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.autoLabelingRules.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous List request, if any.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The maximum number of auto labeling rules to return in a single response. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." } }, "httpMethod": "GET" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an auto labeling rule.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "parameters": { "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string", "location": "path", "required": true }, "updateMask": { "location": "query", "description": "Optional. The list of fields to be updated.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "httpMethod": "PATCH", "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "description": "Gets an auto labeling rule." }, "create": { "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "parameters": { "autoLabelingRuleId": { "description": "Required. The ID to use for the auto labeling rule, which will become the final component of the auto labeling rule's resource name.", "location": "query", "type": "string" }, "parent": { "required": true, "location": "path", "type": "string", "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "Creates an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "path": "v1alpha1/{+parent}/autoLabelingRules" } } }, "operations": { "methods": { "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.operations.cancel", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "contactcenterinsights.projects.locations.operations.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource." } }, "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ] }, "list": { "id": "contactcenterinsights.projects.locations.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "qaQuestionTags": { "methods": { "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "path": "v1alpha1/{+name}", "description": "Deletes a QaQuestionTag.", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.get", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "location": "path", "description": "Required. The name of the QaQuestionTag to get.", "type": "string" } }, "description": "Gets a QaQuestionTag.", "httpMethod": "GET" }, "create": { "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "path": "v1alpha1/{+parent}/qaQuestionTags", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "httpMethod": "POST", "description": "Creates a QaQuestionTag.", "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestionTag.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "qaQuestionTagId": { "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "location": "query", "type": "string" } } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" }, "path": "v1alpha1/{+parent}/qaQuestionTags", "description": "Lists the question tags.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the QaQuestionTags." }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions (ie. AND operators). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_id` - id of the scorecard to list tags for * `revision_id` - id of the scorecard revision to list tags for` * `qa_question_id - id of the question to list tags for`", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "httpMethod": "GET" }, "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "httpMethod": "PATCH", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" }, "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "parameterOrder": [ "name" ], "description": "Updates a QaQuestionTag." } } }, "issueModels": { "methods": { "list": { "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.issueModels.list", "httpMethod": "GET", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the issue model.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "Lists issue models.", "path": "v1alpha1/{+parent}/issueModels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } }, "id": "contactcenterinsights.projects.locations.issueModels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "description": "Updates an issue model." }, "create": { "description": "Creates an issue model.", "path": "v1alpha1/{+parent}/issueModels", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent resource of the issue model.", "location": "path" } }, "id": "contactcenterinsights.projects.locations.issueModels.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "import": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "id": "contactcenterinsights.projects.locations.issueModels.import", "description": "Imports an issue model from a Cloud Storage bucket.", "httpMethod": "POST", "path": "v1alpha1/{+parent}/issueModels:import", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The parent resource of the issue model.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels:import" }, "calculateIssueModelStats": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "path": "v1alpha1/{+issueModel}:calculateIssueModelStats", "parameters": { "issueModel": { "description": "Required. The resource name of the issue model to query against.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "required": true } }, "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "description": "Gets an issue model's statistics.", "parameterOrder": [ "issueModel" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the issue model to delete.", "location": "path" } }, "id": "contactcenterinsights.projects.locations.issueModels.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes an issue model." }, "deploy": { "id": "contactcenterinsights.projects.locations.issueModels.deploy", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+name}:deploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "description": "Required. The issue model to deploy." } }, "description": "Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed." }, "undeploy": { "description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The issue model to undeploy.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "path": "v1alpha1/{+name}:undeploy" }, "get": { "path": "v1alpha1/{+name}", "description": "Gets an issue model.", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the issue model to get." } }, "id": "contactcenterinsights.projects.locations.issueModels.get" }, "export": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "path": "v1alpha1/{+name}:export", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "description": "Exports an issue model to the provided destination.", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. The issue model to export.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "type": "string", "location": "path" } }, "id": "contactcenterinsights.projects.locations.issueModels.export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "issues": { "methods": { "get": { "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the issue to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets an issue.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "path": "v1alpha1/{+name}" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an issue.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "parameters": { "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "location": "path", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "The list of fields to be updated." } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "httpMethod": "PATCH" }, "create": { "description": "Creates an issue.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the issue.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "path": "v1alpha1/{+parent}/issues", "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "id": "contactcenterinsights.projects.locations.issueModels.issues.list", "path": "v1alpha1/{+parent}/issues", "httpMethod": "GET", "description": "Lists issues.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the issue.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "location": "path" } } }, "delete": { "description": "Deletes an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the issue to delete.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.issueModels.issues.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "assistantSessions": { "methods": { "streamChat": { "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the assistant session to stream chat. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest" }, "id": "contactcenterinsights.projects.locations.assistantSessions.streamChat", "path": "v1alpha1/{+name}:streamChat", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}:streamChat", "description": "Streams chat messages from the assistant.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse" } }, "create": { "path": "v1alpha1/{+parent}/assistantSessions", "httpMethod": "POST", "parameters": { "assistantSessionId": { "description": "Optional. The ID to use for the assistant session, which will become the final component of the assistant session's resource name. If not provided, a random UUID will be generated by the server. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource where this assistant session will be created. Format: projects/{project}/locations/{location}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "id": "contactcenterinsights.projects.locations.assistantSessions.create", "description": "Creates an assistant session.", "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "type": "string", "description": "Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", "required": true } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}", "path": "v1alpha1/{+name}", "description": "Gets an assistant session.", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.assistantSessions.get" }, "list": { "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListAssistantSessions` call. Provide this to retrieve the subsequent page." }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. The maximum number of assistant sessions to return in a single response. If unspecified, at most 100 assistant sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource, which owns this collection of assistant sessions. Format: `projects/{project}/locations/{location}`" } }, "description": "Lists assistant sessions.", "path": "v1alpha1/{+parent}/assistantSessions", "id": "contactcenterinsights.projects.locations.assistantSessions.list" } } }, "authorizedViewSets": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/authorizedViewSets", "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data." }, "pageSize": { "description": "Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32", "location": "query" }, "orderBy": { "description": "Optional. The order by expression to order authorized view sets listed in the response.", "type": "string", "location": "query" }, "parent": { "location": "path", "description": "Required. The parent resource of the AuthorizedViewSets.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "location": "query", "type": "string" } }, "httpMethod": "GET", "description": "List AuthorizedViewSets" }, "patch": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string", "required": true, "location": "path" }, "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "parameterOrder": [ "name" ], "description": "Updates an AuthorizedViewSet." }, "get": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the AuthorizedViewSet to get.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" } }, "httpMethod": "GET", "path": "v1alpha1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "Get AuthorizedViewSet", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v1alpha1/{+parent}/authorizedViewSets", "description": "Create AuthorizedViewSet", "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the AuthorizedViewSet.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "authorizedViewSetId": { "type": "string", "location": "query", "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "parameterOrder": [ "parent" ] }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "description": "Required. The name of the AuthorizedViewSet to delete.", "type": "string" }, "force": { "type": "boolean", "location": "query", "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none." } }, "parameterOrder": [ "name" ], "description": "Deletes an AuthorizedViewSet." } }, "resources": { "authorizedViews": { "resources": { "conversations": { "methods": { "calculateStats": { "httpMethod": "GET", "parameters": { "location": { "description": "Required. The location of the conversations.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties." } }, "description": "Gets conversation statistics.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats", "path": "v1alpha1/{+location}/conversations:calculateStats", "parameterOrder": [ "location" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the conversation to delete." }, "force": { "description": "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.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "description": "Deletes a conversation.", "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}" }, "generateSignedAudio": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "description": "Gets the signed URI for the audio for the given conversation.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Required. The name of the conversation to sign.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" } }, "path": "v1alpha1/{+name}:generateSignedAudio", "parameterOrder": [ "name" ] }, "get": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "path": "v1alpha1/{+name}", "description": "Gets a conversation.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the conversation to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "location": "path", "type": "string" }, "view": { "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ], "type": "string", "description": "The level of details of the conversation. Default is `FULL`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ] } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "description": "Lists conversations.", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "type": "string", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "location": "query" }, "view": { "location": "query", "type": "string", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript.", "Populates all fields in the conversation, including the structured transcript parts." ], "description": "The level of details of the conversation. Default is `BASIC`." }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the conversation." }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "path": "v1alpha1/{+parent}/conversations", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list" } }, "resources": { "assessments": { "methods": { "appeal": { "parameters": { "name": { "location": "path", "description": "Required. The name of the assessment to appeal.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:appeal", "description": "Appeal an Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "publish": { "path": "v1alpha1/{+name}:publish", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to publish.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Publish an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "httpMethod": "POST" }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the assessment to delete.", "location": "path" }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes." } }, "description": "Delete an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the assessment." } }, "description": "Create Assessment.", "httpMethod": "POST", "path": "v1alpha1/{+parent}/assessments", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "finalize": { "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to finalize." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Finalize an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "path": "v1alpha1/{+name}:finalize" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." }, "parent": { "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "parameterOrder": [ "parent" ], "description": "List Assessments." }, "get": { "httpMethod": "GET", "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "description": "Required. The name of the assessment to get.", "location": "path", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Get Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "notes": { "methods": { "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "location": "path", "type": "string", "required": true }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch", "description": "Update Note." }, "list": { "description": "List Notes.", "parameters": { "pageSize": { "description": "Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "location": "query", "type": "integer" }, "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the notes.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" }, "pageToken": { "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "location": "query", "type": "string" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/notes" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the note to delete." } }, "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Create Note.", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the note.", "type": "string" } }, "path": "v1alpha1/{+parent}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } } } } } }, "feedbackLabels": { "methods": { "create": { "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameters": { "feedbackLabelId": { "type": "string", "location": "query", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." }, "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback label." } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "httpMethod": "POST", "description": "Create feedback label." }, "list": { "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "format": "int32" }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the feedback labels.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. 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" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "description": "List feedback labels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels" }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Required. The list of fields to be updated." }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ] }, "delete": { "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the feedback label to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "get": { "description": "Get feedback label.", "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to get.", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameterOrder": [ "name" ] } } } } }, "operations": { "methods": { "cancel": { "path": "v1alpha1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path" } }, "httpMethod": "GET" }, "list": { "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string", "required": true, "location": "path" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "getIamPolicy": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "resource": { "location": "path", "type": "string", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "path": "v1alpha1/{+resource}:getIamPolicy" }, "testIamPermissions": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameters": { "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes an AuthorizedView.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the AuthorizedView to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete" }, "queryPerformanceOverview": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "description": "Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryPerformanceOverview", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"" } }, "path": "v1alpha1/{+parent}:queryPerformanceOverview", "parameterOrder": [ "parent" ] }, "search": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "location": "query" }, "orderBy": { "description": "Optional. The order by expression to order authorized views listed in the response.", "location": "query", "type": "string" }, "query": { "description": "Optional. The query expression to search authorized views.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/authorizedViews:search", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "description": "SearchAuthorizedViewSets", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" } }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "path": "v1alpha1/{+parent}/authorizedViews", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create AuthorizedView", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "description": "Required. The parent resource of the AuthorizedView." }, "authorizedViewId": { "type": "string", "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST" }, "setIamPolicy": { "path": "v1alpha1/{+resource}:setIamPolicy", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string" } } }, "queryMetrics": { "parameterOrder": [ "location" ], "path": "v1alpha1/{+location}:queryMetrics", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "description": "Query metrics.", "httpMethod": "POST", "parameters": { "location": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "httpMethod": "PATCH", "description": "Updates an AuthorizedView.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string", "required": true, "location": "path" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "get": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "parameters": { "name": { "location": "path", "description": "Required. The name of the AuthorizedView to get.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "description": "Get AuthorizedView", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "generativeInsights": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "location": "path", "type": "string" } }, "path": "v1alpha1/{+location}:generativeInsights", "parameterOrder": [ "location" ], "httpMethod": "POST", "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List AuthorizedViewSets", "path": "v1alpha1/{+parent}/authorizedViews", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "type": "string", "description": "Optional. The order by expression to order authorized views listed in the response.", "location": "query" }, "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned." }, "pageToken": { "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "description": "Optional. The filter expression to filter authorized views listed in the response.", "type": "string", "location": "query" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", "httpMethod": "GET" } } } } }, "assessmentRules": { "methods": { "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an assessment rule.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "parameters": { "updateMask": { "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}" } }, "path": "v1alpha1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.assessmentRules.list", "path": "v1alpha1/{+parent}/assessmentRules", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "location": "query" }, "parent": { "description": "Required. The parent resource of the assessment rules.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" }, "description": "Lists assessment rules.", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules" }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "parameterOrder": [ "parent" ], "parameters": { "assessmentRuleId": { "type": "string", "description": "Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "location": "query" }, "parent": { "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Creates an assessment rule.", "path": "v1alpha1/{+parent}/assessmentRules", "id": "contactcenterinsights.projects.locations.assessmentRules.create" }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the assessment rule to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.assessmentRules.delete", "description": "Deletes an assessment rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "description": "Get an assessment rule.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "type": "string", "description": "Required. The name of the assessment rule to get." } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.assessmentRules.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" } } }, "qaScorecards": { "methods": { "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaScorecard." }, "qaScorecardId": { "description": "Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string", "location": "query" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "path": "v1alpha1/{+parent}/qaScorecards", "description": "Create a QaScorecard." }, "patch": { "parameters": { "updateMask": { "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "type": "string", "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "httpMethod": "PATCH", "path": "v1alpha1/{+name}", "description": "Updates a QaScorecard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.list", "path": "v1alpha1/{+parent}/qaScorecards", "description": "Lists QaScorecards.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data." }, "qaScorecardSources": { "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment.", "The scorecard is derived from the custom intent taxonomy. Customers can edit question content, but cannot delete the scorecard or add/remove questions." ], "repeated": true, "type": "string", "location": "query", "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ], "description": "Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards of one or more sources." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the scorecards.", "required": true, "location": "path" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "httpMethod": "GET", "description": "Gets a QaScorecard.", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "parameters": { "name": { "type": "string", "description": "Required. The name of the QaScorecard to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "required": true } }, "id": "contactcenterinsights.projects.locations.qaScorecards.get", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The name of the QaScorecard to delete.", "type": "string", "location": "path", "required": true }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none." } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "description": "Deletes a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "revisions": { "methods": { "undeploy": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to undeploy.", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Undeploy a QaScorecardRevision.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy", "path": "v1alpha1/{+name}:undeploy" }, "get": { "description": "Gets a QaScorecardRevision.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the QaScorecardRevision to get.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } }, "path": "v1alpha1/{+name}", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a QaScorecardRevision.", "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "description": "Required. The name of the QaScorecardRevision to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "location": "path", "required": true }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete" }, "deploy": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" }, "path": "v1alpha1/{+name}:deploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "httpMethod": "POST", "description": "Deploy a QaScorecardRevision.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to deploy.", "location": "path", "type": "string" } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy" }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "path", "description": "Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data." }, "qaScorecardSources": { "description": "Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards Revisions from Scorecards of one or more sources.", "type": "string", "repeated": true, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ], "location": "query", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment.", "The scorecard is derived from the custom intent taxonomy. Customers can edit question content, but cannot delete the scorecard or add/remove questions." ] }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" } }, "path": "v1alpha1/{+parent}/revisions", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "description": "Lists all revisions under the parent QaScorecard." }, "create": { "description": "Creates a QaScorecardRevision.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "path": "v1alpha1/{+parent}/revisions", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The parent resource of the QaScorecardRevision.", "location": "path", "required": true }, "qaScorecardRevisionId": { "type": "string", "location": "query", "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create" }, "tuneQaScorecardRevision": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "path": "v1alpha1/{+parent}:tuneQaScorecardRevision", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "description": "Fine tune one or more QaModels.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource for new fine tuning job instance.", "location": "path" } }, "httpMethod": "POST" } }, "resources": { "qaQuestions": { "methods": { "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "required": true, "type": "string", "location": "path" }, "updateMask": { "location": "query", "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", "format": "google-fieldmask", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", "description": "Updates a QaQuestion.", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "delete": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "description": "Deletes a QaQuestion.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the QaQuestion to delete.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "get": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "description": "Required. The name of the QaQuestion to get.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "description": "Gets a QaQuestion.", "parameterOrder": [ "name" ] }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Create a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "path": "v1alpha1/{+parent}/qaQuestions", "parameters": { "qaQuestionId": { "type": "string", "description": "Optional. A unique ID for the new question. This ID will become the final component of the question's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the QaQuestion." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "list": { "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "path": "v1alpha1/{+parent}/qaQuestions", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "required": true, "description": "Required. The parent resource of the questions.", "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data.", "location": "query" } }, "description": "Lists QaQuestions.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } }, "encryptionSpec": { "methods": { "initialize": { "path": "v1alpha1/{+name}:initialize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize" } } }, "phraseMatchers": { "methods": { "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "parameters": { "name": { "type": "string", "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "required": true }, "updateMask": { "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string", "location": "query" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "description": "Updates a phrase matcher.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "list": { "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "description": "Lists phrase matchers.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the phrase matcher.", "required": true, "location": "path" }, "pageToken": { "description": "The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." } }, "httpMethod": "GET", "path": "v1alpha1/{+parent}/phraseMatchers" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1alpha1/{+parent}/phraseMatchers", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "parameters": { "parent": { "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "description": "Creates a phrase matcher.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "delete": { "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the phrase matcher to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "required": true } }, "description": "Deletes a phrase matcher.", "httpMethod": "DELETE" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "parameters": { "name": { "description": "Required. The name of the phrase matcher to get.", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "description": "Gets a phrase matcher.", "httpMethod": "GET" } } }, "dashboards": { "methods": { "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "id": "contactcenterinsights.projects.locations.dashboards.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the dashboard to get.", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets a Dashboard." }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.dashboards.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` * `description`", "type": "string" }, "name": { "location": "path", "required": true, "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "description": "Updates a Dashboard.", "httpMethod": "PATCH" }, "delete": { "id": "contactcenterinsights.projects.locations.dashboards.delete", "description": "Deletes a Dashboard.", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the dashboard to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100.", "type": "integer", "location": "query", "format": "int32" }, "orderBy": { "description": "Optional. The order by expression to order dashboards listed in the response.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filter expression to filter dashboards listed in the response." }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the dashboards.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha1/{+parent}/dashboards", "id": "contactcenterinsights.projects.locations.dashboards.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "description": "Lists Dashboards.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards" }, "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/dashboards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the dashboard.", "type": "string" }, "dashboardId": { "description": "Optional. A unique ID for the new Dashboard. This ID will become the final component of the Dashboard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string", "location": "query" } }, "httpMethod": "POST" } }, "resources": { "charts": { "methods": { "delete": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the chart to delete.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$" } }, "httpMethod": "DELETE", "description": "Deletes a Chart.", "id": "contactcenterinsights.projects.locations.dashboards.charts.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "contactcenterinsights.projects.locations.dashboards.charts.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" }, "path": "v1alpha1/{+parent}/charts", "parameters": { "parent": { "description": "Required. The parent resource of the charts.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Charts." }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "httpMethod": "PATCH", "description": "Updates a Chart.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "required": true, "location": "path", "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "updateMask": { "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "format": "google-fieldmask", "type": "string", "location": "query" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "path": "v1alpha1/{+name}" }, "create": { "description": "Creates a Chart.", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "parameters": { "chartId": { "type": "string", "location": "query", "description": "Optional. A unique ID for the new Chart. This ID will become the final component of the Chart's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`." }, "parent": { "type": "string", "location": "path", "description": "Required. The parent resource of the chart.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "required": true } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "path": "v1alpha1/{+parent}/charts", "id": "contactcenterinsights.projects.locations.dashboards.charts.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "Gets a Chart.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the chart to get.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "required": true, "location": "path", "type": "string" } }, "path": "v1alpha1/{+name}", "httpMethod": "GET" } } } } }, "analysisRules": { "methods": { "create": { "id": "contactcenterinsights.projects.locations.analysisRules.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`", "required": true, "type": "string", "location": "path" } }, "path": "v1alpha1/{+parent}/analysisRules", "parameterOrder": [ "parent" ], "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "description": "Creates a analysis rule.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "id": "contactcenterinsights.projects.locations.analysisRules.list", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource of the analysis rules.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.", "location": "query" } }, "description": "Lists analysis rules.", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the analysis rule to delete." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a analysis rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.analysisRules.delete", "parameterOrder": [ "name" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a analysis rule.", "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.analysisRules.patch", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "required": true, "location": "path" }, "updateMask": { "type": "string", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "location": "query", "format": "google-fieldmask" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "parameterOrder": [ "name" ] }, "get": { "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the AnalysisRule to get.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "required": true } }, "id": "contactcenterinsights.projects.locations.analysisRules.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "Get a analysis rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "baseUrl": "https://contactcenterinsights.googleapis.com/", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "contactcenterinsights:v1alpha1", "canonicalName": "Contactcenterinsights", "title": "Contact Center AI Insights API", "servicePath": "", "parameters": { "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean" }, "quotaUser": { "location": "query", "description": "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.", "type": "string" }, "$.xgafv": { "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format." }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "location": "query", "type": "string" }, "key": { "location": "query", "description": "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.", "type": "string" }, "callback": { "location": "query", "description": "JSONP", "type": "string" } }, "protocol": "rest", "revision": "20261002", "kind": "discovery#restDescription", "discoveryVersion": "v1", "ownerDomain": "google.com", "ownerName": "Google" }