{ "rootUrl": "https://contactcenterinsights.googleapis.com/", "ownerDomain": "google.com", "version": "v1", "discoveryVersion": "v1", "id": "contactcenterinsights:v1", "kind": "discovery#restDescription", "revision": "20260910", "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "canonicalName": "Contactcenterinsights", "title": "Contact Center AI Insights API", "servicePath": "", "version_module": true, "schemas": { "GoogleCloudContactcenterinsightsV1Note": { "type": "object", "properties": { "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the note was created." }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the note was last updated." }, "noteCreator": { "$ref": "GoogleCloudContactcenterinsightsV1UserInfo", "description": "Output only. The user that created the note.", "readOnly": true }, "conversationTurnNote": { "$ref": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", "description": "The note is associated with a conversation turn." }, "content": { "description": "The note content.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Note", "description": "The conversation assessment note resource." }, "GoogleIamV1Policy": { "type": "object", "properties": { "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "GoogleIamV1AuditConfig" }, "type": "array" }, "version": { "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).", "format": "int32", "type": "integer" }, "etag": { "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.", "type": "string", "format": "byte" }, "bindings": { "type": "array", "items": { "$ref": "GoogleIamV1Binding" }, "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`." } }, "id": "GoogleIamV1Policy", "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/)." }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "type": "object", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "type": "string", "description": "Optional. The label value." } }, "description": "Metadata about conversation labels.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource": { "properties": { "format": { "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format which will be ingested.", "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "type": "string" }, "objectUri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource", "description": "Google Cloud Storage Object details to get the feedback label file from." }, "GoogleCloudCesV1mainImage": { "type": "object", "properties": { "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" }, "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": { "description": "Optional. The alternative text for the image.", "type": "string" } }, "id": "GoogleCloudCesV1mainImage", "description": "Represents an image input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse", "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" }, "type": "array" }, "transcript": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "description": "The transcript of the generative insights conversation." } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "description": "Response for an export insights operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "type": "object", "properties": { "dialogflowConversation": { "type": "string", "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}" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowSource" }, "GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig": { "id": "GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig", "description": "Configuration for diagnostic metrics.", "type": "object", "properties": { "metrics": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1MetricDefinition" }, "description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "description": "A thought part.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "properties": { "text": { "type": "string", "description": "Optional. The thought or reasoning text." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel", "description": "Required. The issue model to create." } }, "description": "The request to create an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1StreamChatResponse": { "description": "Response from streaming chat.", "properties": { "eventTime": { "format": "google-datetime", "type": "string", "description": "The time when the event occurred." }, "eventId": { "type": "string", "description": "The unique ID of the event." }, "statusMessage": { "description": "A status message.", "type": "string" }, "chunk": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantChunk", "description": "A chunk of the assistant response message." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1StreamChatResponse" }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "properties": { "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "confidenceScore": { "format": "double", "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)." }, "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "suggestion": { "type": "string", "description": "The content of the suggestion." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "properties": { "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" }, "customerChannel": { "format": "int32", "description": "The audio channel that contains the customer.", "type": "integer" } }, "description": "Call-specific metadata.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainFeedbackLabel": { "type": "object", "properties": { "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}`" }, "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" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "createTime": { "description": "Output only. Create time of the label.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "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.", "id": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "GoogleCloudContactcenterinsightsV1mainDimension": { "properties": { "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" }, "agentDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, "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." ] }, "issueDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension." }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension." }, "conversationalAgentsPlaybookDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true }, "mediumDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the QA question-answer dimension." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimension", "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." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem", "description": "An item in a list.", "properties": { "subItems": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "description": "Optional. Nested sub-items." }, "text": { "description": "Optional. The text of the list item.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "properties": { "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer" }, "knowledgeSearchResultCount": { "type": "integer", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "format": "int32" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback." }, "averageClientSentimentScore": { "type": "number", "format": "float", "description": "The average client's sentiment score." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "format": "double", "type": "number" }, "knowledgeAssistUriClickRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "avgConversationClientTurnSentimentEma": { "type": "number", "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "format": "double" }, "averageSummarizationSuggestionEditDistance": { "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.", "type": "number" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "type": "integer", "description": "The number of conversations transferred to a human agent." }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "format": "int32", "type": "integer" }, "dialogflowConversationsEscalationRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent." }, "averageCustomerSatisfactionRating": { "type": "number", "description": "The average customer satisfaction rating.", "format": "double" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "dialogflowAverageWebhookLatency": { "format": "double", "description": "Average latency of dialogflow webhook calls.", "type": "number" }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "format": "int32", "type": "integer" }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "type": "number", "format": "double" }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "format": "double", "type": "number" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "averageTurnCount": { "description": "The average turn count.", "type": "number", "format": "float" }, "dialogflowWebhookFailureRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow webhook calls that failed." }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "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.", "format": "double", "type": "number" }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "int32", "type": "integer" }, "knowledgeSearchUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "type": "number", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion." }, "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.", "type": "number", "format": "double" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "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" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "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)." }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "format": "int32", "type": "integer" }, "knowledgeSearchNegativeFeedbackRatio": { "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "format": "double" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "averageQaQuestionNormalizedScore": { "type": "number", "format": "double", "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." }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "format": "int32" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "conversationAiCoachSuggestionCount": { "type": "integer", "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions." }, "averageDuration": { "type": "string", "format": "google-duration", "description": "The average duration." }, "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" }, "aiCoachSuggestionAgentUsageRatio": { "type": "number", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "format": "double" }, "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." }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "format": "int32", "type": "integer" }, "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" }, "conversationCount": { "description": "The conversation count.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number" }, "summarizationSuggestionEditRatio": { "type": "number", "description": "Proportion of summarization suggestions that were manually edited.", "format": "double" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations.", "type": "object" }, "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", "description": "The metadata from querying metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards.", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "type": "object", "properties": { "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." }, "agentTeam": { "type": "string", "description": "Optional. A user-specified string representing the agent's team." }, "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": { "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.", "type": "string" }, "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." }, "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" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse": { "properties": { "labelResult": { "description": "The result of the test auto labeling rule.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse", "description": "The response message for testing auto labeling rules.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse", "type": "object", "description": "Wrapper for storing the generative response for a chart.", "properties": { "textOutput": { "type": "string", "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." }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "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." }, "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." }, "chartSpec": { "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" }, "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "type": "object", "description": "Information about the issue.", "properties": { "score": { "type": "number", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "format": "double" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" }, "GoogleTypeMoney": { "properties": { "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "units": { "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string", "format": "int64" }, "nanos": { "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.", "format": "int32" } }, "type": "object", "id": "GoogleTypeMoney", "description": "Represents an amount of money with its currency type." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "type": "object", "description": "Information about an agent involved in the conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo", "properties": { "agentType": { "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 agent type, e.g. HUMAN_AGENT.", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "displayName": { "type": "string", "description": "The agent's name." }, "location": { "description": "The agent's location.", "type": "string" }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "deploymentId": { "type": "string", "description": "The agent's deployment ID. Only applicable to automated agents." }, "versionId": { "type": "string", "description": "The agent's version ID. Only applicable to automated agents." }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "deploymentDisplayName": { "type": "string", "description": "The agent's deployment display name. Only applicable to automated agents." }, "team": { "type": "string", "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true }, "teams": { "description": "User-specified strings representing the agent's teams.", "type": "array", "items": { "type": "string" } }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." } } }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "description": "The response for listing all feedback labels.", "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "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": { "type": "array", "description": "The feedback labels that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation": { "type": "object", "properties": { "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage" } }, "updateTime": { "type": "string", "format": "google-datetime", "description": "The update time of the conversation." }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "type": "string", "description": "The create time of the conversation.", "format": "google-datetime" } }, "description": "The conversation used to generate the chart.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint": { "description": "The current chart checkpoint state.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint", "type": "object", "properties": { "revisionId": { "description": "The revision id of the chart.", "type": "string" }, "sessionId": { "type": "string", "description": "The session id of the chart." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "description": "A text output message from the system.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "text": { "description": "The parts of the message.", "items": { "type": "string" }, "type": "array" }, "textType": { "description": "The type of the text message.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "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": "object" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "description": "Response from import issue model" }, "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { "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" }, "name": { "type": "string", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec" } }, "type": "object", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "properties": { "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The update time of the conversation." }, "createTime": { "description": "Output only. The create time of the conversation.", "type": "string", "readOnly": true, "format": "google-datetime" }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "description": "Ordered list of messages, including user inputs and system responses.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "properties": { "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "Data specifying sentiment." }, "channelTag": { "format": "int32", "description": "The channel of the audio that the data applies to.", "type": "integer" } }, "type": "object", "description": "One channel of conversation-level sentiment data." }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "properties": { "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1SampleRule": { "properties": { "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "format": "int64", "type": "string" }, "dimension": { "type": "string", "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'." }, "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number", "format": "double" }, "conversationFilter": { "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.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleRule", "description": "Message for sampling conversations." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "properties": { "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" }, "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", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudCesV1mainToolCall": { "type": "object", "id": "GoogleCloudCesV1mainToolCall", "properties": { "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "GoogleCloudCesV1mainToolsetTool" }, "parentToolCallId": { "readOnly": true, "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." }, "displayName": { "type": "string", "readOnly": true, "description": "Output only. Display name of the tool." }, "id": { "type": "string", "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse." }, "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.", "type": "string", "readOnly": true }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" } }, "description": "Request for the client or the agent to execute the specified tool." }, "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { "description": "Agent Assist Article Suggestion data.", "id": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "properties": { "uri": { "description": "Article URI.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "confidenceScore": { "type": "number", "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" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "title": { "type": "string", "description": "Article title." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from." } }, "type": "object" }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "type": "object", "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.", "properties": { "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." }, "title": { "type": "string", "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." }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { "type": "object", "properties": { "customerChannel": { "type": "integer", "description": "The audio channel that contains the customer.", "format": "int32" }, "agentChannel": { "type": "integer", "format": "int32", "description": "The audio channel that contains the agent." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "description": "Call-specific metadata." }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData", "description": "Dialogflow interaction data.", "type": "object", "properties": { "dialogflowIntentId": { "type": "string", "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}" }, "confidence": { "format": "float", "type": "number", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } } }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", "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." } }, "description": "The request to initialize a location-level encryption specification.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AutoLabelingRule": { "id": "GoogleCloudContactcenterinsightsV1AutoLabelingRule", "properties": { "labelKeyType": { "description": "The type of the label key.", "type": "string", "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ] }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string" }, "labelKey": { "type": "string", "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." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this rule was created." }, "active": { "description": "Whether the rule is active.", "type": "boolean" }, "updateTime": { "description": "Output only. The most recent time at which the rule was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition" }, "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": { "type": "string", "description": "The description of the rule." }, "displayName": { "type": "string", "description": "The user-provided display name of the rule." } }, "type": "object", "description": "Rule for auto-labeling conversations." }, "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", "format": "google-fieldmask", "type": "string" }, "qaQuestionTag": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "description": "Required. The QaQuestionTag to update." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "description": "A custom payload part.", "type": "object", "properties": { "payloadType": { "description": "Optional. Type identifier for the payload.", "type": "string" }, "payload": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Arbitrary structured payload.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart" }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "type": "object", "description": "Metadata for creating an issue model." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse", "properties": {}, "type": "object", "description": "The response for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1NoteAssessmentNote": { "id": "GoogleCloudContactcenterinsightsV1NoteAssessmentNote", "type": "object", "description": "A note about the entire parent assessment.", "properties": {} }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "properties": { "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" }, "displayed": { "type": "boolean", "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI." }, "correctnessLevel": { "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.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "properties": { "text": { "type": "string", "description": "Optional. Anchor or display text." }, "uri": { "description": "Optional. Target URI.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "description": "A link part." }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "type": "object", "properties": { "ingestConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Output only. Statistics for IngestConversations operation." }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "description": "Output only. The original request for ingest." }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" } }, "sampledConversations": { "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" } }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval": { "description": "A single interval in a time series.", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "The start time of this interval." }, "conversationCount": { "format": "int32", "description": "The number of conversations created in this interval.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "properties": { "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" }, "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." }, "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." }, "feedbackLabelType": { "type": "string", "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." }, "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." }, "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" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "A sheets document destination." } }, "type": "object", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "properties": { "createTime": { "format": "google-datetime", "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." }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "systemMessageWrapper": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." } }, "type": "object", "description": "The message in the conversation.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "properties": { "fullConversationCorrelationId": { "type": "string", "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of." }, "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": { "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" ] } }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string", "readOnly": true } }, "description": "Info for correlating across conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1PhraseMatcher": { "description": "The phrase matcher resource.", "id": "GoogleCloudContactcenterinsightsV1PhraseMatcher", "properties": { "activationUpdateTime": { "description": "Output only. The most recent time at which the activation status was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the phrase matcher was updated.", "type": "string", "readOnly": true }, "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" }, "versionTag": { "type": "string", "description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`." }, "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" }, "type": { "description": "Required. The type of this phrase matcher.", "type": "string", "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." ], "enum": [ "PHRASE_MATCHER_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ] }, "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", "type": "string", "readOnly": true }, "phraseMatchRuleGroups": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup" }, "description": "A list of phase match rule groups that are included in this matcher." }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "roleMatch": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_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." ], "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.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "properties": { "endTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The original request for deletion." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "properties": { "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "smartReply": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "description": "Agent Assist Smart Reply data." }, "articleSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "cesTurnAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", "description": "The CES turn annotation." }, "faqAnswer": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", "description": "Agent Assist FAQ answer data." }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" } }, "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "description": "Dialogflow interaction data.", "type": "object", "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" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig", "properties": { "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" }, "agentId": { "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`.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { "type": "object", "description": "A wrapper for holding the audio for any given turn.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "type": "string", "description": "The Cloud Storage URI of the audio for any given turn." }, "audioDuration": { "format": "google-duration", "description": "The duration of the audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "type": "object", "description": "Metadata about the issue dimension.", "properties": { "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueModelId": { "type": "string", "description": "The parent issue model ID." }, "issueId": { "type": "string", "description": "The issue ID." } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "properties": { "p50": { "description": "The 50th percentile value.", "format": "double", "type": "number" }, "p90": { "format": "double", "description": "The 90th percentile value.", "type": "number" }, "p99": { "description": "The 99th percentile value.", "format": "double", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "properties": { "successfulSampleCount": { "type": "integer", "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true, "format": "int32" }, "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." } }, "description": "Statistics for SampleConversations operation.", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "properties": { "dataPoints": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series .", "type": "array" } }, "description": "A time series of metric values.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "type": "object", "description": "A table part.", "properties": { "rows": { "description": "Optional. Table rows.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow" } }, "title": { "description": "Optional. Optional title for the table.", "type": "string" }, "headers": { "type": "array", "description": "Optional. Table column headers.", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", "description": "The CES diagnostic information.", "properties": { "rootSpan": { "$ref": "GoogleCloudCesV1mainSpan", "description": "The root span of the action processing." }, "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", "description": "Aggregated statistics about an issue.", "properties": { "displayName": { "type": "string", "description": "Display name of the issue." }, "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "type": "string", "format": "int64" }, "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata": { "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "properties": { "id": { "type": "string", "description": "The unique identifier of the intent." }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "properties": { "customerSatisfactionRating": { "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer" }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "agentInfo": { "type": "array", "description": "Information about agents involved in the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" } }, "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "type": "string", "format": "google-duration" }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata", "description": "Conversation metadata related to quality management.", "type": "object" }, "GoogleCloudCesV1mainToolsetTool": { "id": "GoogleCloudCesV1mainToolsetTool", "description": "A tool that is created from a toolset.", "properties": { "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}`" }, "toolId": { "type": "string", "description": "Optional. The tool ID to filter the tools to retrieve the schema for." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "type": "object", "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." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Required. The medium transcript objects represent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QaQuestion": { "id": "GoogleCloudContactcenterinsightsV1QaQuestion", "type": "object", "description": "A single question to be scored by the Insights QA feature.", "properties": { "answerChoices": { "type": "array", "description": "A list of valid answers to the question, which the LLM must choose from.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice" } }, "name": { "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "type": "string" }, "predefinedQuestionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig", "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined." }, "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "answerInstructions": { "description": "Instructions describing how to determine the answer.", "type": "string" }, "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": "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions" }, "updateTime": { "description": "Output only. The most recent time at which the question was updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "questionType": { "enum": [ "QA_QUESTION_TYPE_UNSPECIFIED", "CUSTOMIZABLE", "PREDEFINED" ], "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." ], "description": "The type of question.", "type": "string" }, "order": { "format": "int32", "description": "Defines the order of the question within its parent scorecard revision.", "type": "integer" }, "tags": { "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.", "type": "array", "items": { "type": "string" } }, "abbreviation": { "description": "Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., \"Greeting\".", "type": "string" }, "metrics": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionMetrics", "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." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this question was created." } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "type": "object", "description": "A suggestion chips part.", "properties": { "chips": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "description": "Optional. List of suggestion chips." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" }, "GoogleCloudContactcenterinsightsV1Settings": { "properties": { "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "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." }, "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." }, "screenRecordingBucketUri": { "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.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. The time at which the settings were last updated.", "format": "google-datetime", "readOnly": true }, "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" }, "createTime": { "description": "Output only. The time at which the settings was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisConfig": { "description": "Default analysis settings.", "$ref": "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig" }, "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" }, "conversationTtl": { "format": "google-duration", "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." }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", "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." }, "pubsubNotificationSettings": { "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" }, "type": "object" }, "diagnosticMetricConfig": { "$ref": "GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig", "description": "Optional. Configuration for diagnostic metrics." } }, "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).", "id": "GoogleCloudContactcenterinsightsV1Settings" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "description": "A suggestion chips part.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "type": "object", "properties": { "chips": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "description": "Optional. List of suggestion chips.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "description": "A media part.", "properties": { "uri": { "description": "Optional. URI or URL to the media.", "type": "string" }, "alternativeText": { "type": "string", "description": "Optional. Alternative text description." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "properties": { "summarizationModel": { "description": "Default summarization model to be used.", "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." ], "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDeprecated": [ false, true, true ], "type": "string" }, "conversationProfile": { "type": "string", "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } }, "type": "object", "description": "Configuration for summarization.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", "type": "object", "properties": { "qaQuestionIds": { "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.", "items": { "type": "string" } }, "createTime": { "description": "Output only. The time at which the question tag was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "displayName": { "type": "string", "description": "Required. A user-specified display name for the tag." }, "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." }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The most recent time at which the question tag was updated.", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "type": "object", "description": "The response for a bulk analyze conversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse", "properties": { "failedAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of failed analyses." }, "successfulAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of successful analyses." } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "description": "Google Cloud Storage Object URI to get the issue model file from.", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { "properties": { "customMetadataKeys": { "type": "array", "items": { "type": "string" }, "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." }, "bucketUri": { "type": "string", "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`." }, "bucketObjectType": { "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." ], "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`." }, "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" }, "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`." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "description": "The request to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "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." }, "format": { "description": "Required. File format in which the labels will be exported.", "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "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." ] }, "recordsPerFileCount": { "description": "Optional. The number of records per file. Applicable for either format.", "type": "string", "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": { "type": "boolean", "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "type": "object", "description": "The data for an interruption annotation.", "id": "GoogleCloudContactcenterinsightsV1InterruptionData", "properties": {} }, "GoogleCloudContactcenterinsightsV1QueryInterval": { "properties": { "endTime": { "format": "google-datetime", "description": "Required. The end time of the time window.", "type": "string" }, "startTime": { "type": "string", "description": "Required. The start time of the time window.", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1QueryInterval", "type": "object", "description": "A time window for querying conversations." }, "GoogleLongrunningListOperationsResponse": { "properties": { "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.", "items": { "type": "string" }, "type": "array" }, "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object", "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "GoogleCloudContactcenterinsightsV1mainIssue": { "properties": { "displayName": { "description": "The representative name for the issue.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "sampleUtterances": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. Resource names of the sample representative utterances that match to this issue." }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time at which this issue was created." }, "displayDescription": { "type": "string", "description": "Representative description of the issue." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time that this issue was updated.", "readOnly": true } }, "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1mainIssue", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "properties": { "listType": { "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "type": "string", "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ], "description": "Optional. The type of list." }, "items": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "description": "Optional. List items." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart", "description": "A list part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse", "properties": {}, "type": "object", "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest", "properties": { "filter": { "type": "string", "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." }, "conversations": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations", "description": "Optional. A list of conversations to test against." }, "correlationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationConfig", "description": "Required. The correlation config to test." }, "maxSampleCount": { "format": "int32", "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.", "type": "integer" } }, "description": "The request to test correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse", "description": "The response for querying performance overview.", "type": "object", "properties": { "summaryText": { "type": "string", "description": "The summary text of the performance." } } }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "description": "The conversation source, which is a combination of transcript and audio.", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "properties": { "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource", "description": "A Cloud Storage location specification for the audio and transcript." }, "turnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AssistantChunk": { "id": "GoogleCloudContactcenterinsightsV1AssistantChunk", "properties": { "text": { "description": "Optional. Text data.", "type": "string" } }, "description": "A chunk of data in an assistant message.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "runIssueModelAnnotator": { "type": "boolean", "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "issueModels": { "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.", "items": { "type": "string" } }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "summarizationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "description": "Configuration for the summarization annotator." }, "runSentimentAnnotator": { "type": "boolean", "description": "Whether to run the sentiment annotator." }, "runQaAnnotator": { "type": "boolean", "description": "Whether to run the QA annotator." }, "runSummarizationAnnotator": { "type": "boolean", "description": "Whether to run the summarization annotator." }, "runPhraseMatcherAnnotator": { "type": "boolean", "description": "Whether to run the active phrase matcher annotator(s)." }, "runSilenceAnnotator": { "type": "boolean", "description": "Whether to run the silence annotator." }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "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" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "type": "object", "properties": { "createTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation was created.", "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "readOnly": true }, "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, "format": "google-datetime", "type": "string" }, "analysisOperation": { "type": "string", "readOnly": true, "description": "Output only. The operation name for a successfully created analysis operation, if any." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "type": "object", "description": "The response to an SampleConversations operation.", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "type": "object", "description": "Configuration that applies to all conversations.", "properties": { "agentId": { "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`.", "type": "string" }, "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" }, "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.", "format": "int32", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { "properties": { "issueMatches": { "deprecated": true, "additionalProperties": { "format": "int32", "type": "integer" }, "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.", "type": "object" }, "customHighlighterMatches": { "description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "averageTurnCount": { "type": "integer", "description": "The average number of turns per conversation.", "format": "int32" }, "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": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" } }, "averageDuration": { "type": "string", "format": "google-duration", "description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration." }, "conversationCountTimeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", "description": "A time series representing the count of conversations created over time that match that requested filter criteria." }, "conversationCount": { "description": "The total number of conversations.", "type": "integer", "format": "int32" }, "smartHighlighterMatches": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse", "description": "The response for calculating conversation statistics." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "description": "The request to delete an issue model.", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "description": "The data for an interruption annotation.", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec" }, "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" } }, "type": "object", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "type": "object", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "properties": { "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "text": { "description": "The text of this segment.", "type": "string" }, "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" }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "The sentiment for this transcript segment." }, "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.", "type": "integer", "format": "int32" }, "parts": { "type": "array", "description": "Optional. The structured parts that make up this transcript segment.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart" } }, "words": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, "type": "array", "description": "A list of the word-specific information for each word in the segment." }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "confidence": { "format": "float", "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." }, "segmentParticipant": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "description": "The participant of this segment." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AssessmentRule": { "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AssessmentRule", "properties": { "updateTime": { "description": "Output only. The most recent time at which this assessment rule was updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "sampleRule": { "description": "The sample rule for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive.", "type": "boolean" }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1ScheduleInfo" }, "name": { "type": "string", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}" }, "displayName": { "description": "Display Name of the assessment rule.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which this assessment rule was created." } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "type": "object", "properties": { "playbookId": { "type": "string", "description": "Optional. The dialogflow playbook ID." }, "playbookDisplayName": { "type": "string", "description": "Optional. The dialogflow playbook display name." } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Metadata about the Conversational Agents playbook dimension." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag.", "properties": { "tag": { "type": "string", "description": "Tag name." }, "averageTagNormalizedScore": { "format": "double", "description": "Average tag normalized score per tag.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "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": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the label." }, "name": { "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update time of the label." }, "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}`" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "type": "object", "properties": { "score": { "format": "double", "type": "number", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." }, "displayName": { "type": "string", "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then." }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "description": "Information about the issue." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata", "properties": { "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "properties": { "uri": { "type": "string", "description": "Optional. Target URI." }, "text": { "description": "Optional. Anchor or display text.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "type": "object", "description": "A link part." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage": { "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "systemMessage": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage", "description": "A message from the system in response to the user." }, "createTime": { "type": "string", "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.", "format": "google-datetime" }, "userMessage": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage", "description": "A message from the user that is interacting with the system." } }, "description": "The message in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessage" }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "description": "The data for an issue match annotation.", "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "properties": { "issueAssignment": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment", "description": "Information about the issue's assignment." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { "type": "object", "description": "Conversation summarization suggestion data.", "properties": { "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "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" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "generatorId": { "type": "string", "description": "Agent Assist generator ID." }, "confidence": { "format": "float", "description": "The confidence score of the summarization.", "type": "number" }, "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "properties": { "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "type": "object", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during export operation that might cause the operation output to be incomplete." }, "failedExportCount": { "format": "int32", "type": "integer", "description": "The number of conversations that failed to be exported." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string" }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "properties": { "text": { "description": "Optional. The text content.", "type": "string" } }, "description": "A text part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult", "type": "object", "properties": { "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" } }, "conversation": { "description": "The conversation resource name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "description": "The issue model resource.", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time at which this issue model was created.", "type": "string", "format": "google-datetime" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" }, "issueCount": { "readOnly": true, "description": "Output only. Number of issues in this issue model.", "type": "string", "format": "int64" }, "state": { "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "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." ] }, "languageCode": { "description": "Language of the model.", "type": "string" }, "modelType": { "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "type": "string", "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" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest": { "type": "object", "properties": { "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation", "description": "Required. Conversation data to test rules against." } }, "id": "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest", "description": "The request message for testing auto labeling rules." }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "properties": { "messages": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn." }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "description": "The CES diagnostic information.", "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "properties": { "sourceTitle": { "type": "string", "description": "Optional. The cited source title." }, "snippet": { "type": "string", "description": "Optional. Snippet of the cited text." }, "sourceUri": { "description": "Optional. The cited source URI.", "type": "string" } }, "description": "A citation part.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "properties": { "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata", "type": "object", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during deletion operation that might cause the operation output to be incomplete." }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "description": "Output only. The original request for delete." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "properties": { "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "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": { "description": "Output only. The time at which the question tag was created.", "format": "google-datetime", "type": "string", "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.", "type": "array", "items": { "type": "string" } }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the question tag was updated.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "description": "The request to delete conversations in bulk.", "properties": { "maxDeleteCount": { "format": "int32", "description": "Maximum number of conversations to delete.", "type": "integer" }, "filter": { "type": "string", "description": "Filter used to select the subset of conversations to delete." }, "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." }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "properties": { "uri": { "description": "Optional. URI or URL to the media.", "type": "string" }, "alternativeText": { "description": "Optional. Alternative text description.", "type": "string" } }, "description": "A media part.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "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.", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource", "properties": { "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "format": "double", "type": "number" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" } }, "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." ], "description": "What created the score.", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "type": "string" }, "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" }, "score": { "format": "double", "type": "number", "description": "The overall numerical score of the result." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "type": "object", "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." ], "description": "Default summarization model to be used.", "type": "string", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDeprecated": [ false, true, true ] }, "conversationProfile": { "type": "string", "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" }, "generator": { "type": "string", "description": "The resource name of the existing created generator. Format: projects//locations//generators/" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "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": { "userProvidedSqlQuery": { "type": "string", "description": "Optional. User provided SQL query" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec from LLM", "type": "object" }, "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "generatedSqlQuery": { "type": "string", "description": "Raw SQL from LLM, before templatization" }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A direct natural language response to the user message." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries", "description": "A time series representing conversations over time.", "properties": { "points": { "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.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval" } }, "intervalDuration": { "type": "string", "format": "google-duration", "description": "The duration of each interval." } } }, "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource": { "description": "Google Sheets document details to get the feedback label file from.", "type": "object", "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.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource" }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "description": "Agent Assist Smart Compose suggestion data.", "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "type": "object", "properties": { "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "format": "double", "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)." }, "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart", "properties": { "products": { "type": "array", "description": "Optional. List of products.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" } } }, "type": "object", "description": "A product collection part." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "description": "The original request for creation." }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" } }, "description": "Metadata for creating an issue.", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" } }, "description": "The response of testing correlation config." }, "GoogleTypeInterval": { "type": "object", "properties": { "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime", "type": "string" }, "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string", "format": "google-datetime" } }, "id": "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." }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "successfulIngestCount": { "format": "int32", "readOnly": true, "type": "integer", "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.", "readOnly": true, "type": "integer", "format": "int32" }, "duplicatesSkippedCount": { "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "readOnly": true, "type": "integer" }, "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "readOnly": true, "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { "properties": { "bucketUri": { "type": "string", "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`." }, "customMetadataKeys": { "items": { "type": "string" }, "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.", "type": "array" }, "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`." }, "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`." }, "bucketObjectType": { "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" ], "type": "string", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ] }, "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" } }, "type": "object", "description": "Configuration for Cloud Storage bucket sources.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "properties": { "skipValue": { "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.", "type": "boolean", "readOnly": true }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`." }, "potentialScore": { "format": "double", "type": "number", "description": "Output only. The maximum potential score of the question.", "readOnly": true }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "numValue": { "type": "number", "description": "Numerical value.", "format": "double" }, "key": { "type": "string", "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key." }, "score": { "type": "number", "format": "double", "readOnly": true, "description": "Output only. Numerical score of the answer." }, "strValue": { "description": "String value.", "type": "string" }, "normalizedScore": { "type": "number", "format": "double", "readOnly": true, "description": "Output only. Normalized score of the questions. Calculated as score / potential_score." } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "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.", "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource": { "properties": { "agentId": { "type": "string", "description": "Required. Agent id to query performance overview for." } }, "description": "The entity whose performance is being queried is a single agent.", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource", "type": "object" }, "GoogleCloudContactcenterinsightsV1ListNotesResponse": { "properties": { "notes": { "description": "The notes that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "type": "array" }, "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": "GoogleCloudContactcenterinsightsV1ListNotesResponse", "description": "The response of listing notes." }, "GoogleCloudCesV1mainSpan": { "type": "object", "description": "A span is a unit of work or a single operation during the request processing.", "id": "GoogleCloudCesV1mainSpan", "properties": { "childSpans": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "readOnly": true, "description": "Output only. The child spans that are nested under this span." }, "duration": { "readOnly": true, "format": "google-duration", "description": "Output only. The duration of the span.", "type": "string" }, "attributes": { "type": "object", "description": "Output only. Key-value attributes associated with the span.", "readOnly": true, "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "endTime": { "format": "google-datetime", "description": "Output only. The end time of the span.", "readOnly": true, "type": "string" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Output only. The start time of the span.", "readOnly": true }, "name": { "readOnly": true, "description": "Output only. The name of the span.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest": { "properties": {}, "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "type": "object", "properties": { "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "properties": { "cells": { "items": { "type": "string" }, "type": "array", "description": "Optional. The cell values in the row." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow", "description": "A row in a table.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "properties": { "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "description": "The results for each applicable constraint rule.", "type": "array" }, "conversationA": { "type": "string", "description": "The first conversation resource name." }, "conversationB": { "type": "string", "description": "The second conversation resource name." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "description": "An error that occurred during correlation for a specific conversation.", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "type": "object" }, "GoogleCloudContactcenterinsightsV1Dimension": { "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": { "qaScorecardDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the QA scorecard dimension." }, "qaQuestionDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension." }, "issueDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension." }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Output only. Metadata about the client sentiment category dimension." }, "qaQuestionAnswerDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true }, "agentDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, "dimensionKey": { "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." ], "description": "The key of the dimension.", "type": "string" }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "readOnly": true }, "conversationProfileDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "description": "Output only. Metadata about the conversation profile dimension.", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "readOnly": true }, "mediumDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" } }, "id": "GoogleCloudContactcenterinsightsV1Dimension", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "properties": { "userMessage": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "description": "A message from the user that is interacting with the system." }, "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.", "format": "google-datetime", "readOnly": true, "type": "string" }, "systemMessageWrapper": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage", "type": "object", "description": "The message in the conversation." }, "GoogleCloudContactcenterinsightsV1HoldData": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1HoldData", "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1AssistantSession": { "type": "object", "description": "Represents a conversation session with the Assistant Agent.", "id": "GoogleCloudContactcenterinsightsV1AssistantSession", "properties": { "displayName": { "description": "Optional. The display name of the session.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the session was created." }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantMessage" }, "description": "Optional. History of messages in the session." }, "requester": { "type": "string", "description": "Output only. The user who initiated the session.", "readOnly": true }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "IDLE" ], "description": "Output only. The status of the session.", "enumDescriptions": [ "Unspecified state.", "Agent is working.", "Waiting for user input." ], "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The time the session was last updated.", "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1MetricDefinition": { "properties": { "displayName": { "type": "string", "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "readOnly": true }, "sourceId": { "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "readOnly": true, "type": "string" } }, "description": "A definition for a metric to be calculated during analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1MetricDefinition" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "type": "object", "description": "A text output message from the system.", "properties": { "textType": { "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "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." }, "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "properties": { "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" }, "description": "Ordered list of messages, including user inputs and system responses.", "type": "array" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The create time of the conversation.", "readOnly": true }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The update time of the conversation." } }, "description": "The conversation transcript for the chart.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "type": "object", "description": "Agent Assist Smart Compose suggestion data.", "properties": { "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).", "type": "number", "format": "double" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "type": "object", "properties": { "wordIndex": { "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer" }, "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" } }, "description": "A point in a conversation that marks the start or the end of an annotation." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p90": { "type": "number", "description": "The 90th percentile value.", "format": "double" }, "p99": { "type": "number", "format": "double", "description": "The 99th percentile value." }, "p50": { "description": "The 50th percentile value.", "type": "number", "format": "double" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "type": "object", "properties": { "dataset": { "type": "string", "description": "The dataset used for sampling conversations." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata", "description": "Metadata for testing correlation config." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" } } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "readOnly": true }, "partialErrors": { "type": "array", "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "description": "Metadata for initializing a location-level encryption specification.", "type": "object" }, "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest": { "properties": {}, "type": "object", "description": "The request to undeploy a QaScorecardRevision", "id": "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata", "description": "The metadata from querying metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "description": "The data for an issue match annotation.", "type": "object", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse", "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { "description": "The call participant speaking for a given utterance.", "type": "object", "properties": { "userId": { "type": "string", "description": "A user-specified ID representing the participant." }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "dialogflowParticipant": { "type": "string", "deprecated": true, "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "role": { "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.", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse": { "properties": { "assessments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "description": "The assessments 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" } }, "id": "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse", "type": "object", "description": "The response of listing assessments." }, "GoogleCloudContactcenterinsightsV1ListAnalysesResponse": { "description": "The response to list analyses.", "id": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse", "type": "object", "properties": { "analyses": { "description": "The analyses that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Analysis" } }, "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." } } }, "GoogleCloudContactcenterinsightsV1ChartAction": { "description": "The action to be taken when the chart is clicked.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ChartAction", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1RedirectAction" }, "conversationFilter": { "description": "The conversation filter string.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "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": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The number of new conversations added during this sample operation." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "description": "The request to initialize a location-level encryption specification.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } }, "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata", "properties": {}, "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "type": "object", "description": "Metadata for initializing a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "type": "object", "properties": { "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" }, "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the constraint expression failed to evaluate." }, "ruleId": { "description": "The rule ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "description": "The original export request." }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "description": "Metadata used for export issue model." }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "type": "object", "properties": { "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "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).", "format": "float", "type": "number" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", "description": "Agent Assist frequently-asked-question answer data." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "type": "object", "description": "A text output message from the system.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "properties": { "texts": { "items": { "type": "string" }, "type": "array", "description": "The parts of the message." }, "type": { "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "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." ] } } }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "type": "object", "properties": { "issues": { "description": "All the matched issues.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } }, "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } }, "description": "Issue Modeling result on a conversation." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." }, "answerValue": { "type": "string", "description": "Optional. The full body of the question." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard." }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "properties": { "createTime": { "description": "Output only. The timestamp that the revision was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" }, "type": "array", "description": "List of all individual score sets." }, "qaAnswers": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "type": "array", "description": "Set of QaAnswers represented in the 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" }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" } }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "type": "object" }, "GoogleIamV1AuditConfig": { "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.", "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": { "items": { "$ref": "GoogleIamV1AuditLogConfig" }, "type": "array", "description": "The configuration for logging of each type of permission." } }, "type": "object", "id": "GoogleIamV1AuditConfig" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete." } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "description": "The results for each correlation rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1ListIssuesResponse": { "description": "The response of listing issues.", "id": "GoogleCloudContactcenterinsightsV1ListIssuesResponse", "type": "object", "properties": { "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1Issue" }, "description": "The issues that match the request.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainIntent": { "type": "object", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1mainIntent", "properties": { "id": { "type": "string", "description": "The unique identifier of the intent." }, "displayName": { "type": "string", "description": "The human-readable name of the intent." } } }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource", "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.", "properties": { "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer." }, "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": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "properties": { "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": { "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.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension.", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" } }, "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "type": "string" }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "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." }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1SentimentData": { "id": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "The data for a sentiment annotation.", "type": "object", "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": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number", "format": "float" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata", "type": "object", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "properties": { "request": { "description": "Output only. The original request for download.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "downloadStats": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "type": "object", "description": "The analysis resource.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string", "format": "google-datetime" }, "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": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "requestTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the analysis was requested.", "readOnly": true }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "description": "The data for an issue match annotation.", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "confidence": { "format": "float", "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." }, "text": { "type": "string", "description": "The text of this segment." }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "The sentiment for this transcript segment." }, "channelTag": { "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.", "type": "integer" }, "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" }, "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": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" }, "type": "array", "description": "A list of the word-specific information for each word in the segment." }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "parts": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart" }, "description": "Optional. The structured parts that make up this transcript segment." } } }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "description": "The request for updating a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "type": "object", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag" }, "updateMask": { "type": "string", "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" } } }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "properties": { "displayed": { "type": "boolean", "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI." }, "clicked": { "type": "boolean", "description": "Indicates whether an answer or item was clicked by the human agent." }, "correctnessLevel": { "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.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "properties": { "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "description": "The original request for undeployment." } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "properties": { "displayName": { "type": "string", "description": "The human-readable name of the intent." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition": { "properties": { "value": { "description": "CEL expression to be evaluated as the value.", "type": "string" }, "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." } }, "type": "object", "description": "Condition for auto-labeling conversations.", "id": "GoogleCloudContactcenterinsightsV1AutoLabelingRuleLabelingCondition" }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "properties": { "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "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" }, "confidenceScore": { "type": "number", "format": "float", "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)." }, "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." } }, "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "type": "object", "description": "Agent Assist frequently-asked-question answer data." }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "type": "boolean", "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." }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest", "description": "Request to import an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "properties": { "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" }, "type": "array", "description": "The results for each applicable constraint rule." }, "conversationA": { "type": "string", "description": "The first conversation resource name." }, "conversationB": { "description": "The second conversation resource name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", "type": "object", "description": "The result of testing a constraint expression on a pair of conversations." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "properties": { "fileNames": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Full name of the files written to Cloud storage." }, "processedObjectCount": { "format": "int32", "type": "integer", "description": "The number of objects processed during the download operation." }, "totalFilesWritten": { "description": "Total number of files written to the provided Cloud Storage bucket.", "format": "int32", "type": "integer" }, "successfulDownloadCount": { "type": "integer", "format": "int32", "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error." } }, "description": "Statistics for BulkDownloadFeedbackLabels operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "type": "object", "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": { "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "metadata": { "type": "object", "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": { "type": "string", "description": "The entity type.", "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`." ], "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ] }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The data for a sentiment annotation.", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, "score": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number", "format": "float" } }, "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": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "properties": { "partialErrors": { "type": "array", "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "description": "Output only. The original request for delete." } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "properties": { "transcriptSegments": { "type": "array", "description": "A list of sequential transcript segments that comprise the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" } } }, "description": "A message representing the transcript of a conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", "description": "Metadata for initializing a location-level encryption specification.", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "type": "object", "description": "The measure related to conversations.", "properties": { "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "knowledgeAssistUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "conversationTotalCustomerMessageCount": { "type": "integer", "description": "The customer message count.", "format": "int32" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "knowledgeAssistResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user." }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "format": "double", "type": "number" }, "averageSummarizationSuggestionEditDistance": { "format": "double", "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." }, "averageCustomerSatisfactionRating": { "format": "double", "type": "number", "description": "The average customer satisfaction rating." }, "summarizationSuggestionEditRatio": { "format": "double", "description": "Proportion of summarization suggestions that were manually edited.", "type": "number" }, "containedConversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were contained." }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "format": "int32", "type": "integer" }, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, "conversationSuggestedSummaryRatio": { "format": "double", "type": "number", "description": "Proportion of conversations that had a suggested summary." }, "aiCoachSuggestionAgentUsageRatio": { "type": "number", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "format": "double" }, "averageDuration": { "type": "string", "description": "The average duration.", "format": "google-duration" }, "knowledgeSearchPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "format": "int32", "type": "integer" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number" }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "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" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "dialogflowWebhookTimeoutRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow webhook calls that timed out." }, "conversationalAgentsAverageTtsLatency": { "type": "number", "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." }, "conversationTotalAgentMessageCount": { "type": "integer", "description": "The agent message count.", "format": "int32" }, "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." }, "conversationalAgentsAverageAudioInAudioOutLatency": { "type": "number", "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." }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "knowledgeAssistNegativeFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "int32", "type": "integer" }, "averageAgentSentimentScore": { "format": "float", "type": "number", "description": "The average agent's sentiment score." }, "knowledgeSearchAgentQuerySourceRatio": { "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "format": "double" }, "aaSupervisorMonitoredConversationsCount": { "type": "integer", "description": "The number of conversations scanned by the AA human supervisor.", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "type": "integer", "description": "The number of conversations transferred to a human agent." }, "knowledgeSearchSuggestedQuerySourceRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made." }, "aiCoachSuggestionAgentUsageCount": { "type": "integer", "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents." }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "type": "integer", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "type": "number", "description": "Average latency of dialogflow webhook calls.", "format": "double" }, "dialogflowInteractionsNoMatchRatio": { "type": "number", "description": "Proportion of dialogflow interactions that has no intent match for the input.", "format": "double" }, "conversationalAgentsAverageLlmCallLatency": { "type": "number", "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" }, "dialogflowConversationsEscalationRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent." }, "knowledgeSearchUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "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" }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "type": "number", "format": "double" }, "dialogflowWebhookFailureRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that failed.", "type": "number" }, "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "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" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "format": "double", "type": "number" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "conversationAiCoachSuggestionCount": { "format": "int32", "type": "integer", "description": "Count of conversations that has Ai Coach Suggestions." }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "properties": { "name": { "type": "string", "description": "Required. The issue model to undeploy." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "properties": { "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" }, "summarizationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "description": "Configuration for the summarization annotator." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "type": "boolean", "description": "Whether to run the active phrase matcher annotator(s)." }, "runQaAnnotator": { "type": "boolean", "description": "Whether to run the QA annotator." }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "issueModels": { "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", "items": { "type": "string" } }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "qaConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "description": "Configuration for the QA 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}", "items": { "type": "string" }, "type": "array" } }, "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "type": "object", "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time at which the analysis ended." } }, "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "description": "The result of an analysis." }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The original request for deletion." } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { "properties": { "chartSpec": { "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. User provided chart spec" }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A direct natural language response to the user message." }, "userProvidedSqlQuery": { "type": "string", "description": "Optional. User provided SQL query" }, "generatedSqlQuery": { "type": "string", "description": "Raw SQL from LLM, before templatization" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage", "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." }, "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse", "type": "object", "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" }, "authorizedViewSets": { "description": "The AuthorizedViewSets under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" }, "type": "array" } }, "description": "The response from a ListAuthorizedViewSet request." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "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." }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "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" } }, "description": "The message in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "properties": { "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." }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." } }, "type": "object", "description": "The request to ingest conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "description": "Message for sampling conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "type": "object", "properties": { "samplePercentage": { "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number" }, "conversationFilter": { "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.", "type": "string" }, "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "format": "int64", "type": "string" }, "dimension": { "type": "string", "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'." } } }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", "properties": {}, "type": "object", "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartChip", "description": "A suggestion chip.", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "conversationCorrelationErrors": { "type": "array", "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "format": "int32", "type": "integer" }, "sampledConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations sampled." }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData", "type": "object", "description": "The data for a silence annotation." }, "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1NoteConversationTurnNote", "description": "A note about a conversation turn.", "properties": { "turnIndex": { "type": "integer", "description": "The conversation turn index that the note is associated with.", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData", "description": "Agent Assist Smart Reply data.", "properties": { "confidenceScore": { "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", "type": "number" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates." }, "reply": { "type": "string", "description": "The content of the reply." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "type": "object", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "type": "object", "description": "The response to an IngestConversations operation.", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "description": "A Cloud Storage source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "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" }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUri": { "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string", "deprecated": true } }, "type": "object" }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "updateMask": { "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\"`", "format": "google-fieldmask", "type": "string" }, "policy": { "$ref": "GoogleIamV1Policy", "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." } }, "id": "GoogleIamV1SetIamPolicyRequest" }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "type": "object", "description": "Configs for the input data used to create the issue model.", "properties": { "filter": { "type": "string", "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." }, "trainingConversationsCount": { "readOnly": true, "format": "int64", "type": "string", "description": "Output only. Number of conversations used in training. Output only." }, "medium": { "type": "string", "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`.", "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." ] } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "type": "object", "description": "Tags and their corresponding results.", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "properties": { "tag": { "type": "string", "description": "The tag the score applies to." }, "potentialScore": { "type": "number", "description": "The potential score the tag applies to.", "format": "double" }, "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "format": "double", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "type": "object", "properties": { "agentId": { "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`.", "type": "string" }, "agentChannel": { "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "type": "object", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "description": "The original request for deployment." }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" } }, "description": "Metadata for deploying an issue model." }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "type": "object", "properties": { "transcriptIndex": { "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer" }, "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" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "properties": { "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." }, "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." }, "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." }, "parent": { "type": "string", "description": "Required. The parent resource for new conversations." }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" }, "conversationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations." }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "type": "object", "description": "The request to ingest conversations." }, "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest": { "properties": {}, "description": "The message to appeal an assessment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "properties": { "medium": { "type": "string", "description": "Required. The medium transcript objects represent.", "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": "object", "description": "Configuration for processing transcript objects.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "type": "object", "description": "The request to sample conversations to a dataset.", "properties": { "destinationDataset": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset", "description": "The dataset resource to copy the sampled conversations to." }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { "id": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "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.", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "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": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "properties": { "issueDisplayName": { "type": "string", "description": "The issue display name." }, "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } }, "description": "Metadata about the issue dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig": { "id": "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig", "properties": { "uploadConversationAnalysisPercentage": { "format": "double", "description": "Percentage of conversations created using the UploadConversation endpoint 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": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "runtimeIntegrationAnalysisPercentage": { "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "type": "number", "format": "double" } }, "description": "Default configuration when creating Analyses in Insights.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "type": "object", "description": "A media part.", "properties": { "alternativeText": { "type": "string", "description": "Optional. Alternative text description." }, "uri": { "description": "Optional. URI or URL to the media.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "properties": { "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "format": "google-duration", "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.", "format": "float", "type": "number" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "format": "google-duration", "type": "string" } }, "description": "Word-level info for words in a transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" }, "GoogleCloudContactcenterinsightsV1ScheduleInfo": { "properties": { "schedule": { "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, ...", "type": "string" }, "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" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created." }, "timeZone": { "type": "string", "description": "The timezone to use for the groc expression. If not specified, defaults to UTC." } }, "id": "GoogleCloudContactcenterinsightsV1ScheduleInfo", "description": "Message for schedule info.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "properties": { "query": { "type": "string", "description": "Query text. Article Search uses this to store the input query used to generate the search results." }, "querySource": { "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "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.", "type": "string" }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "properties": { "transcript": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The transcript of the generative insights conversation." }, "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse", "type": "object", "description": "The response for generative insights." }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "properties": { "partialErrors": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete." }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime" }, "sampleConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "description": "Output only. Statistics for SampleConversations operation." }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "type": "object", "description": "The metadata for an SampleConversations operation.", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "description": "A thought part.", "properties": { "text": { "description": "Optional. The thought or reasoning text.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { "type": "object", "properties": { "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" }, "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": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimension" }, "description": "A unique combination of dimensions that this slice represents." } }, "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" }, "GoogleCloudContactcenterinsightsV1QueryMetrics": { "properties": { "request": { "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": "GoogleCloudContactcenterinsightsV1QueryMetrics", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "properties": { "errorMessages": { "type": "array", "description": "The error message when the generative insights request fails.", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "properties": { "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "potentialScore": { "type": "number", "description": "The potential score the tag applies to.", "format": "double" }, "normalizedScore": { "format": "double", "description": "The normalized score the tag applies to.", "type": "number" }, "tag": { "description": "The tag the score applies to.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "properties": { "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueId": { "type": "string", "description": "The issue ID." }, "issueDisplayName": { "description": "The issue display name.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageUserMessage", "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "type": "object", "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The next page token." }, "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "description": "The feedback labels that match the request." } } }, "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { "type": "object", "description": "Agent Assist Smart Reply data.", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "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)." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssue", "description": "Required. The values for the new issue." } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "type": "integer", "description": "Maximum number of conversations to delete.", "format": "int32" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "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." }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "description": "The result of a single constraint rule on the pair of conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult", "type": "object", "properties": { "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" }, "ruleId": { "description": "The rule ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "properties": { "destinationDataset": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset", "description": "The dataset resource to copy the sampled conversations to." }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" } }, "type": "object", "description": "The request to sample conversations to a dataset.", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "type": "object", "description": "Statistics for BulkDownloadFeedbackLabels operation.", "properties": { "processedObjectCount": { "type": "integer", "format": "int32", "description": "The number of objects processed during the download operation." }, "totalFilesWritten": { "format": "int32", "type": "integer", "description": "Total number of files written to the provided Cloud Storage bucket." }, "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.", "format": "int32", "type": "integer" }, "fileNames": { "type": "array", "readOnly": true, "description": "Output only. Full name of the files written to Cloud storage.", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { "description": "Dialogflow interaction data.", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "type": "object", "description": "The response for listing feedback labels.", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "nextPageToken": { "type": "string", "description": "The next page token." } }, "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1QaQuestionMetrics": { "description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.", "type": "object", "properties": { "accuracy": { "format": "double", "type": "number", "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1QaQuestionMetrics" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest", "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1Entity": { "properties": { "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." }, "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" }, "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", "description": "The entity type." }, "displayName": { "type": "string", "description": "The representative name for the entity." }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1Entity", "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" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "properties": { "agentInfo": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call." }, "menuPath": { "type": "string", "description": "An arbitrary string value specifying the menu path the customer took." }, "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "type": "string", "format": "google-duration" }, "customerSatisfactionRating": { "type": "integer", "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "format": "int32" }, "feedbackLabels": { "type": "array", "description": "Input only. The feedback labels associated with the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } }, "description": "Conversation metadata related to quality management.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1UserInfo": { "id": "GoogleCloudContactcenterinsightsV1UserInfo", "properties": { "username": { "type": "string", "description": "The user's username." } }, "description": "Information about a user.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "type": "object", "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" }, "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" }, "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" } }, "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1ExactMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1ExactMatchConfig", "description": "Exact match configuration.", "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "type": "object" }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "done": { "type": "boolean", "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." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "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`." }, "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" }, "metadata": { "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "id": "GoogleLongrunningOperation", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsRequest": { "description": "The request for querying metrics.", "properties": { "measureMask": { "type": "string", "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\".", "format": "google-fieldmask" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" } }, "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" }, "timeGranularity": { "enum": [ "TIME_GRANULARITY_UNSPECIFIED", "NONE", "DAILY", "HOURLY", "PER_MINUTE", "PER_5_MINUTES", "MONTHLY" ], "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "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)." ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" }, "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest": { "description": "The request for bulk uploading feedback labels.", "id": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest", "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource", "description": "A cloud storage bucket source." }, "sheetsSource": { "description": "A sheets document source.", "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource" }, "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" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "properties": { "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM 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" }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." } }, "type": "object", "description": "The measure related to dialogflow interactions.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "properties": { "metadata": { "type": "object", "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" } }, "uri": { "description": "Article URI.", "type": "string" }, "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" }, "title": { "description": "Article title.", "type": "string" }, "confidenceScore": { "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).", "type": "number" } }, "description": "Agent Assist Article Suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "type": "object", "properties": { "transcriptSegments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" }, "type": "array", "description": "A list of sequential transcript segments that comprise the conversation." } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "properties": { "listType": { "type": "string", "description": "Optional. The type of list.", "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ] }, "items": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "type": "array", "description": "Optional. List items." } }, "type": "object", "description": "A list part.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "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": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } } }, "description": "Issue Modeling result on a conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "type": "object", "properties": { "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "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.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" }, "type": "array" }, "tags": { "type": "array", "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." }, "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": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer", "description": "An answer to a QaQuestion." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "$ref": "GoogleRpcStatus", "description": "The error status." } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", "type": "object", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "properties": { "payloadType": { "description": "Optional. Type identifier for the payload.", "type": "string" }, "payload": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Arbitrary structured payload." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "type": "object", "description": "A custom payload part." }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "properties": { "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" }, "playbookId": { "type": "string", "description": "Optional. The dialogflow playbook ID." } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "properties": { "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" }, "type": "array", "description": "List of all individual score sets." }, "name": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "qaTagResults": { "type": "array", "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } }, "agentId": { "type": "string", "description": "ID of the agent that handled the conversation." }, "score": { "type": "number", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "format": "double" }, "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" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The timestamp that the revision was created." }, "qaScorecardRevision": { "type": "string", "description": "The QaScorecardRevision scored by this result." }, "conversation": { "type": "string", "description": "The conversation scored by this result." }, "qaAnswers": { "type": "array", "description": "Set of QaAnswers represented in the result.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" } }, "normalizedScore": { "format": "double", "type": "number", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1EntityMentionData": { "id": "GoogleCloudContactcenterinsightsV1EntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "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." }, "type": { "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "type": "string", "description": "The type of the entity mention." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } }, "description": "The request for deleting a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "type": "object", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "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" } }, "description": "The request for updating a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest" }, "GoogleCloudContactcenterinsightsV1RedirectAction": { "id": "GoogleCloudContactcenterinsightsV1RedirectAction", "properties": { "queryParams": { "type": "object", "description": "The query params to be added to the redirect path.", "additionalProperties": { "type": "string" } }, "relativePath": { "description": "The relative path to redirect to.", "type": "string" } }, "description": "The redirect action to be taken when the chart is clicked.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" }, "createNewModel": { "type": "boolean", "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." } }, "description": "Request to import an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "description": "Metadata about the conversation medium dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "type": "object", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Output only. The original request for download." }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during ingest operation that might cause the operation output to be incomplete." } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "properties": { "feedbackLabels": { "type": "array", "description": "The feedback labels that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "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." } } }, "GoogleCloudContactcenterinsightsV1SilenceData": { "id": "GoogleCloudContactcenterinsightsV1SilenceData", "type": "object", "description": "The data for a silence annotation.", "properties": {} }, "GoogleProtobufEmpty": { "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); }", "properties": {}, "id": "GoogleProtobufEmpty", "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "conversationCorrelationErrors": { "type": "array", "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse": { "properties": { "authorizedViews": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "type": "array", "description": "The AuthorizedViews 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." } }, "id": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse", "type": "object", "description": "The response from a ListAuthorizedViews request." }, "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse": { "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." }, "qaScorecards": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "description": "The QaScorecards under the parent.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse", "description": "The response from a ListQaScorecards request.", "type": "object" }, "GoogleCloudContactcenterinsightsV1Intent": { "type": "object", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" }, "id": { "description": "The unique identifier of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Intent" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "properties": { "correlationTypes": { "type": "array", "readOnly": true, "items": { "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "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." ] }, "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." }, "fullConversationCorrelationId": { "type": "string", "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of." }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string", "readOnly": true } }, "description": "Info for correlating across conversations." }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "properties": {}, "description": "Response from export issue model", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "properties": { "text": { "type": "string", "description": "A message from the user that is interacting with the system." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "conversationB": { "type": "string", "description": "The second conversation resource name." }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" } }, "conversationA": { "description": "The first conversation resource name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "properties": { "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" }, "correlationTypes": { "items": { "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "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." ] }, "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." }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true, "type": "string" } }, "description": "Info for correlating across conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The next page token." }, "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1Dashboard": { "description": "Configurable dashboard", "id": "GoogleCloudContactcenterinsightsV1Dashboard", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Dashboard last update time." }, "rootContainer": { "$ref": "GoogleCloudContactcenterinsightsV1Container", "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." }, "filter": { "type": "string", "description": "Filter applied to all charts in the dashboard. Should support scope later." }, "readOnly": { "type": "boolean", "readOnly": true, "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user." }, "dateRangeConfig": { "description": "Date range config applied to all charts in the dashboard.", "$ref": "GoogleCloudContactcenterinsightsV1DateRangeConfig" }, "name": { "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dashboard creation time." }, "description": { "description": "Dashboard description", "type": "string" }, "displayName": { "description": "User provided display name of the dashboard.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "type": "object", "properties": { "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" }, "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." }, "feedbackLabelType": { "type": "string", "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." ], "description": "Optional. The type of feedback labels that will be downloaded.", "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ] }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" }, "templateQaScorecardId": { "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.", "items": { "type": "string" } }, "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" } }, "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "type": "object", "properties": { "sheetTitle": { "type": "string", "description": "Optional. The title of the new sheet to write the feedback labels to." }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "type": "object", "description": "The request to delete an issue model." }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "type": "object", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "properties": { "successfulIngestCount": { "type": "integer", "format": "int32", "description": "Output only. The number of new conversations added during this 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" }, "failedIngestCount": { "readOnly": true, "type": "integer", "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" }, "processedObjectCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of objects processed during the ingest operation." } }, "description": "Statistics for IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "properties": { "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object", "properties": { "recordsPerFileCount": { "description": "Optional. The number of records per file. Applicable for either format.", "type": "string", "format": "int64" }, "objectUri": { "type": "string", "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`" }, "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" }, "addWhitespace": { "type": "boolean", "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format." }, "format": { "description": "Required. File format in which the labels will be exported.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "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" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript.", "properties": { "startOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the start of this word relative to the beginning of the total conversation." }, "confidence": { "type": "number", "format": "float", "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." }, "word": { "type": "string", "description": "The word itself. Includes punctuation marks that surround the word." }, "endOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the end of this word relative to the beginning of the total conversation." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "type": "object", "description": "Google Cloud Storage Object URI to save the issue model to." }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation", "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}" }, "smartReply": { "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData", "description": "Agent Assist Smart Reply data." }, "cesTurnAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "description": "The CES turn annotation." }, "startBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" }, "createTime": { "type": "string", "description": "The time at which this annotation was created.", "format": "google-datetime" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "dialogflowInteraction": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "description": "Dialogflow interaction data." }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1AnswerFeedback" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData" }, "faqAnswer": { "$ref": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "description": "Agent Assist FAQ answer data." }, "cesEndSessionAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "description": "The CES end session annotation." }, "endBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." } }, "description": "An annotation that was generated during the customer and agent interaction." }, "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "type": "string", "description": "The Cloud Storage URI of the audio for any given turn." }, "audioDuration": { "type": "string", "description": "The duration of the audio.", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "properties": { "text": { "type": "string", "description": "Optional. The text content." } }, "description": "A text part.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "type": "object", "description": "Call-specific metadata created during analysis.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "properties": { "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" }, "type": "array", "description": "A list of call annotations that apply to this call." }, "qaScorecardResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" }, "description": "Results of scoring QaScorecards." }, "silence": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" } }, "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "description": "All the entities in the call.", "type": "object" }, "intents": { "description": "All the matched intents in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" }, "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" } } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" } }, "description": "Configuration for the QA feature.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "type": "object", "description": "Conversation summarization suggestion data.", "properties": { "text": { "type": "string", "description": "The summarization content that is concatenated into one string." }, "textSections": { "additionalProperties": { "type": "string" }, "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." }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object" }, "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "type": "object", "properties": { "transcriptSegments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" }, "description": "A list of sequential transcript segments that comprise the conversation." } } }, "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice": { "type": "object", "properties": { "strValue": { "description": "String value.", "type": "string" }, "boolValue": { "type": "boolean", "description": "Boolean value." }, "key": { "description": "A short string used as an identifier.", "type": "string" }, "naValue": { "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.", "type": "boolean" }, "numValue": { "description": "Numerical value.", "type": "number", "format": "double" }, "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." } }, "description": "Message representing a possible answer to the question.", "id": "GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice" }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "endTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "analysisOperation": { "readOnly": true, "type": "string", "description": "Output only. The operation name for a successfully created analysis operation, if any." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "description": "Output only. The original request.", "readOnly": true }, "appliedRedactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "readOnly": true, "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." } } }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "properties": { "callAnalysisMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created by the analysis." }, "endTime": { "description": "The time at which the analysis ended.", "format": "google-datetime", "type": "string" } }, "description": "The result of an analysis.", "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "type": "object", "properties": { "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings." }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings." }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation." }, "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": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "description": "Request to upload a conversation." }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "description": "Aggregated statistics about an issue model.", "properties": { "unclassifiedConversationsCount": { "type": "string", "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time." }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "type": "object" }, "analyzedConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsights": { "properties": { "sqlQuery": { "description": "SQL query used to generate the chart.", "type": "string" }, "sqlComparisonKey": { "description": "Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.", "type": "string" }, "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint" }, "request": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "chartConversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation" }, "description": "Output only. The chart conversations used to generate the chart.", "readOnly": true, "deprecated": true, "type": "array" }, "chartSpec": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Chart spec for the chart." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsights", "description": "Request that use natural language query to generate the chart." }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "properties": { "relabel": { "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true, "type": "boolean" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "completedAnalysesCount": { "type": "integer", "description": "The number of requested analyses that have completed successfully so far.", "format": "int32" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "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." }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "properties": { "text": { "description": "Optional. The text of the list item.", "type": "string" }, "subItems": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "description": "Optional. Nested sub-items." } }, "type": "object", "description": "An item in a list.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "properties": { "scorecardList": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "description": "A manual list of scorecards to score." } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig", "description": "Configuration for the QA feature.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "type": "object", "properties": { "agentVersionDisplayName": { "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.", "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" }, "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" }, "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." }, "agentVersionId": { "type": "string", "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." }, "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." } }, "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "type": "object", "description": "A text output message from the system.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "text": { "description": "The parts of the message.", "items": { "type": "string" }, "type": "array" }, "textType": { "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "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." ] } } }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "description": "The request to create an issue model.", "properties": { "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "Required. The issue model to create." }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Required. The issue model to export." }, "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "type": "object", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "type": "string", "description": "Optional. The label value." } }, "description": "Metadata about conversation labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest": { "properties": { "sqlQuery": { "type": "string", "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." }, "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" }, "comparisonFilter": { "type": "string", "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\"." }, "chart": { "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "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" }, "naturalLanguageQuery": { "type": "string", "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored." }, "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." }, "userProvidedChartSpec": { "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest", "type": "object", "description": "The request for generative insights." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "description": "Response for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "description": "Metadata about the conversation profile dimension." }, "GoogleCloudContactcenterinsightsV1PhraseMatchRule": { "description": "The data for a phrase match rule.", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchRule", "type": "object", "properties": { "negated": { "type": "boolean", "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment." }, "config": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", "description": "Provides additional information about the rule that specifies how to apply the rule." }, "query": { "type": "string", "description": "Required. The phrase to be matched." } } }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "type": "object", "properties": {}, "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "description": "A product in a product collection.", "properties": { "imageUris": { "type": "array", "items": { "type": "string" }, "description": "Optional. Product image URLs." }, "uri": { "description": "Optional. Product URL or deep link.", "type": "string" }, "id": { "description": "Optional. Product ID.", "type": "string" }, "displayName": { "description": "Optional. Product display name.", "type": "string" }, "price": { "$ref": "GoogleTypeMoney", "description": "Optional. Product price." }, "description": { "type": "string", "description": "Optional. Product description." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" }, "annotationEndBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "channelTag": { "type": "integer", "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "format": "int32" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "intentMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData", "description": "Data specifying an intent match." }, "entityMentionData": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "description": "Data specifying an entity mention." }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "Data specifying sentiment." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "properties": { "trainingConversationsCount": { "readOnly": true, "format": "int64", "type": "string", "description": "Output only. Number of conversations used in training. Output only." }, "filter": { "type": "string", "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." }, "medium": { "deprecated": true, "type": "string", "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" ], "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": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata", "properties": { "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "readOnly": true }, "sampleConversationsStats": { "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "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 undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest": { "properties": {}, "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1Analysis": { "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string" }, "requestTime": { "description": "Output only. The time at which the analysis was requested.", "format": "google-datetime", "type": "string", "readOnly": true }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1Analysis", "type": "object", "description": "The analysis resource." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "properties": { "silenceDuration": { "type": "string", "format": "google-duration", "description": "Amount of time calculated to be in silence." }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "format": "float", "type": "number" } }, "description": "Conversation-level silence data.", "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart": { "description": "A text part.", "type": "object", "properties": { "text": { "description": "Optional. The text content.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } }, "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" ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "partialErrors": { "type": "array", "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "description": "The original request for bulk delete." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1IssueModel": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "The issue model resource.", "properties": { "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "format": "google-datetime", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "type": "string", "readOnly": true, "description": "Output only. State of the model." }, "displayName": { "type": "string", "description": "The representative name for the issue model." }, "modelType": { "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "type": "string", "description": "Type of the model." }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "languageCode": { "description": "Language of the model.", "type": "string" }, "issueCount": { "type": "string", "description": "Output only. Number of issues in this issue model.", "format": "int64", "readOnly": true }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "trainingStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "description": "Output only. Immutable. The issue model's label statistics on its training data." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", "properties": {}, "description": "Response for an export insights operation." }, "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { "type": "object", "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": { "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" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "format": "double", "type": "number" }, "score": { "description": "The overall numerical score of the result.", "format": "double", "type": "number" }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array" }, "sourceType": { "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "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" } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" }, "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata": { "type": "object", "properties": { "datasetValidationWarnings": { "description": "A list of any applicable data validation warnings about the question's feedback labels.", "items": { "type": "string", "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": "array" }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" }, "totalValidLabelCount": { "type": "string", "description": "Total number of valid labels provided for the question at the time of tuining.", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata", "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned." }, "GoogleCloudContactcenterinsightsV1ListDashboardsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListDashboardsResponse", "type": "object", "description": "The response of listing dashboards.", "properties": { "dashboards": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "type": "array", "description": "The dashboards under the parent." }, "nextPageToken": { "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.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "type": "object", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." }, "percentileLlmCallLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." }, "percentileToolUseLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "type": "object", "description": "Metadata about conversation labels." }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "properties": { "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "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 }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation." }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "type": "object", "description": "The response for querying performance overview.", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "description": "The request to delete an issue model.", "properties": { "name": { "type": "string", "description": "Required. The name of the issue model to delete." } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "constraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" }, "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array" }, "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse", "properties": { "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "type": "string" }, "location": { "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice", "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." }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" } } }, "type": "object", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip": { "description": "A suggestion chip.", "properties": { "text": { "description": "Optional. The chip label or text.", "type": "string" }, "actionUri": { "type": "string", "description": "Optional. Optional action or destination URI triggered by the chip." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartChip", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "properties": { "sourceUri": { "type": "string", "description": "Optional. The cited source URI." }, "sourceTitle": { "description": "Optional. The cited source title.", "type": "string" }, "snippet": { "description": "Optional. Snippet of the cited text.", "type": "string" } }, "description": "A citation part." }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest": { "properties": { "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": { "description": "Required. The time window of the conversations to derive performance stats from.", "$ref": "GoogleCloudContactcenterinsightsV1QueryInterval" }, "comparisonQueryInterval": { "description": "The time window of the conversations to compare the performance to.", "$ref": "GoogleCloudContactcenterinsightsV1QueryInterval" }, "agentPerformanceSource": { "description": "Conversations are from a single agent.", "$ref": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource" } }, "description": "The request for summarizing performance according to different metrics for conversations over a specified time window.", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "type": "object", "description": "Information about the issue.", "properties": { "score": { "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number", "format": "double" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "description": "The response to an SampleConversations operation.", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart": { "properties": { "suggestionChips": { "description": "Optional. Suggestion chips or interactive buttons.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" }, "list": { "description": "Optional. Ordered or unordered list.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "video": { "description": "Optional. Video media.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "image": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "Optional. Image media." }, "productCollection": { "description": "Optional. Product collection or carousel.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "citation": { "description": "Optional. Citation or reference to grounding material.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCitationPart" }, "thought": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "description": "Optional. Model thought or internal reasoning." }, "text": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTextPart", "description": "Optional. Plain text content." }, "link": { "description": "Optional. Web link or URL.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartLinkPart" }, "table": { "description": "Optional. Tabular data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "customPayload": { "description": "Optional. Generic custom structured payload.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart" } }, "description": "A structured component/part of a transcript segment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "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" }, "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" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "type": "object", "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "properties": { "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "exportSchemaVersion": { "type": "string", "description": "Optional. Version of the export schema.", "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." ], "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" ] }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "writeDisposition": { "type": "string", "description": "Options for what to do if the destination table already exists.", "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" ] }, "bigQueryDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "type": "object", "description": "Conversation metadata related to quality management.", "properties": { "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" }, "type": "array", "description": "Information about agents involved in the call." }, "waitDuration": { "type": "string", "format": "google-duration", "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" }, "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "format": "int32", "type": "integer" }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { "properties": { "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "description": "All the matched issues.", "type": "array" }, "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "type": "object", "description": "Issue Modeling result on a conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "properties": { "title": { "type": "string", "description": "Optional. Optional title for the table." }, "headers": { "items": { "type": "string" }, "type": "array", "description": "Optional. Table column headers." }, "rows": { "type": "array", "description": "Optional. Table rows.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow" } } }, "description": "A table part.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "type": "object" }, "GoogleCloudCesV1mainAgentTransfer": { "id": "GoogleCloudCesV1mainAgentTransfer", "type": "object", "description": "Represents an event indicating the transfer of a conversation to a different agent.", "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": { "type": "string", "description": "Output only. Display name of the agent.", "readOnly": true } } }, "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "description": "Wrapper for storing the generative response for a chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "properties": { "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 }, "chartSpec": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format." }, "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" }, "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": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "type": "object", "description": "Conversation-level silence data.", "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "properties": { "silenceDuration": { "type": "string", "description": "Amount of time calculated to be in silence.", "format": "google-duration" }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "format": "float", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1SignedAudioUris": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1SignedAudioUris", "properties": { "signedTurnLevelAudios": { "description": "The signed URI for the audio corresponding to each turn in the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" } }, "signedGcsAudioUris": { "readOnly": true, "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", "items": { "type": "string" } }, "signedGcsAudioUri": { "type": "string", "description": "The signed URI for the audio from the Cloud Storage conversation source." }, "signedDialogflowAudioUri": { "type": "string", "description": "The signed URI for the audio from the Dialogflow conversation source." } }, "description": "Signed audio URIs for a conversation." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "description": "Google Cloud Storage Object URI to get the issue model file from.", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { "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.", "properties": { "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" }, "sourceType": { "type": "string", "description": "What created the answer.", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ] } } }, "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse", "description": "The response from a GenerateConversationSignedAudio request.", "properties": { "signedAudioUris": { "$ref": "GoogleCloudContactcenterinsightsV1SignedAudioUris", "description": "The signed uris for the audio." } } }, "GoogleCloudCesV1mainEndSession": { "type": "object", "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.", "properties": { "metadata": { "type": "object", "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." } } }, "id": "GoogleCloudCesV1mainEndSession" }, "GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse": { "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.", "type": "string" }, "assistantSessions": { "type": "array", "description": "The assistant sessions.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse", "description": "Response to list assistant sessions." }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "type": "object", "description": "Metadata for creating an issue model.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "description": "The original request for creation." }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "properties": { "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "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" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "analysisPercentage": { "type": "number", "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "parent": { "type": "string", "description": "Required. The parent resource to create analyses in." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "description": "The request to analyze conversations in bulk." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "properties": { "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "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": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." } } }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "description": "The CES diagnostic information.", "properties": { "rootSpan": { "$ref": "GoogleCloudCesV1mainSpan", "description": "The root span of the action processing." }, "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "type": "array", "description": "The messages in the turn." } } }, "GoogleCloudContactcenterinsightsV1QaScorecard": { "description": "A QaScorecard represents a collection of questions to be scored during analysis.", "properties": { "source": { "readOnly": true, "description": "Output only. The source of the scorecard.", "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." ], "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ] }, "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." }, "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, "description": { "type": "string", "description": "A text description explaining the intent of the scorecard." }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this scorecard was created.", "readOnly": true, "type": "string" }, "displayName": { "type": "string", "description": "The user-specified display name of the scorecard." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the scorecard was updated.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecard", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "type": "object", "description": "The request to sample conversations to a dataset.", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "properties": { "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1mainDataset" }, "parent": { "type": "string", "description": "Required. The parent resource of the dataset." }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule" } } }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "entityMentionData": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntityMentionData", "description": "Data specifying an entity mention." }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "silenceData": { "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData", "description": "Data specifying silence." }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1mainHoldData" }, "issueMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "Data specifying an issue match." }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "interruptionData": { "$ref": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "description": "Data specifying an interruption." }, "phraseMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "description": "Data specifying a phrase match." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "type": "object", "description": "A Dialogflow source of conversation data.", "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}", "type": "string", "readOnly": true }, "audioUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation audio." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" } }, "joinKeyResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" }, "description": "A list of join key correlation results for each conversation tested." } } }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The most recent time that this issue was updated." }, "sampleUtterances": { "items": { "type": "string" }, "type": "array", "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "readOnly": true }, "displayDescription": { "type": "string", "description": "Representative description of the issue." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time at which this issue was created.", "format": "google-datetime" }, "displayName": { "description": "The representative name for the issue.", "type": "string" } }, "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig": { "id": "GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig", "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined.", "type": "object", "properties": { "type": { "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE", "CONVERSATION_OUTCOME_AI_AVERSION" ], "description": "The type of the predefined question.", "type": "string", "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." ] } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPart", "properties": { "link": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "description": "Optional. Web link or URL." }, "customPayload": { "description": "Optional. Generic custom structured payload.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart" }, "video": { "description": "Optional. Video media.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" }, "text": { "description": "Optional. Plain text content.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart" }, "productCollection": { "description": "Optional. Product collection or carousel.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "image": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "Optional. Image media." }, "list": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartListPart", "description": "Optional. Ordered or unordered list." }, "thought": { "description": "Optional. Model thought or internal reasoning.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart" }, "citation": { "description": "Optional. Citation or reference to grounding material.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart" }, "table": { "description": "Optional. Tabular data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "suggestionChips": { "description": "Optional. Suggestion chips or interactive buttons.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" } }, "description": "A structured component/part of a transcript segment." }, "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": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "querySource": { "description": "Query source for the answer.", "type": "string", "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "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": "Explicit input used for generating the answer", "type": "object" }, "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse": { "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" }, "authorizedViews": { "description": "The AuthorizedViews under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" } } }, "id": "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse", "type": "object", "description": "The response from a ListAuthorizedViews request." }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "properties": { "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.", "type": "array", "items": { "type": "string" } }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "answerSources": { "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.", "type": "array" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "type": "object", "properties": { "failedAnalysisCount": { "format": "int32", "description": "Count of failed analyses.", "type": "integer" }, "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "type": "object", "properties": { "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "issueModels": { "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", "items": { "type": "string" } }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runQaAnnotator": { "type": "boolean", "description": "Whether to run the QA annotator." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "summarizationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", "description": "Configuration for the summarization annotator." }, "runEntityAnnotator": { "type": "boolean", "description": "Whether to run the entity annotator." }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "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" } }, "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." }, "runPhraseMatcherAnnotator": { "type": "boolean", "description": "Whether to run the active phrase matcher annotator(s)." }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" } }, "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleIamV1AuditLogConfig": { "id": "GoogleIamV1AuditLogConfig", "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.", "type": "object", "properties": { "logType": { "description": "The log type that this config enables.", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "type": "string", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] }, "exemptedMembers": { "items": { "type": "string" }, "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { "description": "The response for listing all feedback labels.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", "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" } } }, "GoogleCloudContactcenterinsightsV1Widget": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1Widget", "properties": { "chart": { "$ref": "GoogleCloudContactcenterinsightsV1Chart", "description": "A chart widget." }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "chartReference": { "type": "string", "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}" }, "container": { "$ref": "GoogleCloudContactcenterinsightsV1Container", "description": "A container widget." } }, "description": "Represents a dashboard element, could be a nested Container or Chart." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "description": "Configuration for Cloud Storage bucket sources.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "properties": { "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": { "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" }, "bucketObjectType": { "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "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`.", "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" }, "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" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "properties": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete." } }, "description": "The request for deleting a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "type": "object", "description": "The metadata for an IngestConversations operation.", "properties": { "partialErrors": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "sampledConversations": { "items": { "type": "string" }, "type": "array", "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" }, "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "description": "Output only. The original request for ingest." } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata" }, "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" } } }, "id": "GoogleIamV1TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DateRangeConfig": { "description": "Date range configuration for dashboard charts.", "type": "object", "properties": { "relativeDateRange": { "description": "A relative date range.", "$ref": "GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange" }, "absoluteDateRange": { "$ref": "GoogleCloudContactcenterinsightsV1QueryInterval", "description": "An absolute date range." } }, "id": "GoogleCloudContactcenterinsightsV1DateRangeConfig" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata", "properties": { "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." } }, "type": "object", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "description": "Call-specific metadata.", "properties": { "customerChannel": { "format": "int32", "type": "integer", "description": "The audio channel that contains the customer." }, "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "type": "object", "description": "The response for a bulk analyze conversations operation.", "properties": { "failedAnalysisCount": { "description": "Count of failed analyses.", "type": "integer", "format": "int32" }, "successfulAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of successful analyses." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "type": "object", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" } }, "description": "The response of testing correlation config.", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "type": "object", "properties": { "cells": { "description": "Optional. The cell values in the row.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow", "description": "A row in a table." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "description": "Average QA normalized score for the tag.", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "type": "number", "format": "double", "description": "Average tag normalized score per tag." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "type": "object", "description": "Aggregated statistics about an issue.", "properties": { "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "format": "int64", "type": "string" }, "issue": { "type": "string", "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "displayName": { "description": "Display name of the issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "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" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "description": "A Cloud Storage location specification for the audio and transcript." } } }, "GoogleCloudContactcenterinsightsV1ChartDataSource": { "description": "The request data for visualizing the dataset in the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ChartDataSource", "properties": { "queryMetrics": { "description": "Use the existing QueryMetrics to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetrics" }, "generativeInsights": { "description": "Use natural language query to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsights" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModel", "type": "object", "properties": { "displayName": { "type": "string", "description": "The representative name for the issue model." }, "createTime": { "description": "Output only. The time at which this issue model was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "languageCode": { "type": "string", "description": "Language of the model." }, "state": { "readOnly": true, "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" ] }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" }, "issueCount": { "readOnly": true, "type": "string", "description": "Output only. Number of issues in this issue model.", "format": "int64" }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "trainingStats": { "readOnly": true, "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" } }, "description": "The issue model resource." }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "type": "object", "properties": { "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest", "description": "The original request for creation." } }, "description": "Metadata for creating an issue.", "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "type": "object", "properties": { "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object" }, "title": { "description": "Article title.", "type": "string" }, "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)." }, "uri": { "description": "Article URI.", "type": "string" } }, "description": "Agent Assist Article Suggestion data." }, "GoogleCloudContactcenterinsightsV1QaQuestionTag": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Required. A user-specified display name for the tag." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated.", "readOnly": true }, "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": { "readOnly": true, "description": "Output only. The time at which the question tag was created.", "type": "string", "format": "google-datetime" }, "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.", "id": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote": { "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", "type": "string" } }, "description": "A note about a QA question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1NoteQaQuestionNote" }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "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" } }, "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.", "id": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "GoogleCloudContactcenterinsightsV1Container": { "id": "GoogleCloudContactcenterinsightsV1Container", "properties": { "widgets": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Widget" }, "description": "Widgets in the Container." }, "height": { "type": "integer", "format": "int32", "description": "The height of the container in grid units." }, "containerId": { "readOnly": true, "description": "Output only. Unique ID for the container.", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to all charts in the container.", "$ref": "GoogleCloudContactcenterinsightsV1DateRangeConfig" }, "width": { "type": "integer", "format": "int32", "description": "The width of the container in grid units." }, "displayName": { "description": "User provided display name of the Container.", "type": "string" }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "description": { "type": "string", "description": "Container description" } }, "type": "object", "description": "Configurable dashboard's container. Container can contain multiple widgets." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { "type": "object", "properties": { "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" }, "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." } }, "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "properties": { "inspectTemplate": { "type": "string", "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`" }, "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" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "description": "The result of an analysis.", "type": "object", "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time at which the analysis ended." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "type": "object", "description": "A product in a product collection.", "properties": { "price": { "description": "Optional. Product price.", "$ref": "GoogleTypeMoney" }, "imageUris": { "type": "array", "items": { "type": "string" }, "description": "Optional. Product image URLs." }, "id": { "type": "string", "description": "Optional. Product ID." }, "uri": { "type": "string", "description": "Optional. Product URL or deep link." }, "description": { "type": "string", "description": "Optional. Product description." }, "displayName": { "description": "Optional. Product display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequestConversations", "type": "object", "properties": { "conversations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "description": "Optional. The conversations." } }, "description": "Wrapper for a list of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "description": "The conversation resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "type": "object", "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 }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript" }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "ttl": { "type": "string", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "format": "google-duration" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which the conversation was created.", "type": "string", "readOnly": true }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The most recent time at which the conversation was updated." }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "correlationInfo": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "description": "Output only. Info for correlating across conversations.", "readOnly": true }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "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" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "expireTime": { "type": "string", "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" }, "medium": { "type": "string", "description": "Immutable. The conversation 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." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "duration": { "readOnly": true, "description": "Output only. The duration of the conversation.", "format": "google-duration", "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." }, "runtimeAnnotations": { "type": "array", "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" } }, "turnCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of turns in the conversation." }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "obfuscatedUserId": { "type": "string", "description": "Obfuscated user ID which the customer sent to us." }, "latestAnalysis": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "description": "Output only. The conversation's latest analysis, if one exists." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension.", "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata", "properties": { "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Metadata used for import issue model." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage": { "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": { "textOutput": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Chart spec from LLM" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversationMessageSystemMessage", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart": { "properties": { "sourceUri": { "description": "Optional. The cited source URI.", "type": "string" }, "snippet": { "type": "string", "description": "Optional. Snippet of the cited text." }, "sourceTitle": { "description": "Optional. The cited source title.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "type": "object", "description": "A citation part." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", "properties": { "sheetTitle": { "type": "string", "description": "Optional. The title of the new sheet to write the feedback labels to." }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "type": "object", "description": "The conversation source, which is a combination of transcript and audio.", "properties": { "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1GcsSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "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" } }, "dialogflowSource": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource", "description": "The source when the conversation comes from Dialogflow." } } }, "GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse": { "description": "The response of listing assessment rules.", "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." }, "assessmentRules": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "description": "The assessment rules that match the request." } }, "id": "GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse" }, "GoogleCloudContactcenterinsightsV1CorrelationTypeConfig": { "description": "A list of correlation rules for a given correlation type.", "id": "GoogleCloudContactcenterinsightsV1CorrelationTypeConfig", "properties": { "correlationRules": { "description": "A list of correlation rules to be evaluated for correlation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationRule" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart": { "description": "A list part.", "properties": { "items": { "description": "Optional. List items.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "type": "array" }, "listType": { "enumDescriptions": [ "Unspecified list type.", "Unordered list.", "Ordered numbered list.", "Ordered alphabetic list." ], "enum": [ "LIST_TYPE_UNSPECIFIED", "UNORDERED", "ORDERED_NUMBER", "ORDERED_ALPHA" ], "type": "string", "description": "Optional. The type of list." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "type": "object", "description": "The metadata for an `UploadConversation` operation.", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "properties": { "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "readOnly": true, "description": "Output only. The original request." }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse": { "type": "object", "description": "Response of querying an issue model's statistics.", "id": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse", "properties": { "currentStats": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "description": "The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "properties": { "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "role": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_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." ], "description": "The role of the participant.", "type": "string" }, "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" } }, "type": "object", "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "type": "object", "properties": { "failedIngestCount": { "format": "int32", "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 }, "successfulIngestCount": { "format": "int32", "type": "integer", "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true }, "processedObjectCount": { "type": "integer", "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true, "format": "int32" }, "duplicatesSkippedCount": { "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "readOnly": true, "type": "integer" } }, "description": "Statistics for IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", "type": "object", "properties": { "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "Data specifying sentiment." }, "channelTag": { "type": "integer", "description": "The channel of the audio that the data applies to.", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "type": "object", "properties": { "failedExportCount": { "format": "int32", "type": "integer", "description": "The number of conversations that failed to be exported." }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime" }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "description": "Metadata for an export insights operation." }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata", "properties": { "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time the operation was created." }, "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string", "readOnly": true }, "annotatorSelector": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "Output only. The annotator selector used for the analysis (if any)." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "properties": { "name": { "type": "string", "description": "Required. The issue model to deploy." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "description": "The request to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest": { "properties": {}, "type": "object", "description": "The request to deploy a QaScorecardRevision", "id": "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest" }, "GoogleIamV1TestIamPermissionsResponse": { "id": "GoogleIamV1TestIamPermissionsResponse", "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } }, "description": "Response message for `TestIamPermissions` method." }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "properties": { "endSession": { "$ref": "GoogleCloudCesV1mainEndSession", "description": "End session signal from CES." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse", "properties": {}, "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart": { "type": "object", "properties": { "video": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart", "description": "Optional. Video media." }, "productCollection": { "description": "Optional. Product collection or carousel.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "customPayload": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "description": "Optional. Generic custom structured payload." }, "suggestionChips": { "description": "Optional. Suggestion chips or interactive buttons.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart" }, "citation": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartCitationPart", "description": "Optional. Citation or reference to grounding material." }, "thought": { "description": "Optional. Model thought or internal reasoning.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart" }, "list": { "description": "Optional. Ordered or unordered list.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListPart" }, "text": { "description": "Optional. Plain text content.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTextPart" }, "table": { "description": "Optional. Tabular data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartTablePart" }, "link": { "description": "Optional. Web link or URL.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart" }, "image": { "description": "Optional. Image media.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartMediaPart" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPart", "description": "A structured component/part of a transcript segment." }, "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse": { "description": "The response of listing phrase matchers.", "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." }, "phraseMatchers": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, "description": "The phrase matchers that match the request." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" }, "GoogleCloudContactcenterinsightsV1CorrelationRule": { "id": "GoogleCloudContactcenterinsightsV1CorrelationRule", "description": "A correlation rule that defines how to join conversations for a given correlation type.", "type": "object", "properties": { "active": { "type": "boolean", "description": "Optional. Whether the config is active to be evaluated." }, "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" }, "joinKeyExpression": { "type": "string", "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." }, "ruleId": { "description": "Required. The unique identifier of the rule.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "type": "object", "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" } }, "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." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "description": "Metadata from Dialogflow relating to the current transcript segment.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "type": "object", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData", "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1View": { "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the view was updated.", "type": "string", "readOnly": true }, "displayName": { "description": "The human-readable display name of the view.", "type": "string" }, "value": { "description": "A filter to reduce conversation results to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "createTime": { "description": "Output only. The time at which this view was created.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object", "description": "The View resource.", "id": "GoogleCloudContactcenterinsightsV1View" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "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)." }, "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "conversationMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." } } }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "properties": { "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)." }, "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" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "description": "Agent Assist Smart Reply data." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "readOnly": true, "type": "array" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "request": { "description": "Output only. The original request for ingest.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "sampledConversations": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. Stores the conversation resources produced by ingest sampling operations." }, "ingestConversationsStats": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "readOnly": true, "description": "Output only. Statistics for IngestConversations operation." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "properties": { "failedSampleCount": { "format": "int32", "readOnly": true, "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" }, "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "format": "int32", "readOnly": true, "type": "integer" } }, "description": "Statistics for SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "type": "object", "description": "Aggregated statistics about an issue model.", "properties": { "analyzedConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time." }, "unclassifiedConversationsCount": { "format": "int64", "type": "string", "description": "Number of analyzed conversations for which no issue was applicable at this point in time." }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse", "description": "Response from export issue model", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { "properties": { "displayName": { "type": "string", "description": "The human-readable name of the phrase matcher." }, "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object" }, "GoogleCloudContactcenterinsightsV1Chart": { "type": "object", "description": "Configurable dashboard's widget that displays data as a chart.", "id": "GoogleCloudContactcenterinsightsV1Chart", "properties": { "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Chart last update time." }, "height": { "description": "The height of the chart in grid units.", "format": "int32", "type": "integer" }, "displayName": { "type": "string", "description": "User provided display name of the chart." }, "description": { "description": "Chart description", "type": "string" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1ChartDataSource" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Chart create time.", "type": "string" }, "width": { "description": "The width of the chart in grid units.", "type": "integer", "format": "int32" }, "dateRangeConfig": { "description": "Date range config applied to the chart.", "$ref": "GoogleCloudContactcenterinsightsV1DateRangeConfig" }, "action": { "$ref": "GoogleCloudContactcenterinsightsV1ChartAction", "description": "Optional action to be taken when the chart is clicked." }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "chartVisualizationType": { "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." ], "type": "string", "description": "Chart visualization type.", "enum": [ "CHART_VISUALIZATION_TYPE_UNSPECIFIED", "BAR", "LINE", "AREA", "PIE", "SCATTER", "TABLE", "SCORE_CARD", "SUNBURST", "GAUGE", "SANKEY" ] }, "name": { "type": "string", "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}" }, "chartType": { "readOnly": true, "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." } } }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "properties": { "ruleId": { "type": "string", "description": "The rule ID." }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" }, "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the constraint expression failed to evaluate." } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "type": "object", "description": "Metadata used for export issue model.", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "description": "The original export request." } } }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." } }, "type": "object", "description": "Metadata about the QA scorecard dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1AuthorizedView": { "properties": { "updateTime": { "description": "Output only. The most recent time at which the authorized view was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}" }, "displayName": { "type": "string", "description": "Display Name. Limit 64 characters." }, "createTime": { "readOnly": true, "description": "Output only. The time at which the authorized view was created.", "format": "google-datetime", "type": "string" }, "conversationFilter": { "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.", "type": "string" } }, "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": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "GoogleCloudContactcenterinsightsV1AssistantMessage": { "description": "A message in an assistant session.", "type": "object", "properties": { "chunks": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantChunk" }, "description": "Required. Content of the message.", "type": "array" }, "role": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The user role.", "The model role." ], "enum": [ "ROLE_UNSPECIFIED", "USER", "MODEL" ], "description": "Required. Role within the conversation." }, "eventTime": { "description": "Required. Timestamp when the message was sent or received.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1AssistantMessage" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "properties": {}, "description": "The response to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", "description": "The metadata for querying performance overview.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse": { "properties": { "qaQuestions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" }, "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." } }, "description": "The response from a ListQaQuestions request.", "id": "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1Assessment": { "description": "The assessment resource.", "id": "GoogleCloudContactcenterinsightsV1Assessment", "properties": { "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the assessment was created.", "type": "string" }, "updateTime": { "description": "Output only. The time at which the assessment was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "agentInfo": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "description": "Information about the agent the assessment is for." }, "state": { "description": "Output only. The state of the assessment.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED", "APPEALED", "FINALIZED" ], "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "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": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." }, "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." ], "description": "Options for what to do if the destination table already exists.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] }, "exportSchemaVersion": { "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." ], "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" ], "description": "Optional. Version of the export schema.", "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}" } }, "type": "object", "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" }, "GoogleCloudContactcenterinsightsV1Issue": { "type": "object", "properties": { "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "sampleUtterances": { "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "displayName": { "type": "string", "description": "The representative name for the issue." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this issue was created.", "type": "string" } }, "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1Issue" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "type": "object", "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "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" } } }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "type": "object", "properties": { "confidence": { "description": "The confidence score of the summarization.", "format": "float", "type": "number" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that contains metadata about the summarization and the document from which it originates." }, "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "textSections": { "additionalProperties": { "type": "string" }, "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." }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn.", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse": { "description": "The response message for listing auto labeling rules.", "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": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "properties": { "createTime": { "type": "string", "description": "The time the operation was created.", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "description": "The original export request." }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "type": "object", "properties": { "summarizationModel": { "description": "Default summarization model to be used.", "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." ], "enumDeprecated": [ false, true, true ], "type": "string", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" }, "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "properties": { "displayName": { "type": "string", "description": "The agent's name." }, "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" }, "deploymentDisplayName": { "type": "string", "description": "The agent's deployment display name. Only applicable to automated agents." }, "location": { "type": "string", "description": "The agent's location." }, "versionDisplayName": { "type": "string", "description": "The agent's version display name. Only applicable to automated agents." }, "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." ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "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": { "type": "string", "description": "The agent's version ID. Only applicable to automated agents." }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." }, "teams": { "type": "array", "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" } } }, "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "type": "object", "description": "The metadata for updating a QaQuestionTag Resource.", "properties": { "createTime": { "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime" }, "endTime": { "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "properties": { "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" }, "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" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "type": "object", "description": "Agent Assist frequently-asked-question answer data.", "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" } }, "description": "Metadata for creating an issue model." }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "properties": { "audioDuration": { "format": "google-duration", "type": "string", "description": "The duration of the audio." }, "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "type": "object", "description": "A wrapper for holding the audio for any given turn." }, "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "failedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed correlation." }, "correlatedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations correlated." }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "format": "int32", "type": "integer" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "type": "object", "description": "The metadata from querying metrics.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "type": "object", "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.", "properties": { "updateTime": { "description": "Output only. Update time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "name": { "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "label": { "type": "string", "description": "String label used for Topic Modeling." }, "createTime": { "type": "string", "description": "Output only. Create time of the label.", "format": "google-datetime", "readOnly": true }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "properties": {}, "description": "The response to deploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart": { "description": "A table part.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTablePart", "properties": { "rows": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartTableRow" }, "description": "Optional. Table rows." }, "title": { "description": "Optional. Optional title for the table.", "type": "string" }, "headers": { "description": "Optional. Table column headers.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "properties": {}, "description": "The data for an interruption annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart": { "properties": { "payloadType": { "description": "Optional. Type identifier for the payload.", "type": "string" }, "payload": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Arbitrary structured payload.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartCustomPayloadPart", "type": "object", "description": "A custom payload part." }, "GoogleCloudContactcenterinsightsV1CalculateStatsRequest": { "type": "object", "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." } }, "description": "The request for calculating conversation statistics.", "id": "GoogleCloudContactcenterinsightsV1CalculateStatsRequest" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "description": "A product collection part.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart", "properties": { "products": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "description": "Optional. List of products.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "properties": { "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1HoldData" }, "annotationStartBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "format": "int32", "type": "integer" }, "interruptionData": { "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData", "description": "Data specifying an interruption." }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData" }, "issueMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData", "description": "Data specifying an issue match." }, "intentMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData", "description": "Data specifying an intent match." }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1SilenceData" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "type": "object", "description": "Response from import issue model", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } } }, "GoogleCloudCesV1mainToolResponse": { "id": "GoogleCloudCesV1mainToolResponse", "properties": { "response": { "type": "object", "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.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolsetTool": { "$ref": "GoogleCloudCesV1mainToolsetTool", "description": "Optional. The toolset tool that got executed." }, "tool": { "type": "string", "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "parentToolCallId": { "readOnly": true, "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" }, "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.", "type": "string", "readOnly": true }, "id": { "type": "string", "description": "Optional. The matching ID of the tool call the response is for." }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" } }, "type": "object", "description": "The execution result of a specific tool from the client or the agent." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "properties": { "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "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" }, "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." }, "agentVersionId": { "type": "string", "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." }, "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" }, "agentVersionDisplayName": { "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.", "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "type": "object", "description": "Metadata about the agent dimension." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "properties": {}, "description": "The response to deploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "type": "object", "description": "Average QA normalized score for the tag.", "properties": { "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "format": "double", "type": "number" }, "tag": { "type": "string", "description": "Tag name." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "type": "object", "properties": { "transcript": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "description": "The transcript of the generative insights conversation." }, "generativeResponses": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" }, "description": "The full list of generative responses. Each response is ordered by time.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse", "description": "The response for generative insights." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "type": "object", "properties": { "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p90": { "type": "number", "description": "The 90th percentile value.", "format": "double" }, "p99": { "format": "double", "description": "The 99th percentile value.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "properties": { "errorMessages": { "type": "array", "description": "The error message when the generative insights request fails.", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata", "description": "The metadata for generative insights.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "description": "A Cloud Storage source of conversation data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "properties": { "audioUris": { "items": { "type": "string" }, "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" }, "audioUri": { "type": "string", "deprecated": true, "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio." }, "transcriptUri": { "type": "string", "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript." } } }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "properties": { "dialogflowInteraction": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "description": "Dialogflow interaction data." }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" }, "annotationId": { "type": "string", "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}" }, "endBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "userInput": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "faqAnswer": { "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "description": "Agent Assist FAQ answer data." }, "cesEndSessionAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "description": "The CES end session annotation." }, "createTime": { "description": "The time at which this annotation was created.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "An annotation that was generated during the customer and agent interaction.", "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest", "description": "The request to undeploy an issue model.", "properties": { "name": { "type": "string", "description": "Required. The issue model to undeploy." } } }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "type": "object", "properties": { "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "type": "string" }, "location": { "type": "string", "description": "The agent's location." }, "entrySubagentDisplayName": { "type": "string", "description": "The entry subagent's display name." }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "dispositionCode": { "type": "string", "description": "A user-provided string indicating the outcome of the agent's segment of the call." }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." }, "teams": { "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" }, "type": "array" }, "versionDisplayName": { "type": "string", "description": "The agent's version display name. Only applicable to automated agents." }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "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" ] }, "displayName": { "description": "The agent's name.", "type": "string" } }, "description": "Information about an agent involved in the conversation.", "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" }, "GoogleCloudContactcenterinsightsV1mainEntity": { "id": "GoogleCloudContactcenterinsightsV1mainEntity", "properties": { "type": { "type": "string", "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`." ], "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "description": "The entity type." }, "metadata": { "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" }, "type": "object" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "salience": { "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.", "type": "number" }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The aggregate sentiment expressed for this entity in the conversation." } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "properties": { "percentileAudioInAudioOutLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for audio in audio out 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": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "properties": { "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." }, "filter": { "type": "string", "description": "Required. Filter used to select the subset of conversations to analyze." }, "relabel": { "type": "boolean", "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations." }, "analysisPercentage": { "format": "float", "type": "number", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" } }, "type": "object", "description": "The request to analyze conversations in bulk." }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "type": "object", "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "readOnly": true }, "relabel": { "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "completedAnalysesCount": { "type": "integer", "description": "The number of requested analyses that have completed successfully so far.", "format": "int32" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "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." }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QaScorecardRevision": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardRevision", "type": "object", "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": { "name": { "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The timestamp that the revision was created.", "readOnly": true }, "alternateIds": { "type": "array", "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "items": { "type": "string" }, "readOnly": true }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart": { "description": "A product collection part.", "properties": { "products": { "description": "Optional. List of products.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProductCollectionPart" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "text": { "items": { "type": "string" }, "type": "array", "description": "The text output from the LLM." }, "textType": { "type": "string", "description": "The type of text output.", "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." ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "description": "Request to export an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to export.", "type": "string" }, "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage URI to export the issue model to." } } }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "properties": { "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime", "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true } }, "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "properties": { "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" }, "type": "array", "description": "Ordered list of messages, including user inputs and system responses." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The create time of the conversation." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The update time of the conversation.", "readOnly": true } }, "description": "The conversation transcript for the chart.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "description": "The analysis resource.", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes." }, "analysisResult": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "description": "Output only. The result of the analysis, which is populated when the analysis finishes." }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "requestTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the analysis was requested.", "type": "string" }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "description": "Response from import issue model", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" }, "type": "array" } }, "description": "A wrapper for system messages per turn.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "type": "object", "properties": { "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "format": "double", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "type": "integer", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "dialogflowInteractionsNoInputRatio": { "type": "number", "description": "Proportion of dialogflow interactions that has empty input.", "format": "double" }, "conversationAiCoachSuggestionCount": { "format": "int32", "type": "integer", "description": "Count of conversations that has Ai Coach Suggestions." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "format": "double", "type": "number" }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "format": "double", "type": "number" }, "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" }, "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "summarizationSuggestionResultCount": { "type": "integer", "description": "Count of summarization suggestions results.", "format": "int32" }, "knowledgeAssistUriClickRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "qaTagScores": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags." }, "dialogflowConversationsEscalationRatio": { "type": "number", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "format": "double" }, "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." }, "knowledgeAssistResultCount": { "type": "integer", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "format": "int32" }, "averageTurnCount": { "type": "number", "description": "The average turn count.", "format": "float" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "knowledgeAssistNegativeFeedbackRatio": { "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "format": "double" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "aiCoachSuggestionAgentUsageCount": { "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "int32" }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations scanned by the AA human supervisor." }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "format": "int32", "type": "integer" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "conversationalAgentsAverageTtsLatency": { "type": "number", "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" }, "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.", "format": "double", "type": "number" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "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" }, "conversationTotalAgentMessageCount": { "format": "int32", "type": "integer", "description": "The agent message count." }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "format": "float", "type": "number" }, "aaSupervisorAssignedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were assigned to an AA human supervisor." }, "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" }, "knowledgeSearchPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, "conversationSuggestedSummaryRatio": { "type": "number", "description": "Proportion of conversations that had a suggested summary.", "format": "double" }, "summarizationSuggestionEditRatio": { "type": "number", "format": "double", "description": "Proportion of summarization suggestions that were manually edited." }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "format": "double", "type": "number" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "format": "double", "type": "number" }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "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" }, "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" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "type": "integer", "description": "Count of customer messages that triggered an Ai Coach Suggestion." }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "containedConversationRatio": { "format": "double", "type": "number", "description": "The percentage of conversations that were contained." }, "avgConversationClientTurnSentimentEma": { "type": "number", "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation." }, "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" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "format": "int32", "type": "integer" }, "knowledgeAssistPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "averageClientSentimentScore": { "format": "float", "description": "The average client's sentiment score.", "type": "number" }, "knowledgeSearchUriClickRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "type": "integer", "description": "The number of conversations transferred to a human agent." } } }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "description": "The data for a hold annotation.", "properties": {} }, "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse": { "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." }, "qaQuestionTags": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "type": "array", "description": "The parent resource of the questions." } }, "description": "The response from a ListQaQuestionTags request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse" }, "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup": { "description": "A message representing a rule in the phrase matcher.", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup", "properties": { "type": { "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" ], "type": "string" }, "phraseMatchRules": { "type": "array", "description": "A list of phrase match rules that are included in this group.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchRule" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "properties": { "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "type": "object", "description": "All the entities in the call." }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" }, "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "description": "All the matched intents in the call.", "type": "object" }, "annotations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" }, "description": "A list of call annotations that apply to this call." }, "sentiments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" }, "description": "Overall conversation-level sentiment for each channel of the call." }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "type": "object" }, "silence": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "qaScorecardResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" }, "description": "Results of scoring QaScorecards.", "type": "array" } }, "type": "object", "description": "Call-specific metadata created during analysis.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created." } }, "type": "object", "description": "Metadata for creating an issue.", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1SpeechConfig": { "type": "object", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "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." } }, "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.", "id": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "type": "object", "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "properties": { "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "properties": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "description": "Output only. The original request.", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata", "type": "object", "description": "The metadata for updating a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "properties": { "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" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" }, "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." }, "sampleSize": { "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.", "type": "integer" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource", "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": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "description": "The request to ingest conversations." }, "GoogleCloudContactcenterinsightsV1Dataset": { "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", "id": "GoogleCloudContactcenterinsightsV1Dataset", "properties": { "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "type": { "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "description": "Dataset usage type." }, "updateTime": { "type": "string", "description": "Output only. Dataset update time.", "readOnly": true, "format": "google-datetime" }, "ttl": { "type": "string", "format": "google-duration", "description": "Optional. Option TTL for the dataset." }, "description": { "description": "Dataset description.", "type": "string" }, "displayName": { "type": "string", "description": "Display name for the dataaset" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Dataset create time." } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "properties": { "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "type": "array" }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" }, "sourceType": { "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "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" }, "normalizedScore": { "format": "double", "type": "number", "description": "The normalized score, which is the score divided by the potential score." }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource", "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." }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." } }, "type": "object", "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "description": "The response to deploy an issue model.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "type": "object", "properties": { "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" }, "endTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running." }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "description": "The original request for export." }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." } }, "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "description": "Google Cloud Storage Object URI to save the issue model to.", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartThoughtPart", "description": "A thought part.", "type": "object", "properties": { "text": { "type": "string", "description": "Optional. The thought or reasoning text." } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "description": "The request to deploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "type": "object", "description": "Metadata about the client sentiment category dimension.", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "properties": { "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" }, "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript.", "properties": { "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "confidence": { "format": "float", "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" }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "format": "google-duration", "type": "string" }, "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "properties": { "correlationId": { "type": "string", "description": "The correlation ID generated by the join key expression." }, "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "type": "string", "description": "The rule ID." } } }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource", "type": "object", "properties": { "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": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "sourceType": { "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "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." ] } }, "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { "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": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "generatedSqlQuery": { "type": "string", "description": "Raw SQL from LLM, before templatization" }, "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange", "properties": { "quantity": { "type": "string", "description": "Required. The quantity of units in the past.", "format": "int64" }, "unit": { "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "type": "string", "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "description": "Required. The unit of time." } }, "description": "Relative date range configuration." }, "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue." }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1Issue" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueRequest", "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "properties": { "ruleResults": { "description": "The results for each correlation rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" }, "type": "array" }, "conversation": { "description": "The conversation resource name.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { "description": "Google Cloud Storage Object URI to get the issue model file from.", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "type": "object", "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse": { "type": "object", "properties": { "qaScorecardRevisions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "description": "The QaScorecards under the parent." }, "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 from a ListQaScorecardRevisions request.", "id": "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse" }, "GoogleCloudContactcenterinsightsV1ListViewsResponse": { "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." }, "views": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "type": "array", "description": "The views that match the request." } }, "description": "The response of listing views.", "id": "GoogleCloudContactcenterinsightsV1ListViewsResponse", "type": "object" }, "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig": { "type": "object", "description": "Configuration information of a phrase match rule.", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig", "properties": { "exactMatchConfig": { "description": "The configuration for the exact match rule.", "$ref": "GoogleCloudContactcenterinsightsV1ExactMatchConfig" }, "regexMatchConfig": { "description": "The configuration for the regex match rule.", "$ref": "GoogleCloudContactcenterinsightsV1RegexMatchConfig" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "type": "object", "description": "A segment of a full transcript.", "properties": { "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The sentiment for this transcript segment." }, "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\"." }, "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" }, "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.", "type": "integer", "format": "int32" }, "dialogflowSegmentMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "CCAI metadata relating to the current transcript segment." }, "words": { "type": "array", "description": "A list of the word-specific information for each word in the segment.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" } }, "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "text": { "type": "string", "description": "The text of this segment." }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "parts": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPart" }, "type": "array", "description": "Optional. The structured parts that make up this transcript segment." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer", "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" ], "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.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ListDatasetsResponse": { "type": "object", "description": "The response to list datasets.", "id": "GoogleCloudContactcenterinsightsV1ListDatasetsResponse", "properties": { "datasets": { "type": "array", "description": "The datasets that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "properties": { "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-`" }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation." }, "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation", "description": "Required. The conversation resource to create." }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" } }, "description": "Request to upload a conversation.", "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataOptions": { "properties": { "includeDialogflowInteractionData": { "type": "boolean", "description": "Whether to include the per turn Dialogflow interaction data in conversation transcript." } }, "type": "object", "description": "Options for configuring what metadata is included in the conversation data used in QAI and Discovery Engine.", "id": "GoogleCloudContactcenterinsightsV1ConversationDataOptions" }, "GoogleCloudCesV1mainChunk": { "description": "A chunk of content within a message.", "properties": { "image": { "$ref": "GoogleCloudCesV1mainImage", "description": "Optional. Image data." }, "toolCall": { "$ref": "GoogleCloudCesV1mainToolCall", "description": "Optional. Tool execution request." }, "defaultVariables": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct represents default variables at the start of the conversation, keyed by variable names." }, "payload": { "type": "object", "description": "Optional. Custom payload data.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "text": { "type": "string", "description": "Optional. Text data." }, "blob": { "description": "Optional. Blob data.", "$ref": "GoogleCloudCesV1mainBlob" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "GoogleCloudCesV1mainToolResponse" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "updatedVariables": { "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "GoogleCloudCesV1mainAgentTransfer" } }, "id": "GoogleCloudCesV1mainChunk", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "description": "Metadata about the conversation profile dimension." }, "GoogleCloudContactcenterinsightsV1CorrelationConfig": { "properties": { "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The time at which the correlation config was last updated.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time at which the correlation config was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "fullConversationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationTypeConfig", "description": "The correlation type config for full conversations." } }, "description": "A configuration that defines how to correlate conversations for a given a given project.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CorrelationConfig" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "exportSchemaVersion": { "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" ], "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." ] }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "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" }, "bigQueryDestination": { "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." }, "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" } }, "description": "The request to export insights.", "type": "object" }, "GoogleCloudCesV1mainBlob": { "properties": { "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data." }, "data": { "description": "Required. Raw bytes of the blob.", "format": "byte", "type": "string" } }, "type": "object", "id": "GoogleCloudCesV1mainBlob", "description": "Represents a blob input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "type": "object", "description": "Call-specific metadata created during analysis.", "properties": { "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" }, "description": "All the matched intents in the call.", "type": "object" }, "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "type": "array", "description": "A list of call annotations that apply to this call." }, "issueModelResult": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult", "description": "Overall conversation-level issue modeling result." }, "sentiments": { "type": "array", "description": "Overall conversation-level sentiment for each channel of the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" } }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "type": "object" }, "entities": { "description": "All the entities in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" } }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" } }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence" } }, "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "id": "GoogleCloudContactcenterinsightsV1mainSampleRule", "type": "object", "properties": { "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" }, "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": { "type": "number", "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100]." } }, "description": "Message for sampling conversations." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "type": "object", "description": "Metadata used for import issue model.", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "description": "The original import request." } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest": { "description": "Request for TuneQaScorecardRevision endpoint.", "id": "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest", "type": "object", "properties": { "validateOnly": { "type": "boolean", "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." }, "filter": { "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.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentTranscriptPartTableRow", "description": "A row in a table.", "type": "object", "properties": { "cells": { "description": "Optional. The cell values in the row.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "properties": { "turnCount": { "type": "integer", "description": "Output only. The number of turns in the conversation.", "format": "int32", "readOnly": true }, "transcript": { "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "readOnly": true }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "description": "The source of the audio and transcription for the conversation." }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the conversation was created." }, "medium": { "type": "string", "description": "Immutable. The conversation 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." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. The most recent time at which the conversation was updated.", "format": "google-datetime" }, "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" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "type": "object", "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 }, "duration": { "readOnly": true, "format": "google-duration", "type": "string", "description": "Output only. The duration of the conversation." }, "runtimeAnnotations": { "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" } }, "latestAnalysis": { "$ref": "GoogleCloudContactcenterinsightsV1Analysis", "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true }, "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "labels": { "additionalProperties": { "type": "string" }, "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.", "type": "object" }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "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." }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "startTime": { "format": "google-datetime", "type": "string", "description": "The time at which the conversation started." }, "qualityMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "description": "Conversation metadata related to quality management." }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" }, "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." } }, "type": "object", "description": "The conversation resource." }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "dialogflowConversation": { "type": "string", "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 } }, "description": "A Dialogflow source of conversation data." }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA scorecard dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "type": "object", "description": "An answer to a QaQuestion.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "properties": { "answerSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" }, "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." }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "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.", "type": "array", "items": { "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" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "unclassifiedConversationsCount": { "format": "int64", "type": "string", "description": "Number of analyzed conversations for which no issue was applicable at this point in time." }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" }, "type": "object" }, "analyzedConversationsCount": { "type": "string", "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "type": "string", "description": "Optional. The conversation profile ID." } }, "description": "Metadata about the conversation profile dimension." }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "description": "The call participant speaking for a given utterance.", "properties": { "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "role": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_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." ], "description": "The role of the participant.", "type": "string" }, "obfuscatedExternalUserId": { "type": "string", "description": "Obfuscated user ID from Dialogflow." }, "dialogflowParticipant": { "type": "string", "deprecated": true, "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" }, "dialogflowParticipantName": { "type": "string", "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem", "type": "object", "description": "An item in a list.", "properties": { "subItems": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartListItem" }, "description": "Optional. Nested sub-items." }, "text": { "type": "string", "description": "Optional. The text of the list item." } } }, "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" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult", "type": "object", "properties": { "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" }, "ruleId": { "type": "string", "description": "The rule ID." } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "properties": { "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "annotatorSelector": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "Output only. The annotator selector used for the analysis (if any)." } } }, "GoogleCloudContactcenterinsightsV1RegexMatchConfig": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1RegexMatchConfig", "description": "Regex match configuration." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartSuggestionChipsPart", "type": "object", "description": "A suggestion chips part.", "properties": { "chips": { "description": "Optional. List of suggestion chips.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip" } } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1alpha1Dimension": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dimension", "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", "properties": { "clientSentimentCategoryDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension." }, "conversationProfileDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "description": "Output only. Metadata about the conversation profile dimension.", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "readOnly": true }, "dimensionKey": { "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." ], "description": "The key of the dimension.", "type": "string" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" }, "agentDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, "qaScorecardDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Output only. Metadata about the QA scorecard dimension." }, "conversationalAgentsPlaybookDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata" }, "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "readOnly": true }, "qaQuestionDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension." }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "type": "object", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "GoogleCloudCesV1mainMessage": { "type": "object", "properties": { "chunks": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainChunk" }, "description": "Optional. Content of the message as a series of chunks." }, "role": { "type": "string", "description": "Optional. The role within the conversation, e.g., user, agent." }, "eventTime": { "type": "string", "format": "google-datetime", "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example." } }, "description": "A message within a conversation.", "id": "GoogleCloudCesV1mainMessage" }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "properties": { "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": { "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "description": "The type of the entity mention.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "GoogleCloudContactcenterinsightsV1mainConversation": { "properties": { "medium": { "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Immutable. The conversation 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" }, "expireTime": { "type": "string", "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" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "type": "object", "readOnly": true, "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}" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "type": "integer", "readOnly": true, "format": "int32" }, "latestAnalysis": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis", "readOnly": true, "description": "Output only. The conversation's latest analysis, if one exists." }, "correlationInfo": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "description": "Output only. Info for correlating across conversations.", "readOnly": true }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "runtimeAnnotations": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction." }, "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" }, "startTime": { "format": "google-datetime", "description": "The time at which the conversation started.", "type": "string" }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "format": "google-duration", "type": "string" }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "duration": { "description": "Output only. The duration of the conversation.", "format": "google-duration", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated." }, "languageCode": { "type": "string", "description": "A user-specified language code for the conversation." }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "description": "The source of the audio and transcription for the conversation." }, "createTime": { "readOnly": true, "description": "Output only. The time at which the conversation was created.", "type": "string", "format": "google-datetime" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "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" } }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" } }, "description": "The conversation resource.", "id": "GoogleCloudContactcenterinsightsV1mainConversation", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "description": "The request to delete conversations in bulk.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "properties": { "maxDeleteCount": { "type": "integer", "description": "Maximum number of conversations to delete.", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output.", "properties": { "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" }, "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" ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "type": "object", "description": "The data for a silence annotation.", "id": "GoogleCloudContactcenterinsightsV1mainSilenceData", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "type": "object", "description": "The request to analyze conversations in bulk.", "properties": { "relabel": { "type": "boolean", "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations." }, "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." }, "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "filter": { "type": "string", "description": "Required. Filter used to select the subset of conversations to analyze." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "description": "The feedback that the customer has about a certain answer in the conversation.", "properties": { "correctnessLevel": { "description": "The correctness level of an answer.", "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" ] }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", "type": "object", "properties": { "potentialScore": { "format": "double", "type": "number", "description": "The potential score the tag applies to." }, "normalizedScore": { "description": "The normalized score the tag applies to.", "format": "double", "type": "number" }, "score": { "format": "double", "description": "The score the tag applies to.", "type": "number" }, "tag": { "type": "string", "description": "The tag the score applies to." } }, "description": "Tags and their corresponding results." }, "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse", "description": "The response of listing views.", "properties": { "analysisRules": { "description": "The analysis_rule that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "type": "array" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "description": "The data for a sentiment annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "type": "object", "properties": { "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." }, "magnitude": { "type": "number", "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score." } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "readOnly": true, "description": "Output only. The original request for sample conversations to dataset." }, "partialErrors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete." }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1ListChartsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListChartsResponse", "type": "object", "description": "The response of listing charts.", "properties": { "charts": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" }, "description": "The charts under the parent." }, "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." } } }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "description": "Request to upload a conversation.", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "type": "object", "properties": { "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversation" }, "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" }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings." }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation." } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "type": "object", "properties": { "status": { "$ref": "GoogleRpcStatus", "description": "The error status." }, "conversation": { "type": "string", "description": "The conversation resource name that had an error during correlation." } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "type": "object", "properties": { "silenceDuration": { "format": "google-duration", "description": "Amount of time calculated to be in silence.", "type": "string" }, "silencePercentage": { "type": "number", "description": "Percentage of the total conversation spent in silence.", "format": "float" } }, "description": "Conversation-level silence data.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "properties": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "type": "integer", "format": "int32" }, "relabel": { "type": "boolean", "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations." }, "partialErrors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "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" } }, "description": "The metadata for a bulk analyze conversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "properties": { "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "Sentiment expressed for this mention of the entity." }, "type": { "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "type": "string", "description": "The type of the entity mention." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1Dataset": { "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)", "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset", "type": "object", "properties": { "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Dataset update time.", "format": "google-datetime" }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "name": { "type": "string", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Dataset create time." }, "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" ] }, "displayName": { "type": "string", "description": "Display name for the dataaset" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "description": "Request to import an issue model.", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model.", "type": "object", "properties": { "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" }, "medium": { "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", "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." ] }, "trainingConversationsCount": { "type": "string", "format": "int64", "readOnly": true, "description": "Output only. Number of conversations used in training. Output only." } } }, "GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions": { "type": "object", "properties": { "conversationDataOptions": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataOptions", "description": "Options for configuring the conversation data used to generate the QA question." } }, "description": "Options for configuring the data used to generate the QA question.", "id": "GoogleCloudContactcenterinsightsV1QaQuestionQaQuestionDataOptions" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "type": "object", "properties": { "toolDisplayName": { "type": "string", "description": "Optional. The dialogflow tool display name." }, "toolId": { "type": "string", "description": "Optional. The dialogflow tool ID." } }, "description": "Metadata about the Conversational Agents tool dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1AnalysisRule": { "id": "GoogleCloudContactcenterinsightsV1AnalysisRule", "type": "object", "properties": { "displayName": { "type": "string", "description": "Display Name of the analysis rule." }, "name": { "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, "createTime": { "description": "Output only. The time at which this analysis rule was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "conversationFilter": { "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.", "type": "string" }, "annotatorSelector": { "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.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "analysisPercentage": { "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.", "format": "double" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", "type": "boolean" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The most recent time at which this analysis rule was updated.", "type": "string" } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart": { "properties": { "uri": { "type": "string", "description": "Optional. Target URI." }, "text": { "description": "Optional. Anchor or display text.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartLinkPart", "type": "object", "description": "A link part." }, "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse", "type": "object", "description": "The response of listing issue models.", "properties": { "issueModels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" }, "description": "The issue models that match the request.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainDataset": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDataset", "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)", "properties": { "description": { "type": "string", "description": "Dataset description." }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Dataset update time." }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "type": { "type": "string", "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.", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Dataset create time.", "readOnly": true }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "properties": { "wordIndex": { "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer" }, "transcriptIndex": { "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1AuthorizedViewSet": { "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Update time.", "readOnly": true }, "displayName": { "type": "string", "description": "Display Name. Limit 64 characters." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Create time.", "format": "google-datetime" }, "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet", "type": "object", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "properties": { "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" } }, "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult", "properties": { "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "normalizedScore": { "type": "number", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "format": "double" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The timestamp that the revision was created." }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "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." }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" } }, "name": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "score": { "type": "number", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "format": "double" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" } } }, "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "type": "object", "description": "Container for a list of scorecards.", "properties": { "qaScorecardRevisions": { "type": "array", "items": { "type": "string" }, "description": "List of QaScorecardRevisions." } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip": { "type": "object", "properties": { "actionUri": { "type": "string", "description": "Optional. Optional action or destination URI triggered by the chip." }, "text": { "type": "string", "description": "Optional. The chip label or text." } }, "description": "A suggestion chip.", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentTranscriptPartChip" }, "GoogleCloudContactcenterinsightsV1ListConversationsResponse": { "properties": { "conversations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "description": "The conversations that match the request." }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ListConversationsResponse", "description": "The response of listing conversations." }, "GoogleIamV1Binding": { "properties": { "members": { "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`.", "items": { "type": "string" } }, "condition": { "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).", "$ref": "GoogleTypeExpr" }, "role": { "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).", "type": "string" } }, "type": "object", "id": "GoogleIamV1Binding", "description": "Associates `members`, or principals, with a `role`." }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "properties": { "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "strValue": { "description": "String value.", "type": "string" }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "readOnly": true, "type": "number", "format": "double" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "normalizedScore": { "readOnly": true, "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double" }, "boolValue": { "type": "boolean", "description": "Boolean value." }, "score": { "description": "Output only. Numerical score of the answer.", "readOnly": true, "format": "double", "type": "number" }, "skipValue": { "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.", "type": "boolean", "readOnly": true } }, "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "description": "The response for querying metrics.", "properties": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "slices": { "type": "array", "items": { "$ref": "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." }, "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": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "The metrics last update time." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "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": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "type": "object", "properties": { "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "type": "array" }, "timeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "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": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" } } }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "properties": { "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." }, "normalizedScore": { "type": "number", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "format": "double", "readOnly": true }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "boolValue": { "type": "boolean", "description": "Boolean value." }, "score": { "format": "double", "readOnly": true, "type": "number", "description": "Output only. Numerical score of the answer." }, "numValue": { "type": "number", "format": "double", "description": "Numerical value." }, "strValue": { "type": "string", "description": "String value." }, "key": { "type": "string", "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key." }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "type": "number", "format": "double", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse", "type": "object", "description": "The response of testing correlation config.", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "type": "object", "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", "format": "google-datetime", "readOnly": true }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" } }, "description": "Metadata for deploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct": { "properties": { "price": { "description": "Optional. Product price.", "$ref": "GoogleTypeMoney" }, "displayName": { "type": "string", "description": "Optional. Product display name." }, "id": { "type": "string", "description": "Optional. Product ID." }, "description": { "description": "Optional. Product description.", "type": "string" }, "imageUris": { "type": "array", "description": "Optional. Product image URLs.", "items": { "type": "string" } }, "uri": { "description": "Optional. Product URL or deep link.", "type": "string" } }, "type": "object", "description": "A product in a product collection.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentTranscriptPartProduct" }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "type": "object", "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "type": "string", "description": "Optional. The full body of the question." } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object", "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "description": "The request to create an issue.", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue", "description": "Required. The values for the new issue." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "type": "object" }, "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).", "type": "object", "properties": { "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "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." } }, "id": "GoogleRpcStatus" }, "GoogleCloudContactcenterinsightsV1GcsSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1GcsSource", "description": "A Cloud Storage source of conversation data.", "properties": { "audioUri": { "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string", "deprecated": true }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUris": { "type": "array", "items": { "type": "string" }, "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)." } } }, "GoogleCloudContactcenterinsightsV1StreamChatRequest": { "description": "Request to stream chat.", "type": "object", "properties": { "message": { "description": "Required. The message to send to the assistant.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1StreamChatRequest" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { "properties": { "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" } }, "total": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request." }, "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]" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", "description": "Response from export issue model" } }, "baseUrl": "https://contactcenterinsights.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "name": "contactcenterinsights", "basePath": "", "parameters": { "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "quotaUser": { "location": "query", "type": "string", "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." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "prettyPrint": { "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string", "location": "query" }, "key": { "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.", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "alt": { "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "default": "json" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." } }, "resources": { "projects": { "resources": { "locations": { "resources": { "conversations": { "resources": { "segments": { "methods": { "bulkAnalyze": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "description": "Analyzes multiple conversations in a single request.", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource to create analyses in." } }, "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "path": "v1/{+parent}/segments:bulkAnalyze" } } }, "assessments": { "methods": { "appeal": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "parameterOrder": [ "name" ], "path": "v1/{+name}:appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "description": "Appeal an Assessment.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the assessment to appeal.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "finalize": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:finalize", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the assessment to finalize.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "httpMethod": "POST", "description": "Finalize an Assessment.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "description": "List Assessments.", "parameters": { "parent": { "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "pageToken": { "location": "query", "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." }, "filter": { "location": "query", "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", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "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.", "format": "int32" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" }, "parameterOrder": [ "parent" ] }, "get": { "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "description": "Get Assessment.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the assessment to get.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "GET" }, "create": { "description": "Create Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the assessment.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "path": "v1/{+parent}/assessments", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.create" }, "delete": { "path": "v1/{+name}", "parameters": { "force": { "type": "boolean", "location": "query", "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." }, "name": { "type": "string", "location": "path", "required": true, "description": "Required. The name of the assessment to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "description": "Delete an Assessment." }, "publish": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The name of the assessment to publish.", "location": "path", "required": true } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "description": "Publish an Assessment.", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" }, "path": "v1/{+name}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish" } }, "resources": { "notes": { "methods": { "list": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/notes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "parameters": { "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.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "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." }, "parent": { "type": "string", "description": "Required. The parent resource of the notes.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListNotesResponse" }, "description": "List Notes." }, "create": { "description": "Create Note.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "parameters": { "parent": { "description": "Required. The parent resource of the note.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "path": "v1/{+parent}/notes", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "name": { "description": "Required. The name of the note to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1/{+name}", "description": "Deletes a Note.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "httpMethod": "PATCH", "description": "Update Note.", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "type": "string", "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`", "format": "google-fieldmask", "location": "query" }, "name": { "location": "path", "required": true, "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" } } } } }, "analyses": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "path": "v1/{+parent}/analyses", "description": "Creates an analysis. The long running operation is done when the analysis has completed.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the analysis.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the analysis to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an analysis.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}", "id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "parameterOrder": [ "name" ] }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Gets an analysis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "parameters": { "name": { "description": "Required. The name of the analysis to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}" }, "list": { "httpMethod": "GET", "path": "v1/{+parent}/analyses", "id": "contactcenterinsights.projects.locations.conversations.analyses.list", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the analyses.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" }, "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." }, "pageSize": { "type": "integer", "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.", "location": "query", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." } }, "description": "Lists analyses.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "feedbackLabels": { "methods": { "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the feedback label.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "feedbackLabelId": { "location": "query", "type": "string", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." } }, "description": "Create feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "path": "v1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "httpMethod": "DELETE", "description": "Delete feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to delete.", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "Get feedback label.", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "required": true } }, "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "patch": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Update feedback label.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "location": "path", "required": true }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated." } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "list": { "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "type": "string" }, "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.", "type": "string", "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.", "format": "int32", "type": "integer", "location": "query" }, "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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "description": "List feedback labels.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "path": "v1/{+parent}/feedbackLabels", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" } } } } }, "methods": { "upload": { "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.conversations.upload", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "path": "v1/{+parent}/conversations:upload", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.get", "path": "v1/{+name}", "description": "Gets a conversation.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "parameters": { "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 `FULL`." }, "name": { "description": "Required. The name of the conversation to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET" }, "sample": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.sample", "httpMethod": "POST", "path": "v1/{+parent}/conversations:sample", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the dataset." } } }, "bulkAnalyze": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "path": "v1/{+parent}/conversations:bulkAnalyze", "parameterOrder": [ "parent" ], "description": "Analyzes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource to create analyses in." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "httpMethod": "POST" }, "calculateStats": { "description": "Gets conversation statistics.", "parameterOrder": [ "location" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", "path": "v1/{+location}/conversations:calculateStats", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.calculateStats", "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The location of the conversations.", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties." } } }, "generateSignedAudio": { "parameterOrder": [ "name" ], "description": "Gets the signed URI for the audio for the given conversation.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" }, "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to sign.", "type": "string", "location": "path", "required": true } }, "path": "v1/{+name}:generateSignedAudio" }, "bulkDelete": { "path": "v1/{+parent}/conversations:bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "description": "Deletes multiple conversations in a single request.", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "list": { "description": "Lists conversations.", "id": "contactcenterinsights.projects.locations.conversations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "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" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "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" }, "view": { "description": "The level of details of the conversation. Default is `BASIC`.", "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." ], "location": "query", "type": "string", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ] }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "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." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" } }, "create": { "id": "contactcenterinsights.projects.locations.conversations.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "path": "v1/{+parent}/conversations", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversation.", "type": "string" }, "conversationId": { "type": "string", "location": "query", "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-`" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations" }, "delete": { "parameters": { "name": { "description": "Required. The name of the conversation to delete.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "force": { "type": "boolean", "location": "query", "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." } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a conversation.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.conversations.delete" }, "ingest": { "path": "v1/{+parent}/conversations:ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.ingest", "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "httpMethod": "POST", "description": "Imports conversations and processes them according to the user's configuration.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "description": "Updates a conversation.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "updateMask": { "type": "string", "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`", "format": "google-fieldmask", "location": "query" }, "allowMissing": { "type": "boolean", "location": "query", "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." }, "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the conversation will be updated with auto labeling results." } }, "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.conversations.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "path": "v1/{+name}" } } }, "phraseMatchers": { "methods": { "create": { "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "httpMethod": "POST", "description": "Creates a phrase matcher.", "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "path": "v1/{+parent}/phraseMatchers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" } }, "delete": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "description": "Deletes a phrase matcher.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the phrase matcher to delete.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$" } } }, "patch": { "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "The list of fields to be updated." }, "name": { "location": "path", "required": true, "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "type": "string" } }, "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, "description": "Updates a phrase matcher.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, "parameterOrder": [ "name" ] }, "list": { "parameters": { "parent": { "description": "Required. The parent resource of the phrase matcher.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "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" }, "pageSize": { "location": "query", "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.", "type": "integer", "format": "int32" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", "location": "query", "type": "string" } }, "description": "Lists phrase matchers.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse" }, "path": "v1/{+parent}/phraseMatchers", "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers" }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The name of the phrase matcher to get.", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatcher" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "description": "Gets a phrase matcher.", "parameterOrder": [ "name" ] } } }, "autoLabelingRules": { "methods": { "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "id": "contactcenterinsights.projects.locations.autoLabelingRules.list", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous List request, if any." }, "parent": { "type": "string", "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "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.", "type": "integer" } }, "description": "Lists auto labeling rules.", "path": "v1/{+parent}/autoLabelingRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAutoLabelingRulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets an auto labeling rule.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "location": "path", "required": true } }, "path": "v1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "parameterOrder": [ "name" ] }, "create": { "description": "Creates an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}", "location": "path", "required": true, "type": "string" }, "autoLabelingRuleId": { "location": "query", "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.", "type": "string" } }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "path": "v1/{+parent}/autoLabelingRules" }, "delete": { "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an auto labeling rule.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}" }, "patch": { "description": "Updates an auto labeling rule.", "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1AutoLabelingRule" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "location": "path", "required": true, "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "type": "string", "location": "query" } }, "path": "v1/{+name}" }, "test": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleResponse" }, "path": "v1/{+parent}/autoLabelingRules:test", "description": "Tests auto labeling rules against a conversation.", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1TestAutoLabelingRuleRequest" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "analysisRules": { "methods": { "get": { "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.analysisRules.get", "path": "v1/{+name}", "description": "Get a analysis rule.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "parameters": { "name": { "description": "Required. The name of the AnalysisRule to get.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "description": "Updates a analysis rule.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "id": "contactcenterinsights.projects.locations.analysisRules.patch", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields." } } }, "list": { "path": "v1/{+parent}/analysisRules", "id": "contactcenterinsights.projects.locations.analysisRules.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse" }, "description": "Lists analysis rules.", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "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." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the analysis rules." }, "pageToken": { "location": "query", "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.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules", "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules", "httpMethod": "POST", "description": "Creates a analysis rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`" } }, "id": "contactcenterinsights.projects.locations.analysisRules.create", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/analysisRules", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisRule" } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.analysisRules.delete", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "description": "Required. The name of the analysis rule to delete.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a analysis rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}" } } }, "authorizedViewSets": { "methods": { "create": { "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the AuthorizedViewSet." }, "authorizedViewSetId": { "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", "type": "string", "location": "query" } }, "httpMethod": "POST", "path": "v1/{+parent}/authorizedViewSets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "description": "Create AuthorizedViewSet", "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" } }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "description": "Deletes an AuthorizedViewSet.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "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." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "description": "Required. The name of the AuthorizedViewSet to delete.", "location": "path", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List AuthorizedViewSets", "parameters": { "pageToken": { "type": "string", "location": "query", "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." }, "filter": { "type": "string", "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "location": "query" }, "parent": { "description": "Required. The parent resource of the AuthorizedViewSets.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true }, "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.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. The order by expression to order authorized view sets listed in the response." } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "path": "v1/{+parent}/authorizedViewSets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "parameterOrder": [ "parent" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the AuthorizedViewSet to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path", "required": true, "type": "string" } }, "description": "Get AuthorizedViewSet", "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" }, "path": "v1/{+name}" }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path", "required": true, "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}" }, "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`", "format": "google-fieldmask", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" }, "description": "Updates an AuthorizedViewSet.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}" } }, "resources": { "authorizedViews": { "methods": { "queryPerformanceOverview": { "path": "v1/{+parent}:queryPerformanceOverview", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "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.", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryPerformanceOverview", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "parameterOrder": [ "parent" ] }, "create": { "parameters": { "parent": { "description": "Required. The parent resource of the AuthorizedView.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string" }, "authorizedViewId": { "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", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "path": "v1/{+parent}/authorizedViews", "description": "Create AuthorizedView" }, "delete": { "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the AuthorizedView to delete.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "description": "Deletes an AuthorizedView.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "parameterOrder": [ "resource" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "httpMethod": "GET", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "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." }, "options.requestedPolicyVersion": { "format": "int32", "location": "query", "type": "integer", "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)." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "response": { "$ref": "GoogleIamV1Policy" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get AuthorizedView", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The name of the AuthorizedView to get.", "type": "string" } } }, "setIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "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, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { "$ref": "GoogleIamV1Policy" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "queryMetrics": { "parameters": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "POST", "description": "Query metrics.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+location}:queryMetrics", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" }, "parameterOrder": [ "location" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "orderBy": { "type": "string", "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response." }, "pageToken": { "location": "query", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "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." }, "pageSize": { "type": "integer", "location": "query", "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.", "format": "int32" }, "filter": { "location": "query", "description": "Optional. The filter expression to filter authorized views listed in the response.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse" }, "path": "v1/{+parent}/authorizedViews", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "description": "List AuthorizedViewSets", "parameterOrder": [ "parent" ] }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "parameterOrder": [ "name" ], "description": "Updates an AuthorizedView.", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}" }, "updateMask": { "type": "string", "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: * `conversation_filter` * `display_name`", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}" }, "testIamPermissions": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "parameters": { "resource": { "type": "string", "location": "path", "required": true, "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.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "path": "v1/{+resource}:testIamPermissions", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.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.", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameterOrder": [ "resource" ] }, "generativeInsights": { "parameters": { "location": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" } }, "parameterOrder": [ "location" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.generativeInsights", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" }, "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "path": "v1/{+location}:generativeInsights", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights" }, "search": { "description": "SearchAuthorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse" }, "path": "v1/{+parent}/authorizedViews:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "parameters": { "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string" }, "pageToken": { "location": "query", "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." }, "pageSize": { "location": "query", "type": "integer", "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." }, "query": { "description": "Optional. The query expression to search authorized views.", "type": "string", "location": "query" }, "parent": { "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.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ] } }, "resources": { "operations": { "methods": { "list": { "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`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/operations", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "httpMethod": "GET", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "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.", "location": "query" }, "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations" }, "get": { "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.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "The name of the operation resource." } } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}: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`.", "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled." } } } } }, "conversations": { "methods": { "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/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the conversation to delete.", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation." }, "calculateStats": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "location" ], "httpMethod": "GET", "parameters": { "location": { "type": "string", "description": "Required. The location of the conversations.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "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.", "location": "query" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" }, "description": "Gets conversation statistics.", "path": "v1/{+location}/conversations:calculateStats", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "orderBy": { "type": "string", "location": "query", "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)." }, "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" }, "pageSize": { "type": "integer", "format": "int32", "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.", "location": "query" }, "view": { "type": "string", "description": "The level of details of the conversation. Default is `BASIC`.", "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." ], "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "location": "query" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists conversations.", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" } }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "view": { "type": "string", "location": "query", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "description": "The level of details of the conversation. Default is `FULL`.", "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": { "location": "path", "required": true, "description": "Required. The name of the conversation to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string" } }, "description": "Gets a conversation.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}" }, "generateSignedAudio": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the conversation to sign.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" }, "description": "Gets the signed URI for the audio for the given conversation.", "path": "v1/{+name}:generateSignedAudio" } }, "resources": { "assessments": { "methods": { "get": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The name of the assessment to get." } }, "description": "Get Assessment.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "appeal": { "parameters": { "name": { "type": "string", "description": "Required. The name of the assessment to appeal.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "required": true } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AppealAssessmentRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "parameterOrder": [ "name" ], "description": "Appeal an Assessment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "path": "v1/{+name}:appeal" }, "finalize": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest" }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to finalize.", "type": "string" } }, "description": "Finalize an Assessment.", "path": "v1/{+name}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" } }, "publish": { "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "description": "Publish an Assessment.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the assessment to publish.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1PublishAssessmentRequest" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "path": "v1/{+name}:publish", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "parameters": { "parent": { "description": "Required. The parent resource of the assessment.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "description": "Create Assessment.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Assessment" } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "description": "Delete an Assessment.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the assessment to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" }, "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" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAssessmentsResponse" }, "path": "v1/{+parent}/assessments", "description": "List Assessments.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character." }, "pageSize": { "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", "format": "int32", "location": "query" }, "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.", "type": "string", "location": "query" }, "filter": { "location": "query", "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", "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list", "parameterOrder": [ "parent" ] } }, "resources": { "notes": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "description": "Create Note.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The parent resource of the note." } }, "path": "v1/{+parent}/notes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "httpMethod": "POST" }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "description": "Required. The name of the note to delete.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } }, "patch": { "description": "Update Note.", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch", "parameters": { "updateMask": { "location": "query", "type": "string", "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`", "format": "google-fieldmask" }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1Note" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "path": "v1/{+name}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "path": "v1/{+parent}/notes", "description": "List Notes.", "httpMethod": "GET", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the notes.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "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." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListNotesResponse" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "feedbackLabels": { "methods": { "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "Get feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "path": "v1/{+name}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the feedback label to get." } }, "parameterOrder": [ "name" ], "httpMethod": "GET" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/feedbackLabels", "description": "Create feedback label.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "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": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback label." } }, "httpMethod": "POST" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the feedback label to delete." } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "parameters": { "filter": { "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", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "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." }, "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" }, "parent": { "description": "Required. The parent resource of the feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "v1/{+parent}/feedbackLabels", "description": "List feedback labels.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list" }, "patch": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "path": "v1/{+name}", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Required. The list of fields to be updated." }, "name": { "location": "path", "required": true, "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Update feedback label.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } } } } } } } } } }, "operations": { "methods": { "cancel": { "id": "contactcenterinsights.projects.locations.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "path": "v1/{+name}:cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "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": { "id": "contactcenterinsights.projects.locations.operations.get", "flatPath": "v1/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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "returnPartialSuccess": { "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.", "location": "query", "type": "boolean" } }, "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", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "path": "v1/{+name}/operations" } } }, "assistantSessions": { "methods": { "streamChat": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}:streamChat", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1StreamChatResponse" }, "description": "Streams chat messages from the assistant.", "parameters": { "name": { "description": "Required. The name of the assistant session to stream chat. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", "location": "path", "required": true } }, "id": "contactcenterinsights.projects.locations.assistantSessions.streamChat", "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1StreamChatRequest" }, "path": "v1/{+name}:streamChat" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" }, "description": "Creates an assistant session.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource where this assistant session will be created. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "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" } }, "id": "contactcenterinsights.projects.locations.assistantSessions.create", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/assistantSessions" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions", "path": "v1/{+parent}/assistantSessions", "parameterOrder": [ "parent" ], "description": "Lists assistant sessions.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource, which owns this collection of assistant sessions. Format: `projects/{project}/locations/{location}`", "location": "path", "required": true }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset.", "location": "query" }, "pageSize": { "format": "int32", "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.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListAssistantSessions` call. Provide this to retrieve the subsequent page." } }, "id": "contactcenterinsights.projects.locations.assistantSessions.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAssistantSessionsResponse" } }, "get": { "description": "Gets an assistant session.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1AssistantSession" }, "id": "contactcenterinsights.projects.locations.assistantSessions.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" } } }, "qaScorecards": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the QaScorecard to get.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "id": "contactcenterinsights.projects.locations.qaScorecards.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "description": "Gets a QaScorecard." }, "create": { "parameters": { "qaScorecardId": { "type": "string", "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-`.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaScorecard.", "location": "path", "required": true } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "description": "Create a QaScorecard.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "path": "v1/{+parent}/qaScorecards" }, "delete": { "description": "Deletes a QaScorecard.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "parameters": { "force": { "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.", "type": "boolean", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The name of the QaScorecard to delete.", "location": "path", "required": true } }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "id": "contactcenterinsights.projects.locations.qaScorecards.list", "parameterOrder": [ "parent" ], "description": "Lists QaScorecards.", "path": "v1/{+parent}/qaScorecards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse" }, "parameters": { "qaScorecardSources": { "repeated": true, "location": "query", "type": "string", "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.", "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." ], "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ] }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the scorecards." }, "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "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." } }, "httpMethod": "GET" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "description": "Updates a QaScorecard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "location": "path", "required": true, "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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`" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard" }, "httpMethod": "PATCH", "path": "v1/{+name}" } }, "resources": { "revisions": { "resources": { "qaQuestions": { "methods": { "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse" }, "path": "v1/{+parent}/qaQuestions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the questions.", "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" }, "pageSize": { "type": "integer", "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.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QaQuestions.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions" }, "create": { "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "description": "Create a QaQuestion.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "path": "v1/{+parent}/qaQuestions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" }, "httpMethod": "POST", "parameters": { "qaQuestionId": { "location": "query", "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-`.", "type": "string" }, "parent": { "description": "Required. The parent resource of the QaQuestion.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "type": "string" } } }, "delete": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "description": "Deletes a QaQuestion.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the QaQuestion to delete." } } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the QaQuestion to get.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$" } }, "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" } }, "patch": { "parameters": { "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "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`" }, "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}", "type": "string", "location": "path", "required": true } }, "description": "Updates a QaQuestion.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" }, "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestion" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch" } } } }, "methods": { "tuneQaScorecardRevision": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource for new fine tuning job instance." } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "description": "Fine tune one or more QaModels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+parent}:tuneQaScorecardRevision", "parameterOrder": [ "parent" ] }, "create": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create", "description": "Creates a QaScorecardRevision.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "path": "v1/{+parent}/revisions", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the QaScorecardRevision.", "type": "string" }, "qaScorecardRevisionId": { "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-`.", "location": "query", "type": "string" } } }, "deploy": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest" }, "description": "Deploy a QaScorecardRevision.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "path": "v1/{+name}:deploy", "parameters": { "name": { "description": "Required. The name of the QaScorecardRevision to deploy.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string" } }, "httpMethod": "POST" }, "delete": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "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." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to delete.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QaScorecardRevision.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "description": "Lists all revisions under the parent QaScorecard.", "path": "v1/{+parent}/revisions", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "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.", "location": "query", "type": "string" }, "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, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE", "QA_SCORECARD_SOURCE_INTENT_TAXONOMY" ], "type": "string", "location": "query", "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." }, "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", "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/[^/]+$", "location": "path", "required": true }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "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." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse" } }, "get": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to get.", "location": "path", "required": true } }, "httpMethod": "GET", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "description": "Gets a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "undeploy": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardRevision" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest" }, "path": "v1/{+name}:undeploy", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to undeploy.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Undeploy a QaScorecardRevision.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy" } } } } }, "assessmentRules": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/assessmentRules", "description": "Creates an assessment rule.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "id": "contactcenterinsights.projects.locations.assessmentRules.create", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`" }, "assessmentRuleId": { "type": "string", "location": "query", "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])?$`." } } }, "delete": { "description": "Deletes an assessment rule.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the assessment rule to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.assessmentRules.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Get an assessment rule.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the assessment rule to get." } }, "id": "contactcenterinsights.projects.locations.assessmentRules.get" }, "list": { "path": "v1/{+parent}/assessmentRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse" }, "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "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." }, "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": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the assessment rules.", "type": "string" } }, "description": "Lists assessment rules.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.assessmentRules.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assessmentRules" }, "patch": { "description": "Updates an assessment rule.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "parameters": { "updateMask": { "type": "string", "location": "query", "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" }, "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "type": "string", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}" } }, "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1AssessmentRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ] } } }, "views": { "methods": { "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "id": "contactcenterinsights.projects.locations.views.create", "path": "v1/{+parent}/views", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "description": "Creates a view.", "parameters": { "parent": { "description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views" }, "delete": { "description": "Deletes a view.", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}", "id": "contactcenterinsights.projects.locations.views.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "description": "Required. The name of the view to delete." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameterOrder": [ "name" ] }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "description": "Updates a view.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "id": "contactcenterinsights.projects.locations.views.patch", "path": "v1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "location": "path", "required": true, "type": "string", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$" } } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists views.", "parameters": { "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" }, "pageSize": { "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.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the views.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.views.list", "path": "v1/{+parent}/views", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListViewsResponse" } }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1View" }, "id": "contactcenterinsights.projects.locations.views.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "path": "v1/{+name}", "description": "Gets a view.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the view to get." } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "dashboards": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "description": "Updates a Dashboard.", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.dashboards.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}" }, "updateMask": { "format": "google-fieldmask", "location": "query", "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" } } }, "list": { "description": "Lists Dashboards.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListDashboardsResponse" }, "parameters": { "orderBy": { "description": "Optional. The order by expression to order dashboards listed in the response.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filter expression to filter dashboards listed in the response." }, "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" }, "parent": { "description": "Required. The parent resource of the dashboards.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.dashboards.list", "path": "v1/{+parent}/dashboards" }, "get": { "id": "contactcenterinsights.projects.locations.dashboards.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "description": "Required. The name of the dashboard to get." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Gets a Dashboard." }, "create": { "id": "contactcenterinsights.projects.locations.dashboards.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dashboards", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1Dashboard" }, "httpMethod": "POST", "parameters": { "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])?$`.", "location": "query", "type": "string" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the dashboard." } }, "description": "Creates a Dashboard." }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "description": "Deletes a Dashboard.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.dashboards.delete", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Required. The name of the dashboard to delete." } }, "response": { "$ref": "GoogleProtobufEmpty" } } }, "resources": { "charts": { "methods": { "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/charts", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the chart.", "type": "string" }, "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])?$`." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "id": "contactcenterinsights.projects.locations.dashboards.charts.create", "httpMethod": "POST", "description": "Creates a Chart." }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes a Chart.", "id": "contactcenterinsights.projects.locations.dashboards.charts.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "type": "string", "description": "Required. The name of the chart to delete." } }, "path": "v1/{+name}" }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource of the charts.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string" } }, "description": "Lists Charts.", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/charts", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListChartsResponse" }, "id": "contactcenterinsights.projects.locations.dashboards.charts.list" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "description": "Updates a Chart.", "path": "v1/{+name}", "parameters": { "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "location": "path", "required": true }, "updateMask": { "type": "string", "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`" } }, "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" } }, "get": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "description": "Required. The name of the chart to get." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1Chart" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "parameterOrder": [ "name" ], "description": "Gets a Chart.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}" } } } } }, "encryptionSpec": { "methods": { "initialize": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "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": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "path": "v1/{+name}:initialize", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize" } } }, "datasets": { "methods": { "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "description": "Gets a dataset.", "id": "contactcenterinsights.projects.locations.datasets.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The name of the dataset to get.", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}" }, "bulkDeleteFeedbackLabels": { "description": "Delete feedback labels in bulk using a filter.", "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:bulkDeleteFeedbackLabels", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "required": true } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" } }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "location": "path", "required": true, "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. The list of fields to update." } }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "description": "Updates a dataset.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "id": "contactcenterinsights.projects.locations.datasets.patch" }, "listAllFeedbackLabels": { "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", "description": "List all feedback labels by project number.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:listAllFeedbackLabels", "parameters": { "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": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource of all feedback labels per project.", "location": "path", "required": true, "type": "string" }, "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" }, "pageToken": { "location": "query", "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" }, "httpMethod": "GET" }, "bulkUploadFeedbackLabels": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", "parameterOrder": [ "parent" ], "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" }, "httpMethod": "POST", "path": "v1/{+parent}:bulkUploadFeedbackLabels", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource for new feedback labels.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels" }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" } }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListDatasetsResponse" }, "parameterOrder": [ "parent" ], "description": "List datasets matching the input.", "path": "v1/{+parent}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset.", "type": "string", "location": "path", "required": true }, "pageToken": { "location": "query", "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." }, "pageSize": { "type": "integer", "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.", "location": "query", "format": "int32" }, "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`" } }, "id": "contactcenterinsights.projects.locations.datasets.list" }, "create": { "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset." }, "datasetId": { "description": "Optional. The ID to use for the dataset.", "type": "string", "location": "query" } }, "description": "Creates a dataset.", "id": "contactcenterinsights.projects.locations.datasets.create", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "path": "v1/{+parent}/datasets" }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the dataset to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete a dataset.", "id": "contactcenterinsights.projects.locations.datasets.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "path": "v1/{+name}" } }, "resources": { "insightsdata": { "methods": { "export": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "description": "Export insights data to a destination defined in the request body.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource to export data from.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "path": "v1/{+parent}/insightsdata:export" } } }, "conversations": { "resources": { "feedbackLabels": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "path": "v1/{+parent}/feedbackLabels", "description": "Create feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the feedback label.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" }, "feedbackLabelId": { "location": "query", "type": "string", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." } } }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the feedback label to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", "description": "List feedback labels.", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/feedbackLabels", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "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.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "type": "string" }, "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" }, "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.", "type": "integer", "location": "query", "format": "int32" } } }, "get": { "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the feedback label to get." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Get feedback label.", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get" }, "patch": { "httpMethod": "PATCH", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Required. The list of fields to be updated.", "type": "string" } }, "description": "Update feedback label.", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "parameterOrder": [ "name" ] } } } }, "methods": { "generateSignedAudio": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "parameterOrder": [ "name" ], "path": "v1/{+name}:generateSignedAudio", "description": "Gets the signed URI for the audio for the given conversation.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the conversation to sign.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string" } }, "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "parameters": { "name": { "type": "string", "description": "Required. The name of the conversation to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path", "required": true }, "force": { "location": "query", "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" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Deletes a conversation.", "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "path": "v1/{+name}" }, "sample": { "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the dataset.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+parent}/conversations:sample", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample", "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.sample" }, "get": { "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "description": "Gets a conversation.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "parameters": { "name": { "description": "Required. The name of the conversation to get.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true }, "view": { "description": "The level of details of the conversation. Default is `FULL`.", "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", "location": "query", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ] } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkDelete": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "path": "v1/{+parent}/conversations:bulkDelete", "parameterOrder": [ "parent" ], "description": "Deletes multiple conversations in a single request.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete" }, "ingest": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. The parent resource for new conversations.", "location": "path", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/conversations:ingest", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", "description": "Imports conversations and processes them according to the user's configuration." }, "list": { "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "description": "Lists conversations.", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", "path": "v1/{+parent}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" }, "parameters": { "view": { "type": "string", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC", "FULL_WITH_STRUCTURED_TRANSCRIPT" ], "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." ], "description": "The level of details of the conversation. Default is `BASIC`." }, "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the conversation." }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "location": "query" }, "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" }, "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" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "calculateStats": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "description": "Gets conversation statistics.", "parameters": { "location": { "location": "path", "required": true, "description": "Required. The location of the conversations.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "httpMethod": "POST", "path": "v1/{+location}/conversations:calculateStats", "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" } } } } } }, "qaQuestionTags": { "methods": { "get": { "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.get", "parameters": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets a QaQuestionTag.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}" }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a QaQuestionTag.", "path": "v1/{+parent}/qaQuestionTags", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestionTag.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "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-`.", "type": "string", "location": "query" } }, "httpMethod": "POST" }, "delete": { "description": "Deletes a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the QaQuestionTag to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "list": { "description": "Lists the question tags.", "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "path": "v1/{+parent}/qaQuestionTags", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse" }, "httpMethod": "GET", "parameters": { "filter": { "type": "string", "location": "query", "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`" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the QaQuestionTags.", "location": "path", "required": true } }, "parameterOrder": [ "parent" ] }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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" }, "name": { "location": "path", "required": true, "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.", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "description": "Updates a QaQuestionTag." } } }, "insightsdata": { "methods": { "export": { "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource to export data from.", "type": "string" } }, "description": "Export insights data to a destination defined in the request body.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.insightsdata.export", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "path": "v1/{+parent}/insightsdata:export", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ] } } }, "issueModels": { "resources": { "issues": { "methods": { "create": { "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1Issue" }, "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the issue.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+parent}/issues", "description": "Creates an issue." }, "delete": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "id": "contactcenterinsights.projects.locations.issueModels.issues.delete", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The name of the issue to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$" } }, "httpMethod": "DELETE", "description": "Deletes an issue.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "path": "v1/{+name}", "description": "Updates an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1Issue" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string" }, "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 } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Issue" } }, "list": { "id": "contactcenterinsights.projects.locations.issueModels.issues.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListIssuesResponse" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The parent resource of the issue.", "location": "path", "required": true } }, "httpMethod": "GET", "path": "v1/{+parent}/issues", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "description": "Lists issues." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1Issue" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "description": "Required. The name of the issue to get.", "location": "path", "required": true, "type": "string" } }, "description": "Gets an issue.", "path": "v1/{+name}", "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "parameterOrder": [ "name" ] } } } }, "methods": { "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource of the issue model.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.issueModels.create", "description": "Creates an issue model.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", "path": "v1/{+parent}/issueModels" }, "delete": { "id": "contactcenterinsights.projects.locations.issueModels.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "description": "Deletes an issue model.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The name of the issue model to delete." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+name}", "parameterOrder": [ "name" ] }, "list": { "id": "contactcenterinsights.projects.locations.issueModels.list", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists issue models.", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/issueModels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListIssueModelsResponse" } }, "export": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "id": "contactcenterinsights.projects.locations.issueModels.export", "path": "v1/{+name}:export", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The issue model to export.", "type": "string", "location": "path", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Exports an issue model to the provided destination.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "deploy": { "path": "v1/{+name}:deploy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" }, "id": "contactcenterinsights.projects.locations.issueModels.deploy", "parameterOrder": [ "name" ], "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.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Required. The issue model to deploy.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "required": true } } }, "undeploy": { "path": "v1/{+name}:undeploy", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "required": true, "description": "Required. The issue model to undeploy." } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "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" ], "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy" }, "import": { "description": "Imports an issue model from a Cloud Storage bucket.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels:import", "request": { "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/issueModels:import", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource of the issue model." } }, "id": "contactcenterinsights.projects.locations.issueModels.import", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the issue model to get.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.issueModels.get", "description": "Gets an issue model.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" }, "path": "v1/{+name}" }, "patch": { "id": "contactcenterinsights.projects.locations.issueModels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" }, "httpMethod": "PATCH", "description": "Updates an issue model.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "updateMask": { "type": "string", "description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ] }, "calculateIssueModelStats": { "path": "v1/{+issueModel}:calculateIssueModelStats", "description": "Gets an issue model's statistics.", "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse" }, "parameters": { "issueModel": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "description": "Required. The resource name of the issue model to query against." } }, "httpMethod": "GET", "parameterOrder": [ "issueModel" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "bulkDeleteFeedbackLabels": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" }, "httpMethod": "POST", "path": "v1/{+parent}:bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "description": "Delete feedback labels in bulk using a filter.", "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels" }, "testCorrelationConfig": { "path": "v1/{+location}:testCorrelationConfig", "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigRequest" }, "parameterOrder": [ "location" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig", "parameters": { "location": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}", "type": "string" } }, "httpMethod": "POST", "description": "Tests correlation config on a conversation.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "queryPerformanceOverview": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview", "path": "v1/{+parent}:queryPerformanceOverview", "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.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST" }, "getCorrelationConfig": { "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig" } }, "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationConfig" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Gets correlation config." }, "bulkUploadFeedbackLabels": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" }, "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+parent}:bulkUploadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource for new feedback labels.", "location": "path", "required": true } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels" }, "generativeInsights": { "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "location" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generativeInsights", "path": "v1/{+location}:generativeInsights", "parameters": { "location": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.generativeInsights", "request": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsRequest" } }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "parameterOrder": [ "parent" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "path": "v1/{+parent}:bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "updateSettings": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "location": "path", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Required. The list of fields to be updated." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", "request": { "$ref": "GoogleCloudContactcenterinsightsV1Settings" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Updates project-level settings.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Settings" }, "id": "contactcenterinsights.projects.locations.updateSettings" }, "queryMetrics": { "id": "contactcenterinsights.projects.locations.queryMetrics", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "description": "Query metrics.", "path": "v1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "location" ], "parameters": { "location": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" } }, "listAllFeedbackLabels": { "description": "List all feedback labels by project number.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" }, "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "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" }, "pageToken": { "type": "string", "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.", "location": "query" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of all feedback labels per project." }, "pageSize": { "location": "query", "format": "int32", "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." } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "path": "v1/{+parent}:listAllFeedbackLabels" }, "getSettings": { "description": "Gets project-level settings.", "id": "contactcenterinsights.projects.locations.getSettings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1Settings" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the settings resource to get.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/settings$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "updateCorrelationConfig": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationConfig" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. The list of fields to be updated.", "format": "google-fieldmask" }, "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "path": "v1/{+name}", "description": "Updates correlation config.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1CorrelationConfig" } }, "getEncryptionSpec": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "description": "Gets location-level encryption key specification.", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the encryption spec resource to get." } } } } } } } }, "description": "", "fullyEncodeReservedExpansion": true, "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." } } } }, "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "ownerName": "Google", "batchPath": "batch" }