{ "name": "contactcenterinsights", "version_module": true, "kind": "discovery#restDescription", "baseUrl": "https://contactcenterinsights.googleapis.com/", "title": "Contact Center AI Insights API", "protocol": "rest", "parameters": { "callback": { "type": "string", "location": "query", "description": "JSONP" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "description": "Data format for response.", "location": "query", "type": "string", "default": "json", "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" ] }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "quotaUser": { "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.", "location": "query", "type": "string" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "description": "V1 error format.", "location": "query", "type": "string" } }, "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." } } } }, "discoveryVersion": "v1", "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "rootUrl": "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" }, "revision": "20260629", "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "schemas": { "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "description": "Dialogflow interaction data.", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "properties": { "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`.", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "type": "string", "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ] }, "transcriptBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`." }, "audioBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`." }, "bucketUri": { "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`." }, "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`." }, "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." } } }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "description": "The request to initialize a location-level encryption specification.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1Dataset": { "id": "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)", "properties": { "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "description": { "type": "string", "description": "Dataset description." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dataset update time." }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "description": "Dataset usage type.", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ] }, "createTime": { "description": "Output only. Dataset create time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Display name for the dataaset" }, "ttl": { "type": "string", "format": "google-duration", "description": "Optional. Option TTL for the dataset." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "type": "object", "properties": { "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "sampledConversations": { "readOnly": true, "type": "array", "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "items": { "type": "string" } }, "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." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata", "description": "The metadata for an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "description": "Metadata about conversation labels.", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "type": "string", "description": "Optional. The label value." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "properties": { "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "type": "number", "format": "double", "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": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse": { "type": "object", "properties": { "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" }, "dashboards": { "description": "The dashboards under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse", "description": "The response of listing dashboards." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "description": "The request to deploy an issue model.", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "type": "object" }, "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.", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "type": "string", "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ] }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", "description": "The metadata for querying performance overview.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueId": { "description": "The issue ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata", "description": "Metadata used for import issue model." }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "description": "The request to sample conversations to a dataset." }, "GoogleLongrunningListOperationsResponse": { "properties": { "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" }, "type": "array" } }, "type": "object", "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "description": "Aggregated statistics about an issue model.", "properties": { "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string", "format": "int64" }, "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "type": "object", "description": "Statistics on each issue. Key is the issue's resource name." }, "analyzedConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SentimentData": { "type": "object", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number", "format": "float" }, "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." } }, "id": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "The data for a sentiment annotation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { "type": "object", "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." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule." }, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "type": "object", "properties": { "type": { "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`." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ] }, "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": { "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." }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } } }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "properties": { "conversationModel": { "type": "string", "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "answerRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "textSections": { "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "additionalProperties": { "type": "string" }, "type": "object" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "description": "Tags and their corresponding results.", "type": "object", "properties": { "score": { "type": "number", "format": "double", "description": "The score the tag applies to." }, "potentialScore": { "type": "number", "format": "double", "description": "The potential score the tag applies to." }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score the tag applies to." }, "tag": { "description": "The tag the score applies to.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "properties": { "smartReplyAllowlistCovered": { "type": "boolean", "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "Metadata from Dialogflow relating to the current transcript segment." }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "type": "object", "properties": { "suggestion": { "type": "string", "description": "The content of the suggestion." }, "confidenceScore": { "type": "number", "format": "double", "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": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition": { "id": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition", "description": "A definition for a metric to be calculated during analysis.", "type": "object", "properties": { "displayName": { "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "readOnly": true, "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "type": "object", "properties": { "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "The feedback labels that match the request.", "type": "array" }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", "description": "The response for listing feedback labels." }, "GoogleCloudContactcenterinsightsV1mainIssue": { "id": "GoogleCloudContactcenterinsightsV1mainIssue", "description": "The issue resource.", "type": "object", "properties": { "displayName": { "description": "The representative name for the issue.", "type": "string" }, "updateTime": { "description": "Output only. The most recent time that this issue was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayDescription": { "type": "string", "description": "Representative description of the issue." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this issue was created." }, "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "sampleUtterances": { "readOnly": true, "type": "array", "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "properties": { "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true, "type": "integer", "format": "int32" }, "failedIngestCount": { "readOnly": true, "type": "integer", "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." }, "duplicatesSkippedCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested." }, "successfulIngestCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of new conversations added during this ingest operation." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse": { "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" }, "qaQuestionTags": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "description": "The parent resource of the questions.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse", "description": "The response from a ListQaQuestionTags request." }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "properties": { "annotatorSelector": { "readOnly": true, "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "properties": { "audioUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation audio." }, "dialogflowConversation": { "readOnly": true, "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}" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "description": "A Dialogflow source of conversation data." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "type": "object", "properties": { "dimensions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimension" }, "description": "A unique combination of dimensions that this slice represents.", "type": "array" }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse", "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "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": "GoogleCloudContactcenterinsightsV1alpha1GcsSource" }, "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" }, "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": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse", "description": "Response from import issue model" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag." }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "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." }, "description": { "type": "string", "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "type": "object", "properties": { "samplePercentage": { "type": "number", "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100]." }, "sampleRow": { "type": "string", "format": "int64", "description": "Number of the conversations that we should sample based on the dimension." }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "description": "Message for sampling conversations." }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", "type": "object", "properties": { "sourceType": { "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." ], "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ] }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension.", "type": "object", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "type": "object", "properties": { "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "sampleSize": { "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", "format": "int32" }, "parent": { "type": "string", "description": "Required. The parent resource for new conversations." }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "description": "The request to ingest conversations." }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "type": "object", "properties": { "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" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "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": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "description": "Agent Assist frequently-asked-question answer data." }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource", "description": "A Dialogflow source of conversation data.", "type": "object", "properties": { "dialogflowConversation": { "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "readOnly": true, "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource": { "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": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource", "description": "Google Sheets document details to get the feedback label file from." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "type": "object", "properties": { "processedObjectCount": { "type": "integer", "format": "int32", "description": "The number of objects processed during the download operation." }, "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." }, "totalFilesWritten": { "type": "integer", "format": "int32", "description": "Total number of files written to the provided Cloud Storage bucket." }, "fileNames": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Full name of the files written to Cloud storage." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Statistics for BulkDownloadFeedbackLabels operation." }, "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issueModel": { "type": "string", "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "issues": { "description": "All the matched issues.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards.", "type": "object", "properties": { "qaScorecardRevisions": { "type": "array", "description": "List of QaScorecardRevisions.", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition": { "type": "object", "properties": { "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." }, "value": { "description": "CEL expression to be evaluated as the value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition", "description": "Condition for auto-labeling conversations." }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "description": "Default summarization model to be used.", "type": "string", "enumDeprecated": [ false, true, true ], "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" ] }, "generator": { "type": "string", "description": "The resource name of the existing created generator. Format: projects//locations//generators/" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization." }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "properties": { "requestTime": { "description": "Output only. The time at which the analysis was requested.", "readOnly": true, "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" }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisResult": { "readOnly": true, "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult" }, "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "description": "The analysis resource." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo", "description": "Information about an agent involved in the conversation.", "type": "object", "properties": { "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "agentType": { "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." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "teams": { "type": "array", "items": { "type": "string" }, "description": "User-specified strings representing the agent's teams." }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "versionId": { "type": "string", "description": "The agent's version ID. Only applicable to automated agents." }, "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": { "description": "The entry subagent's display name.", "type": "string" }, "deploymentId": { "type": "string", "description": "The agent's deployment ID. Only applicable to automated agents." }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "displayName": { "type": "string", "description": "The agent's name." }, "dispositionCode": { "type": "string", "description": "A user-provided string indicating the outcome of the agent's segment of the call." } } }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object", "properties": { "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "title": { "description": "Article title.", "type": "string" }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" }, "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)." } } }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata", "description": "Conversation metadata related to quality management.", "properties": { "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer", "format": "int32" }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "type": "array" }, "waitDuration": { "type": "string", "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent." }, "menuPath": { "type": "string", "description": "An arbitrary string value specifying the menu path the customer took." }, "agentInfo": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations", "description": "Wrapper for a list of conversations.", "type": "object", "properties": { "conversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Optional. The conversations.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "description": "The request to delete an issue model." }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "type": "object", "properties": { "reply": { "type": "string", "description": "The content of the reply." }, "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).", "type": "number", "format": "double" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "description": "Agent Assist Smart Reply data." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "type": "object", "properties": { "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "turnLevelAudios": { "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": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "type": "array" }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "type": "object", "properties": { "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" }, "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output.", "type": "object", "properties": { "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "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." ] } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "properties": { "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" }, "tag": { "type": "string", "description": "Tag name." } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "type": "string", "description": "The dataset used for sampling conversations." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "description": "Conversation-level silence data.", "type": "object", "properties": { "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "type": "number", "format": "float" }, "silenceDuration": { "type": "string", "format": "google-duration", "description": "Amount of time calculated to be in silence." } } }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "type": "object", "properties": { "medium": { "type": "string", "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT." } }, "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "description": "The request to create an issue.", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "properties": { "medium": { "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for processing transcript objects." }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "properties": { "issueModelId": { "type": "string", "description": "The parent issue model ID." }, "issueId": { "type": "string", "description": "The issue ID." }, "issueDisplayName": { "description": "The issue display name.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "type": "object", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "potentialScore": { "description": "The potential score the tag applies to.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", "description": "Tags and their corresponding results." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "properties": { "sourceType": { "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", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ] }, "qaTagResults": { "type": "array", "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score." }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result." }, "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" } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "ruleConstraintResults": { "type": "array", "description": "The results for each applicable constraint rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" } }, "conversationB": { "type": "string", "description": "The second conversation resource name." }, "conversationA": { "type": "string", "description": "The first conversation resource name." } } }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData", "description": "The data for a silence annotation." }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView": { "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView", "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.", "properties": { "name": { "type": "string", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}" }, "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" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the authorized view was created." }, "updateTime": { "description": "Output only. The most recent time at which the authorized view was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "type": "object", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversation": { "id": "GoogleCloudContactcenterinsightsV1mainConversation", "description": "The conversation resource.", "properties": { "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource" }, "languageCode": { "type": "string", "description": "A user-specified language code for the conversation." }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time at which the conversation started." }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "createTime": { "description": "Output only. The time at which the conversation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "medium": { "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "type": "integer", "format": "int32" }, "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." }, "labels": { "type": "object", "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." }, "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" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated." }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis", "readOnly": true }, "duration": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The duration of the conversation." }, "transcript": { "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "readOnly": true }, "runtimeAnnotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true, "type": "array" }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string", "format": "google-duration" }, "dialogflowIntents": { "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "readOnly": true }, "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 download.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1Analysis": { "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisResult": { "readOnly": true, "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult" }, "requestTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the analysis was requested." }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" } }, "id": "GoogleCloudContactcenterinsightsV1Analysis", "description": "The analysis resource." }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "description": "Request to upload a conversation.", "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" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag.", "type": "object", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "type": "number", "format": "double", "description": "Average tag normalized score per tag." } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "properties": { "customerChannel": { "type": "integer", "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." }, "agentChannel": { "type": "integer", "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { "type": "object", "properties": { "conversationDataOptions": { "description": "Options for configuring the conversation data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions", "description": "Options for configuring the data used to generate the QA question." }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "properties": { "playbookDisplayName": { "type": "string", "description": "Optional. The dialogflow playbook display name." }, "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Metadata about the Conversational Agents playbook dimension." }, "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse", "description": "The response of listing phrase matchers.", "type": "object", "properties": { "phraseMatchers": { "description": "The phrase matchers that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics", "description": "Request data that use the existing QueryMetrics.", "type": "object", "properties": { "request": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "description": "Selector of all available annotators and phrase matchers to run.", "properties": { "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" }, "runSummarizationAnnotator": { "type": "boolean", "description": "Whether to run the summarization annotator." }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "type": "boolean", "description": "Whether to run the active phrase matcher annotator(s)." }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "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" }, "runQaAnnotator": { "type": "boolean", "description": "Whether to run the QA annotator." }, "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.", "items": { "type": "string" }, "type": "array" }, "runEntityAnnotator": { "type": "boolean", "description": "Whether to run the entity annotator." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "properties": { "conversationProfileId": { "type": "string", "description": "Optional. The conversation profile ID." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "properties": { "joinKeyResults": { "type": "array", "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination": { "properties": { "format": { "description": "Required. File format in which the labels will be exported.", "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", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata", "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig", "description": "Regex match configuration.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", "description": "Metadata used for import issue model.", "type": "object", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension.", "type": "object", "properties": { "agentVersionDisplayName": { "type": "string", "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "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." }, "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" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "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" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult", "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": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "type": "string", "description": "The rule ID." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "type": "object", "properties": { "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "text": { "type": "string", "description": "The summarization content that is concatenated into one string." }, "textSections": { "type": "object", "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." }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that contains metadata about the summarization and the document from which it originates." }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidence": { "type": "number", "format": "float", "description": "The confidence score of the summarization." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "properties": { "sentimentCategory": { "type": "string", "description": "Optional. The client sentiment category." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse": { "properties": { "issues": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "description": "The issues that match the request." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse", "description": "The response of listing issues." }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", "description": "Configuration for the QA feature.", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "description": "The request to export insights.", "type": "object", "properties": { "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties." }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" }, "exportSchemaVersion": { "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." ], "type": "string", "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": { "type": "string", "description": "Required. The parent resource to export data from." }, "writeDisposition": { "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." ], "type": "string", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse", "description": "The response from a ListQaScorecards request.", "type": "object", "properties": { "qaScorecards": { "description": "The QaScorecards under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "type": "object", "properties": { "audioUri": { "type": "string", "description": "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." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "description": "A Cloud Storage source of conversation data." }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "properties": { "type": { "type": "string", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "description": "The type of the entity mention.", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ] }, "entityUniqueId": { "type": "string", "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to." }, "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization.", "type": "object", "properties": { "conversationProfile": { "type": "string", "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" }, "summarizationModel": { "type": "string", "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "enumDeprecated": [ false, true, true ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "description": "Metadata for an export insights operation.", "type": "object", "properties": { "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array" }, "completedExportCount": { "description": "The number of conversations that were exported successfully.", "type": "integer", "format": "int32" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1SpeechConfig": { "id": "GoogleCloudContactcenterinsightsV1SpeechConfig", "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "properties": { "speechRecognizer": { "type": "string", "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`" }, "disableWordTimeOffsets": { "type": "boolean", "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "type": "object", "properties": { "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" }, "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { "type": "object", "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "properties": { "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" }, "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RedirectAction": { "type": "object", "properties": { "relativePath": { "type": "string", "description": "The relative path to redirect to." }, "queryParams": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The query params to be added to the redirect path." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction", "description": "The redirect action to be taken when the chart is clicked." }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse": { "properties": { "analyses": { "description": "The analyses that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "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": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse", "description": "The response to list analyses." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", "description": "Metadata for deploying an issue model.", "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The data for a sentiment annotation.", "type": "object", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number", "format": "float" }, "score": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number", "format": "float" } } }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "type": "object", "properties": { "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence" }, "intents": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" }, "description": "All the matched intents in the call." }, "phraseMatchers": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "description": "All the matched phrase matchers in the call." }, "qaScorecardResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" }, "description": "Results of scoring QaScorecards.", "type": "array" }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" }, "type": "array" }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" }, "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "annotations": { "type": "array", "description": "A list of call annotations that apply to this call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" } } }, "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest": { "properties": { "dimensions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "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" }, "filter": { "type": "string", "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)). " }, "timeGranularity": { "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "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": "string", "enum": [ "TIME_GRANULARITY_UNSPECIFIED", "NONE", "DAILY", "HOURLY", "PER_MINUTE", "PER_5_MINUTES", "MONTHLY" ] }, "measureMask": { "description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\".", "type": "string", "format": "google-fieldmask" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest", "description": "The request for querying metrics." }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "type": "object", "properties": { "correctnessLevel": { "type": "string", "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ] }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "description": "The feedback that the customer has about a certain answer in the conversation." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse", "description": "Response for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "type": "object", "properties": { "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "location": { "type": "string", "description": "The agent's location." }, "team": { "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "type": "string" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "deploymentDisplayName": { "type": "string", "description": "The agent's deployment display name. Only applicable to automated agents." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "User-specified strings representing the agent's teams." }, "agentType": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "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." ] }, "versionDisplayName": { "type": "string", "description": "The agent's version display name. Only applicable to automated agents." }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "agentId": { "type": "string", "description": "A user-specified string representing the agent." }, "displayName": { "description": "The agent's name.", "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" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "type": "object", "properties": { "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" }, "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "description": "The CES diagnostic information." }, "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata", "description": "The metadata from querying metrics.", "type": "object", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "properties": { "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "endOffset": { "type": "string", "format": "google-duration", "description": "Time offset of the end 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." }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript." }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig": { "properties": { "absoluteDateRange": { "description": "An absolute date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "relativeDateRange": { "description": "A relative date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range configuration for dashboard charts." }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { "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}`" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update time of the label." }, "createTime": { "description": "Output only. Create time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" }, "label": { "type": "string", "description": "String label used for Topic Modeling." }, "name": { "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards.", "properties": { "qaScorecardRevisions": { "items": { "type": "string" }, "description": "List of QaScorecardRevisions.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" }, "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" }, "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval." }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "partialErrors": { "type": "array", "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "properties": { "createTime": { "description": "Output only. The create time of the conversation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The update time of the conversation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "messages": { "type": "array", "description": "Ordered list of messages, including user inputs and system responses.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "properties": { "medium": { "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for processing transcript objects." }, "GoogleCloudCesV1mainMessage": { "type": "object", "properties": { "role": { "type": "string", "description": "Optional. The role within the conversation, e.g., user, agent." }, "chunks": { "description": "Optional. Content of the message as a series of chunks.", "items": { "$ref": "GoogleCloudCesV1mainChunk" }, "type": "array" }, "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." } }, "id": "GoogleCloudCesV1mainMessage", "description": "A message within a conversation." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", "description": "Response from export issue model", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "description": "A wrapper for holding the audio for any given turn.", "type": "object", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag" }, "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string", "format": "google-fieldmask" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension.", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}." }, "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." }, "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)." }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "question": { "type": "string", "description": "The corresponding FAQ question." } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "type": "object", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse", "description": "The response of testing correlation config." }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment", "description": "Information about the issue.", "properties": { "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "displayName": { "type": "string", "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then." }, "score": { "type": "number", "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "properties": { "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "The feedback labels that match the request." }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", "description": "The response for listing feedback labels." }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension.", "properties": { "questionBody": { "type": "string", "description": "Optional. The full body of the question." }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "type": "object", "properties": { "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata", "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" }, "partialErrors": { "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true, "type": "array" }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "readOnly": true }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource", "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", "type": "object", "properties": { "sourceType": { "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", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ] }, "qaTagResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores." }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score." }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result." }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "Metadata from Dialogflow relating to the current transcript segment." }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "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}`" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update time of the label." }, "createTime": { "description": "Output only. Create time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" }, "label": { "type": "string", "description": "String label used for Topic Modeling." }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" } }, "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." }, "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1mainConversationParticipant", "description": "The call participant speaking for a given utterance.", "type": "object", "properties": { "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "role": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The role of the participant.", "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." ] }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", "description": "The metadata from querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "properties": { "sampledConversationsCount": { "description": "The number of conversations sampled.", "type": "integer", "format": "int32" }, "partialErrors": { "type": "array", "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "correlatedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations correlated." }, "failedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed correlation." }, "conversationCorrelationErrors": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse": { "type": "object", "properties": { "notes": { "description": "The notes that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse", "description": "The response of listing notes." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "description": "The request to sample conversations to a dataset.", "type": "object", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1mainDataset" }, "parent": { "type": "string", "description": "Required. The parent resource of the dataset." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation": { "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "The update time of the conversation." }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" }, "description": "Ordered list of messages, including user inputs and system responses." }, "createTime": { "type": "string", "format": "google-datetime", "description": "The create time of the conversation." }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation", "description": "The conversation used to generate the chart." }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse", "description": "The response of listing assessment rules.", "properties": { "assessmentRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "The assessment rules that match the request.", "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" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse", "description": "Response from export issue model", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension.", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainEntity": { "id": "GoogleCloudContactcenterinsightsV1mainEntity", "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "type": "object", "properties": { "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" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "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`." ] }, "salience": { "type": "number", "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient." }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "displayName": { "type": "string", "description": "The representative name for the entity." } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "description": "The data for an issue match annotation.", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "id": "GoogleCloudContactcenterinsightsV1InterruptionData", "description": "The data for an interruption annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "id": "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": { "type": "string", "format": "int64", "description": "Number of conversations attached to the issue at this point in time." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent", "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" } }, "type": "object" }, "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.", "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse", "description": "Response from export issue model", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata", "description": "Metadata about conversation labels.", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "type": "string", "description": "Optional. The label value." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { "type": "object", "properties": { "accuracy": { "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "readOnly": true, "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics", "description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "description": "Info for correlating across conversations.", "type": "object", "properties": { "correlationTypes": { "readOnly": true, "type": "array", "items": { "type": "string", "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ] }, "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": { "readOnly": true, "type": "string", "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.", "readOnly": true, "type": "string" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "properties": { "type": { "description": "The type of the entity mention.", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "type": "string", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ] }, "entityUniqueId": { "type": "string", "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to." }, "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse", "description": "The response of testing correlation config." }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange": { "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange", "description": "Relative date range configuration.", "type": "object", "properties": { "quantity": { "type": "string", "format": "int64", "description": "Required. The quantity of units in the past." }, "unit": { "description": "Required. The unit of time.", "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "type": "string", "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "properties": { "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" }, "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata", "description": "Metadata for creating an issue.", "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule": { "properties": { "displayName": { "description": "Display Name of the assessment rule.", "type": "string" }, "active": { "type": "boolean", "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive." }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "createTime": { "description": "Output only. The time at which this assessment rule was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which this assessment rule was updated." }, "name": { "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "type": "string" }, "sampleRule": { "description": "The sample rule for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule", "description": "The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "properties": { "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "description": "Output only. The create time of the conversation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The update time of the conversation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "messages": { "type": "array", "description": "Ordered list of messages, including user inputs and system responses.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig", "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined.", "properties": { "type": { "type": "string", "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" ], "description": "The type of the predefined question.", "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." ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "properties": { "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" }, "score": { "type": "number", "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "description": "Information about the issue." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "type": "object", "properties": { "qaScorecardRevisions": { "items": { "type": "string" }, "description": "List of QaScorecardRevisions.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards." }, "GoogleRpcStatus": { "properties": { "message": { "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "type": "object", "id": "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)." }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "properties": { "completedExportCount": { "description": "The number of conversations that were exported successfully.", "type": "integer", "format": "int32" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during export operation that might cause the operation output to be incomplete." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "description": "Metadata for an export insights operation." }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "type": "object", "properties": { "parent": { "type": "string", "description": "Required. The parent resource to create analyses in." }, "relabel": { "type": "boolean", "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations." }, "filter": { "type": "string", "description": "Required. Filter used to select the subset of conversations to analyze." }, "analysisPercentage": { "type": "number", "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "description": "The request to analyze conversations in bulk." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "properties": { "questionBody": { "type": "string", "description": "Optional. The full body of the question." }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "type": "string", "description": "Optional. The QA question ID." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig": { "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig", "description": "Exact match configuration." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object", "properties": { "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } } }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension.", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest", "description": "The request message for testing auto labeling rules.", "type": "object", "properties": { "conversation": { "description": "Required. Conversation data to test rules against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } } }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1CallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1SilenceData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1HoldData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" }, "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." }, "request": { "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "readOnly": true }, "sampledConversations": { "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "description": "The metadata for an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1Chart": { "properties": { "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Chart create time." }, "action": { "description": "Optional action to be taken when the chart is clicked.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartAction" }, "chartVisualizationType": { "description": "Chart visualization type.", "enumDescriptions": [ "Unspecified chart visualization type.", "Bar chart.", "Line chart.", "Area chart.", "Pie chart.", "Scatter chart.", "Table chart.", "Score card chart.", "Sunburst chart.", "Gauge chart.", "Sankey chart." ], "type": "string", "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}" }, "description": { "description": "Chart description", "type": "string" }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "updateTime": { "description": "Output only. Chart last update time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "chartType": { "readOnly": true, "type": "string", "description": "Output only. Chart type.", "enum": [ "CHART_TYPE_UNSPECIFIED", "SYSTEM_DEFINED", "USER_DEFINED" ], "enumDescriptions": [ "Unspecified chart type.", "Pre-defined chart type.", "Configurable chart type." ] }, "width": { "description": "The width of the chart in grid units.", "type": "integer", "format": "int32" }, "height": { "description": "The height of the chart in grid units.", "type": "integer", "format": "int32" }, "displayName": { "type": "string", "description": "User provided display name of the chart." }, "dateRangeConfig": { "description": "Date range config applied to the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Chart", "description": "Configurable dashboard's widget that displays data as a chart." }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "description": "The CES end session annotation." }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "type": "object", "properties": { "sourceType": { "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." ], "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ] }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "properties": { "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true, "type": "integer", "format": "int32" }, "failedIngestCount": { "readOnly": true, "type": "integer", "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." }, "duplicatesSkippedCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested." }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true, "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "type": "object", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "name": { "type": "string", "description": "Required. The issue model to export." } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "properties": { "intentUniqueId": { "type": "string", "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig", "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions", "description": "Options for configuring what metadata is included in the conversation data used in QAI and Discovery Engine.", "type": "object", "properties": { "includeDialogflowInteractionData": { "description": "Whether to include the per turn Dialogflow interaction data in conversation transcript.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest", "description": "The request for bulk uploading feedback labels.", "type": "object", "properties": { "gcsSource": { "description": "A cloud storage bucket source.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource" }, "sheetsSource": { "description": "A sheets document source.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete." } } }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time at which the analysis ended." }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "description": "The result of an analysis." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "properties": { "spreadsheetUri": { "type": "string", "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata." }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "description": "The request to analyze conversations in bulk.", "type": "object", "properties": { "analysisPercentage": { "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number", "format": "float" }, "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" }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The create time of the conversation." }, "updateTime": { "description": "Output only. The update time of the conversation.", "readOnly": true, "type": "string", "format": "google-datetime" }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "description": "Ordered list of messages, including user inputs and system responses." }, "conversationId": { "type": "string", "description": "The conversation id of the chart." } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "description": "The request to export insights.", "type": "object", "properties": { "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties." }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" }, "exportSchemaVersion": { "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." ], "type": "string", "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": { "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." ], "type": "string", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] }, "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" } } }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "properties": { "sampledConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations sampled." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "conversationCorrelationErrors": { "type": "array", "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } } }, "type": "object" }, "GoogleTypeInterval": { "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.", "type": "object", "properties": { "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" }, "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries": { "properties": { "intervalDuration": { "type": "string", "format": "google-duration", "description": "The duration of each interval." }, "points": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval" }, "description": "An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "description": "A time series representing conversations over time." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "readOnly": true }, "partialErrors": { "type": "array", "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "Output only. The original request for download.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "properties": { "completedAnalysesCount": { "type": "integer", "format": "int32", "description": "The number of requested analyses that have completed successfully so far." }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true, "type": "array" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "totalRequestedAnalysesCount": { "type": "integer", "format": "int32", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "relabel": { "readOnly": true, "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1mainIntent": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the intent." }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntent", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "duplicatesSkippedCount": { "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "readOnly": true, "type": "integer", "format": "int32" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true, "type": "integer", "format": "int32" }, "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true, "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "description": "The analysis resource.", "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes." }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "readOnly": true }, "requestTime": { "description": "Output only. The time at which the analysis was requested.", "readOnly": true, "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": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData", "description": "Dialogflow interaction data.", "type": "object", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "type": "number", "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "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": { "description": "The error status.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "properties": { "summaryText": { "type": "string", "description": "The summary text of the performance." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse", "description": "The response for querying performance overview." }, "GoogleCloudContactcenterinsightsV1alpha1Dashboard": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dashboard", "description": "Configurable dashboard", "type": "object", "properties": { "displayName": { "type": "string", "description": "User provided display name of the dashboard." }, "dateRangeConfig": { "description": "Date range config applied to all charts in the dashboard.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dashboard creation time." }, "readOnly": { "readOnly": true, "type": "boolean", "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Dashboard last update time." }, "rootContainer": { "description": "The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "filter": { "type": "string", "description": "Filter applied to all charts in the dashboard. Should support scope later." }, "name": { "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}" }, "description": { "description": "Dashboard description", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule", "description": "A correlation rule that defines how to join conversations for a given correlation type.", "type": "object", "properties": { "active": { "description": "Optional. Whether the config is active to be evaluated.", "type": "boolean" }, "ruleId": { "type": "string", "description": "Required. The unique identifier of the rule." }, "constraintExpression": { "type": "string", "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)" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "The metrics last update time." }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, "slices": { "items": { "$ref": "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.", "type": "array" }, "location": { "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "properties": { "toolDisplayName": { "type": "string", "description": "Optional. The dialogflow tool display name." }, "toolId": { "type": "string", "description": "Optional. The dialogflow tool ID." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "type": "object", "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": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" }, "messageId": { "type": "string", "description": "The message id of the message." }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage", "description": "The message in the conversation." }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "type": "object", "properties": { "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" }, "table": { "type": "string", "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error." }, "projectId": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "properties": { "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "type": "string", "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Settings": { "type": "object", "properties": { "diagnosticMetricConfig": { "description": "Optional. Configuration for diagnostic metrics.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig" }, "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" }, "updateTime": { "description": "Output only. The time at which the settings were last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "speechConfig": { "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "createTime": { "description": "Output only. The time at which the settings was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" }, "conversationTtl": { "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.", "type": "string", "format": "google-duration" }, "timeZone": { "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.", "type": "string" }, "redactionConfig": { "description": "Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "pubsubNotificationSettings": { "type": "object", "additionalProperties": { "type": "string" }, "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}" }, "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" }, "analysisConfig": { "description": "Default analysis settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Settings", "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)." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecard": { "properties": { "createTime": { "description": "Output only. The time at which this scorecard was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the scorecard was updated." }, "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": { "type": "string", "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}" }, "description": { "type": "string", "description": "A text description explaining the intent of the scorecard." }, "displayName": { "type": "string", "description": "The user-specified display name of the scorecard." }, "source": { "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." ], "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "description": "Output only. The source of the scorecard.", "readOnly": true, "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard", "description": "A QaScorecard represents a collection of questions to be scored during analysis." }, "GoogleCloudContactcenterinsightsV1Intent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" }, "id": { "description": "The unique identifier of the intent.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1Intent", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "type": "object", "properties": { "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true, "type": "string" }, "correlationTypes": { "readOnly": true, "type": "array", "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "items": { "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "type": "string", "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] } }, "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "description": "Info for correlating across conversations." }, "GoogleCloudContactcenterinsightsV1mainDimension": { "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.", "properties": { "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata", "readOnly": true }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "readOnly": true }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "readOnly": true }, "dimensionKey": { "type": "string", "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" ], "description": "The key of the dimension.", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ] }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "readOnly": true }, "agentDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" }, "issueDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" }, "mediumDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", "description": "Response for an export insights operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "type": "object", "properties": { "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "description": "The request to sample conversations to a dataset." }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag" }, "updateMask": { "type": "string", "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": "object", "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "type": "object", "properties": { "feedbackLabelType": { "type": "string", "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ] }, "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "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" }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" }, "templateQaScorecardId": { "items": { "type": "string" }, "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", "type": "array" }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "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" } } }, "GoogleCloudContactcenterinsightsV1QaQuestionTag": { "id": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "properties": { "displayName": { "type": "string", "description": "Required. A user-specified display name for the tag." }, "createTime": { "description": "Output only. The time at which the question tag was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The most recent time at which the question tag was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "qaQuestionIds": { "type": "array", "items": { "type": "string" }, "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": "object" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "type": "array", "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "description": "Metadata for initializing a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "properties": { "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" }, "conversation": { "type": "string", "description": "The conversation scored by this result." }, "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" }, "description": "List of all individual score sets.", "type": "array" }, "qaScorecardRevision": { "type": "string", "description": "The QaScorecardRevision scored by this result." }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp that the revision was created." }, "name": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "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" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "qaAnswers": { "type": "array", "description": "Set of QaAnswers represented in the result.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1Issue": { "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "sampleUtterances": { "readOnly": true, "type": "array", "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "items": { "type": "string" } }, "updateTime": { "description": "Output only. The most recent time that this issue was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "type": "string", "description": "The representative name for the issue." } }, "id": "GoogleCloudContactcenterinsightsV1Issue", "description": "The issue resource." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference.", "type": "object", "properties": { "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, "table": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "dataset": { "type": "string", "description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights": { "properties": { "chartSpec": { "description": "Chart spec for the chart.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "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." }, "chartConversations": { "deprecated": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" }, "description": "Output only. The chart conversations used to generate the chart.", "readOnly": true, "type": "array" }, "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "sqlQuery": { "type": "string", "description": "SQL query used to generate the chart." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "description": "Request that use natural language query to generate the chart." }, "GoogleCloudCesV1mainToolsetTool": { "id": "GoogleCloudCesV1mainToolsetTool", "description": "A tool that is created from a toolset.", "type": "object", "properties": { "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" }, "toolset": { "type": "string", "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule", "description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", "type": "object", "properties": { "name": { "type": "string", "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}" }, "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" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this analysis rule was created." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which this analysis rule was updated." }, "analysisPercentage": { "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.", "type": "number", "format": "double" }, "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": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "displayName": { "type": "string", "description": "Display Name of the analysis rule." }, "active": { "type": "boolean", "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest", "description": "The request for generative insights.", "properties": { "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" }, "userProvidedChartSpec": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM." }, "chart": { "type": "string", "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}" }, "filter": { "type": "string", "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." }, "comparisonFilter": { "description": "Optional. Filter for the data that can be specified in addition to the natural language query. This `filter` is specifically used for charts where comparisons are possible. For example, \"compare to last month\" or \"compare to previous quarter\".", "type": "string" }, "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" }, "revisionId": { "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.", "type": "string" }, "naturalLanguageQuery": { "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored.", "type": "string" }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "properties": { "messages": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn." }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", "description": "The CES diagnostic information." }, "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse", "description": "The response of listing issue models.", "type": "object", "properties": { "issueModels": { "description": "The issue models that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1SampleRule": { "id": "GoogleCloudContactcenterinsightsV1SampleRule", "description": "Message for sampling conversations.", "properties": { "samplePercentage": { "type": "number", "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100]." }, "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "dimension": { "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", "type": "string" }, "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" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation.", "properties": { "ruleResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule." }, "conversation": { "type": "string", "description": "The conversation resource name." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse": { "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": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "The AuthorizedViewSets under the parent." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse", "description": "The response from a ListAuthorizedViewSet request." }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote", "description": "A note about the entire parent assessment." }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "description": "Metadata for creating an issue model." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "type": "object", "properties": { "text": { "type": "array", "description": "The text output from the LLM.", "items": { "type": "string" } }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "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." ] } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "type": "object", "properties": { "transcriptSegments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" }, "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "description": "A message representing the transcript of a conversation." }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "id": "GoogleCloudContactcenterinsightsV1alpha1Issue", "description": "The issue resource.", "type": "object", "properties": { "displayName": { "description": "The representative name for the issue.", "type": "string" }, "sampleUtterances": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. Resource names of the sample representative utterances that match to this issue." }, "name": { "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this issue was created." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated." }, "displayDescription": { "type": "string", "description": "Representative description of the issue." } } }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "type": "object", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "description": "The results for each correlation rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" }, "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "description": "One channel of conversation-level sentiment data." }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "description": "Google Cloud Storage Object details to get the feedback label file from.", "properties": { "objectUri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`" }, "format": { "description": "Required. File format which will be ingested.", "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] } }, "type": "object" }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "partialErrors": { "readOnly": true, "type": "array", "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "sampleConversationsStats": { "readOnly": true, "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { "type": "object", "properties": { "dimensions": { "type": "array", "description": "A unique combination of dimensions that this slice represents.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" } }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries" } }, "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]" }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "properties": { "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" }, "intents": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" }, "description": "All the matched intents in the call." }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "type": "object" }, "qaScorecardResults": { "type": "array", "description": "Results of scoring QaScorecards.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" } }, "sentiments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" }, "description": "Overall conversation-level sentiment for each channel of the call." }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "annotations": { "type": "array", "description": "A list of call annotations that apply to this call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "type": "object", "properties": { "format": { "description": "Required. File format in which the labels will be exported.", "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", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] }, "addWhitespace": { "type": "boolean", "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format." }, "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`" }, "recordsPerFileCount": { "description": "Optional. The number of records per file. Applicable for either format.", "type": "string", "format": "int64" }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "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." }, "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" }, "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": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse", "description": "The response for generative insights.", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" }, "type": "array" }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" }, "request": { "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "readOnly": true }, "sampledConversations": { "items": { "type": "string" }, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true, "type": "array" }, "partialErrors": { "readOnly": true, "type": "array", "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata", "description": "The metadata for an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata", "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true, "type": "array" }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "readOnly": true }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "description": "Request to import an issue model.", "properties": { "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." }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "properties": { "format": { "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format in which the labels will be exported.", "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." ] }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "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`" }, "recordsPerFileCount": { "type": "string", "format": "int64", "description": "Optional. The number of records per file. Applicable for either format." }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "type": "object", "properties": { "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.", "type": "integer", "format": "int32" }, "agentId": { "type": "string", "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`." }, "customerChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations." }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "properties": { "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "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" }, "answerSources": { "type": "array", "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" } }, "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." }, "qaQuestion": { "type": "string", "description": "The QaQuestion answered by this answer." }, "conversation": { "type": "string", "description": "The conversation the answer applies to." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "description": "An answer to a QaQuestion." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse", "description": "The response for querying metrics.", "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "The metrics last update time." }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "slices": { "type": "array", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" } }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn.", "type": "object", "properties": { "systemMessages": { "type": "array", "description": "A message from the system in response to the user.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" } } } }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "properties": { "successfulSampleCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of new conversations added during this sample operation." }, "failedSampleCount": { "readOnly": true, "type": "integer", "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": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1SilenceData": { "id": "GoogleCloudContactcenterinsightsV1SilenceData", "description": "The data for a silence annotation.", "properties": {}, "type": "object" }, "GoogleCloudCesV1mainSpan": { "id": "GoogleCloudCesV1mainSpan", "description": "A span is a unit of work or a single operation during the request processing.", "properties": { "attributes": { "description": "Output only. Key-value attributes associated with the span.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "readOnly": true, "type": "object" }, "duration": { "description": "Output only. The duration of the span.", "readOnly": true, "type": "string", "format": "google-duration" }, "endTime": { "description": "Output only. The end time of the span.", "readOnly": true, "type": "string", "format": "google-datetime" }, "startTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The start time of the span." }, "name": { "readOnly": true, "type": "string", "description": "Output only. The name of the span." }, "childSpans": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "description": "Output only. The child spans that are nested under this span." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "properties": { "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "type": "array" }, "conversationB": { "type": "string", "description": "The second conversation resource name." }, "conversationA": { "type": "string", "description": "The first conversation resource name." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { "properties": { "toolId": { "type": "string", "description": "Optional. The dialogflow tool ID." }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "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." }, "templateQaScorecardId": { "items": { "type": "string" }, "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", "type": "array" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "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" }, "conversationFilter": { "type": "string", "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." }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "feedbackLabelType": { "type": "string", "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ] } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "properties": { "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object", "properties": { "text": { "type": "array", "description": "The parts of the message.", "items": { "type": "string" } }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } } }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "readOnly": true }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" }, "type": "object" }, "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string", "format": "int64" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" }, "type": "array" }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse", "description": "The response for generative insights." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { "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.", "type": "object", "properties": { "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. User provided chart spec" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "generatedSqlQuery": { "type": "string", "description": "Raw SQL from LLM, before templatization" }, "chartSpec": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Chart spec from LLM" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource", "description": "The entity whose performance is being queried is a single agent.", "properties": { "agentId": { "description": "Required. Agent id to query performance overview for.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudCesV1mainAgentTransfer": { "id": "GoogleCloudCesV1mainAgentTransfer", "description": "Represents an event indicating the transfer of a conversation to a different agent.", "properties": { "targetAgent": { "type": "string", "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}`" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. Display name of the agent." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model.", "properties": { "medium": { "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "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`.", "deprecated": true }, "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, "type": "string", "format": "int64", "description": "Output only. Number of conversations used in training. Output only." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris": { "type": "object", "properties": { "signedTurnLevelAudios": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "description": "The signed URI for the audio corresponding to each turn in the conversation." }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris", "description": "Signed audio URIs for a conversation." }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "type": "integer", "format": "int32", "description": "Maximum number of conversations to delete." }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule", "description": "Rule for auto-labeling conversations.", "properties": { "conditions": { "type": "array", "description": "Conditions to apply for auto-labeling the label_key. Representing sequential block of if .. else if .. else statements. The value of the first matching condition will be used.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition" } }, "active": { "type": "boolean", "description": "Whether the rule is active." }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string" }, "description": { "description": "The description of the rule.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this rule was created." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the rule was updated." }, "labelKeyType": { "type": "string", "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "description": "The type of the label key.", "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ] }, "labelKey": { "description": "The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.", "type": "string" }, "displayName": { "type": "string", "description": "The user-provided display name of the rule." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { "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." } }, "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." }, "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { "type": "object", "properties": { "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." }, "agentVersionDisplayName": { "type": "string", "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions." }, "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" }, "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" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "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." }, "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": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "properties": { "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" }, "exportSchemaVersion": { "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." ], "type": "string", "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" ] }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "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}" }, "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.", "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", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "description": "The request to export insights." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "id": "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" } } }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } }, "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData", "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", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "properties": { "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1AnswerFeedback" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData" }, "annotationId": { "type": "string", "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1FaqAnswerData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation", "description": "An annotation that was generated during the customer and agent interaction." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata", "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.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Dimension": { "type": "object", "properties": { "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "readOnly": true }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "readOnly": true }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "readOnly": true }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "readOnly": true }, "dimensionKey": { "type": "string", "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" ], "description": "The key of the dimension.", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ] }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "readOnly": true }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "readOnly": true }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "readOnly": true }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "readOnly": true } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { "properties": { "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." ] }, "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" } }, "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." }, "GoogleIamV1Binding": { "id": "GoogleIamV1Binding", "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "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": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "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" } } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision", "description": "A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.", "properties": { "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "alternateIds": { "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "state": { "description": "Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "EDITABLE", "TRAINING", "TRAINING_FAILED", "READY", "DELETING", "TRAINING_CANCELLED" ] }, "name": { "type": "string", "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest": { "properties": { "validateOnly": { "description": "Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.", "type": "boolean" }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest", "description": "Request for TuneQaScorecardRevision endpoint." }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "properties": { "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels." }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1mainDataset": { "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)", "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the dataaset" }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "description": "Dataset usage type.", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ] }, "createTime": { "description": "Output only. Dataset create time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Dataset update time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "type": "string", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" }, "description": { "description": "Dataset description.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "properties": { "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": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" }, "parent": { "type": "string", "description": "Required. The parent resource of the issue model." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest", "description": "Request to import an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig": { "type": "object", "properties": { "metrics": { "description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "description": "Configuration for diagnostic metrics." }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata", "description": "Metadata for creating an issue.", "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "properties": { "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)." }, "title": { "type": "string", "description": "Article title." }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Map that contains metadata about the Article Suggestion and the document that it originates from." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "uri": { "type": "string", "description": "Article URI." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "type": "array", "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", "description": "Metadata for initializing a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "properties": { "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "type": "string", "format": "int64" }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", "description": "Aggregated statistics about an issue." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage", "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": { "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "description": "Chart spec from LLM", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "textOutput": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "properties": { "ruleConstraintResults": { "type": "array", "description": "The results for each applicable constraint rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" } }, "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "type": "string", "description": "The second conversation resource name." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "type": "object", "properties": { "appliedRedactionConfig": { "readOnly": true, "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true, "type": "string" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "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." }, "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" }, "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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata", "description": "Metadata for deploying an issue model." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse", "description": "The response of testing correlation config.", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata", "description": "Metadata used for export issue model." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for processing transcript objects.", "properties": { "medium": { "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "description": "The CES diagnostic information.", "properties": { "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "properties": { "correctnessLevel": { "type": "string", "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ] }, "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." } } }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "type": "object", "properties": { "sentiments": { "type": "array", "description": "Overall conversation-level sentiment for each channel of the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" } }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "type": "object" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" }, "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "type": "object", "description": "All the matched intents in the call." }, "phraseMatchers": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "description": "All the matched phrase matchers in the call." }, "qaScorecardResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" }, "description": "Results of scoring QaScorecards." }, "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" }, "description": "A list of call annotations that apply to this call.", "type": "array" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup", "description": "A message representing a rule in the phrase matcher.", "properties": { "type": { "type": "string", "enum": [ "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ], "description": "Required. The type of this phrase match rule group.", "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." ] }, "phraseMatchRules": { "description": "A list of phrase match rules that are included in this group.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "properties": { "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call.", "type": "array" }, "waitDuration": { "type": "string", "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent." }, "menuPath": { "type": "string", "description": "An arbitrary string value specifying the menu path the customer took." }, "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer", "format": "int32" }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "Input only. The feedback labels associated with the conversation.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "description": "Conversation metadata related to quality management." }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to export.", "type": "string" }, "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The human-readable name of the intent." } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization.", "properties": { "conversationProfile": { "type": "string", "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}" }, "summarizationModel": { "description": "Default summarization model to be used.", "type": "string", "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 ], "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ] }, "generator": { "type": "string", "description": "The resource name of the existing created generator. Format: projects//locations//generators/" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssue" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest", "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "type": "object", "properties": { "qaScorecardRevision": { "type": "string", "description": "The QaScorecardRevision scored by this result." }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" }, "description": "List of all individual score sets.", "type": "array" }, "potentialScore": { "type": "number", "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "qaAnswers": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "description": "Set of QaAnswers represented in the result.", "type": "array" }, "qaTagResults": { "type": "array", "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" } }, "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": { "type": "string", "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp that the revision was created." }, "score": { "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "description": "The response to undeploy an issue model.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { "type": "object", "properties": { "datasetValidationWarnings": { "type": "array", "items": { "type": "string", "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" ], "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." ] }, "description": "A list of any applicable data validation warnings about the question's feedback labels." }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" }, "totalValidLabelCount": { "description": "Total number of valid labels provided for the question at the time of tuining.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig": { "properties": { "exactMatchConfig": { "description": "The configuration for the exact match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig" }, "regexMatchConfig": { "description": "The configuration for the regex match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig", "description": "Configuration information of a phrase match rule." }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule", "description": "The data for a phrase match rule.", "properties": { "query": { "description": "Required. The phrase to be matched.", "type": "string" }, "negated": { "type": "boolean", "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment." }, "config": { "description": "Provides additional information about the rule that specifies how to apply the rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval": { "properties": { "conversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations created in this interval." }, "startTime": { "type": "string", "format": "google-datetime", "description": "The start time of this interval." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval", "description": "A single interval in a time series." }, "GoogleCloudContactcenterinsightsV1alpha1Note": { "id": "GoogleCloudContactcenterinsightsV1alpha1Note", "description": "The conversation assessment note resource.", "properties": { "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the note was created." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the note was last updated." }, "conversationTurnNote": { "description": "The note is associated with a conversation turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote" }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "content": { "description": "The note content.", "type": "string" }, "noteCreator": { "description": "Output only. The user that created the note.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { "type": "object", "properties": { "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "customMetadataKeys": { "type": "array", "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "items": { "type": "string" } }, "bucketObjectType": { "type": "string", "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`.", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ] }, "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "type": "object", "properties": { "silenceDuration": { "type": "string", "format": "google-duration", "description": "Amount of time calculated to be in silence." }, "silencePercentage": { "type": "number", "format": "float", "description": "Percentage of the total conversation spent in silence." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { "type": "object", "properties": { "strValue": { "type": "string", "description": "String value." }, "boolValue": { "type": "boolean", "description": "Boolean value." }, "key": { "type": "string", "description": "A short string used as an identifier." }, "score": { "type": "number", "format": "double", "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." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice", "description": "Message representing a possible answer to the question." }, "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig": { "properties": { "uploadConversationAnalysisPercentage": { "type": "number", "format": "double", "description": "Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100]." }, "runtimeIntegrationAnalysisPercentage": { "type": "number", "format": "double", "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100]." }, "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": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "description": "Default configuration when creating Analyses in Insights." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations.", "type": "object", "properties": { "summarizationSuggestionResultCount": { "type": "integer", "format": "int32", "description": "Count of summarization suggestions results." }, "aiCoachSuggestionAgentUsageCount": { "type": "integer", "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents." }, "knowledgeSearchUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "conversationCount": { "description": "The conversation count.", "type": "integer", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "knowledgeSearchSuggestedQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "qaTagScores": { "type": "array", "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "containedConversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were contained." }, "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": { "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number", "format": "double" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "conversationalAgentsAverageLlmCallLatency": { "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "type": "number", "format": "double" }, "aaSupervisorAssignedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor." }, "conversationAiCoachSuggestionCount": { "type": "integer", "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions." }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "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." }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "dialogflowInteractionsNoInputRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow interactions that has empty input." }, "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" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "conversationTotalCustomerMessageCount": { "type": "integer", "format": "int32", "description": "The customer message count." }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "containedConversationRatio": { "type": "number", "format": "double", "description": "The percentage of conversations that were contained." }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number", "format": "double" }, "knowledgeAssistUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "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." }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "type": "number", "format": "double" }, "knowledgeSearchAgentQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "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).", "type": "number", "format": "double" }, "averageTurnCount": { "type": "number", "format": "float", "description": "The average turn count." }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "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." }, "dialogflowAverageWebhookLatency": { "type": "number", "format": "double", "description": "Average latency of dialogflow webhook calls." }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." } } }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "question": { "type": "string", "description": "The corresponding FAQ question." }, "confidenceScore": { "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}." }, "answer": { "type": "string", "description": "The piece of text from the `source` knowledge base document." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", "description": "Agent Assist frequently-asked-question answer data." }, "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo", "description": "Message for schedule info.", "type": "object", "properties": { "schedule": { "type": "string", "description": "The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ..." }, "timeZone": { "type": "string", "description": "The timezone to use for the groc expression. If not specified, defaults to UTC." }, "startTime": { "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created.", "type": "string", "format": "google-datetime" }, "endTime": { "type": "string", "format": "google-datetime", "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse", "description": "The response from a ListQaQuestions request.", "type": "object", "properties": { "qaQuestions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "The QaQuestions 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" } } }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "type": "object", "properties": { "toolDisplayName": { "type": "string", "description": "Optional. The dialogflow tool display name." }, "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension." }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest", "description": "The request to undeploy a QaScorecardRevision" }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "id": "GoogleCloudContactcenterinsightsV1mainSampleRule", "description": "Message for sampling conversations.", "properties": { "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number", "format": "double" }, "sampleRow": { "type": "string", "format": "int64", "description": "Number of the conversations that we should sample based on the dimension." }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation.", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "relabel": { "readOnly": true, "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations." }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "totalRequestedAnalysesCount": { "type": "integer", "format": "int32", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "type": "integer", "format": "int32" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "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." }, "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", "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" ] }, "trainingConversationsCount": { "description": "Output only. Number of conversations used in training. Output only.", "readOnly": true, "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse", "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "type": "object", "properties": { "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "The feedback labels 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" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "description": "The response to an IngestConversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest", "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1Entity": { "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", "properties": { "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "displayName": { "type": "string", "description": "The representative name for the entity." }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below." }, "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number", "format": "float" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "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`." ] } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "type": "object", "properties": { "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "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-`" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "description": "Request to upload a conversation." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "properties": { "systemMessages": { "type": "array", "description": "A message from the system in response to the user.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage", "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "type": "object", "properties": { "text": { "type": "string", "description": "A message from the user that is interacting with the system." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message." }, "GoogleCloudContactcenterinsightsV1IssueModel": { "type": "object", "properties": { "state": { "description": "Output only. State of the model.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ] }, "languageCode": { "type": "string", "description": "Language of the model." }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "issueCount": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. Number of issues in this issue model." }, "name": { "type": "string", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "trainingStats": { "readOnly": true, "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats" }, "displayName": { "type": "string", "description": "The representative name for the issue model." }, "modelType": { "description": "Type of the model.", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] } }, "id": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "The issue model resource." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" }, "description": "All the matched issues.", "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", "description": "Issue Modeling result on a conversation." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", "description": "Response from import issue model", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { "properties": { "confidence": { "type": "number", "format": "float", "description": "The confidence score of the summarization." }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "text": { "type": "string", "description": "The summarization content that is concatenated into one string." }, "textSections": { "type": "object", "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." }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "id": "GoogleCloudContactcenterinsightsV1mainSilenceData", "description": "The data for a silence annotation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1HoldData": { "id": "GoogleCloudContactcenterinsightsV1HoldData", "description": "The data for a hold annotation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "properties": { "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" }, "textType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "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." ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "properties": { "aaSupervisorMonitoredConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations scanned by the AA human supervisor." }, "avgConversationClientTurnSentimentEma": { "type": "number", "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation." }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "knowledgeSearchAgentQuerySourceRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "knowledgeAssistUriClickRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "type": "number", "format": "double" }, "averageCustomerSatisfactionRating": { "type": "number", "format": "double", "description": "The average customer satisfaction rating." }, "averageSummarizationSuggestionNormalizedEditDistance": { "type": "number", "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)." }, "averageTurnCount": { "description": "The average turn count.", "type": "number", "format": "float" }, "knowledgeAssistResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user." }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "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.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "type": "number", "format": "double", "description": "Average latency of dialogflow webhook calls." }, "dialogflowInteractionsNoMatchRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow interactions that has no intent match for the input." }, "conversationTotalCustomerMessageCount": { "type": "integer", "format": "int32", "description": "The customer message count." }, "containedConversationRatio": { "type": "number", "format": "double", "description": "The percentage of conversations that were contained." }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "averageClientSentimentScore": { "type": "number", "format": "float", "description": "The average client's sentiment score." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion." }, "aiCoachSuggestionMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "knowledgeSearchNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "dialogflowWebhookFailureRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow webhook calls that failed." }, "aaSupervisorEscalatedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention." }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "conversationalAgentsAverageLlmCallLatency": { "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "summarizationSuggestionEditRatio": { "type": "number", "format": "double", "description": "Proportion of summarization suggestions that were manually edited." }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "averageSummarizationSuggestionEditDistance": { "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "type": "number", "format": "double" }, "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." }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "knowledgeSearchUriClickRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "conversationCount": { "description": "The conversation count.", "type": "integer", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "averageDuration": { "type": "string", "format": "google-duration", "description": "The average duration." }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback." }, "knowledgeSearchSuggestedQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "dialogflowConversationsEscalationRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent." }, "containedConversationCount": { "description": "The number of conversations that were contained.", "type": "integer", "format": "int32" }, "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": { "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number", "format": "double" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "description": "Metadata used for export issue model.", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "type": "object", "properties": { "customerSatisfactionRating": { "type": "integer", "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating." }, "feedbackLabels": { "type": "array", "description": "Input only. The feedback labels associated with the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "agentInfo": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call." }, "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": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata", "description": "Conversation metadata related to quality management." }, "GoogleCloudCesV1mainEndSession": { "id": "GoogleCloudCesV1mainEndSession", "description": "Indicates the session has terminated, due to either successful completion (e.g. user says \"Good bye!\" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.", "type": "object", "properties": { "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session." } } }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "properties": { "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1mainHoldData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1mainInterruptionData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" } }, "type": "object" }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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." }, "name": { "type": "string", "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}`." }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet": { "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", "type": "object", "properties": { "displayName": { "type": "string", "description": "Display Name. Limit 64 characters." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Create time." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update time." }, "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage": { "properties": { "createTime": { "description": "For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "format": "google-datetime" }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage" }, "systemMessage": { "description": "A message from the system in response to the user.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage" }, "messageId": { "type": "string", "description": "The message id of the message." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage", "description": "The message in the conversation." }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "type": "object", "properties": { "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" }, "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.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" } } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "description": "Aggregated statistics about an issue model." }, "GoogleCloudCesV1mainBlob": { "type": "object", "properties": { "data": { "description": "Required. Raw bytes of the blob.", "type": "string", "format": "byte" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, "id": "GoogleCloudCesV1mainBlob", "description": "Represents a blob input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "description": "Response for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object", "properties": { "title": { "description": "Article title.", "type": "string" }, "source": { "type": "string", "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}" }, "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" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "type": "object", "properties": { "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "The data for an issue match annotation." }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest", "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Metadata about the Conversational Agents playbook dimension.", "type": "object", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage", "description": "The message in the conversation.", "type": "object", "properties": { "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "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.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "type": "string", "description": "Required. Format: `gs:///`" } } }, "GoogleCloudContactcenterinsightsV1GcsSource": { "id": "GoogleCloudContactcenterinsightsV1GcsSource", "description": "A Cloud Storage source of conversation data.", "properties": { "audioUri": { "type": "string", "description": "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse", "description": "The response of listing views.", "type": "object", "properties": { "views": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "The views that match the request.", "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." } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "type": "object", "properties": { "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": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "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" }, "chartSpec": { "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textOutput": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "deprecated": true, "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudCesV1mainImage": { "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" }, "data": { "description": "Required. Raw bytes of the image.", "type": "string", "format": "byte" } }, "type": "object", "id": "GoogleCloudCesV1mainImage", "description": "Represents an image input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "description": "The issue model resource.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this issue model was created." }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "readOnly": true, "type": "string", "format": "int64" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated." }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "readOnly": true }, "displayName": { "type": "string", "description": "The representative name for the issue model." }, "modelType": { "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model.", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ] }, "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" ], "description": "Output only. State of the model.", "readOnly": true, "type": "string" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" }, "languageCode": { "type": "string", "description": "Language of the model." } } }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "description": "The CES end session annotation.", "type": "object", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1alpha1UserInfo": { "type": "object", "properties": { "username": { "description": "The user's username.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "description": "Information about a user." }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", "description": "The response for querying performance overview.", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1alpha1ChartAction": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "description": "The action to be taken when the chart is clicked.", "type": "object", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" }, "conversationFilter": { "type": "string", "description": "The conversation filter string." } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata", "description": "The metadata for generative insights." }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The request to delete an issue model.", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse", "description": "The response message for listing auto labeling rules.", "properties": { "autoLabelingRules": { "description": "The auto labeling rules.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "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" }, "GoogleCloudCesV1mainToolResponse": { "id": "GoogleCloudCesV1mainToolResponse", "description": "The execution result of a specific tool from the client or the agent.", "type": "object", "properties": { "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "GoogleCloudCesV1mainToolsetTool" }, "id": { "type": "string", "description": "Optional. The matching ID of the tool call the response is for." }, "tool": { "type": "string", "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1Dataset": { "properties": { "name": { "type": "string", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" }, "description": { "type": "string", "description": "Dataset description." }, "updateTime": { "description": "Output only. Dataset update time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "description": "Dataset usage type.", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ] }, "createTime": { "description": "Output only. Dataset create time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Display name for the dataaset" }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" } }, "type": "object", "id": "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)" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "force": { "type": "boolean", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses." }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest", "description": "The request for calculating conversation statistics.", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote": { "type": "object", "properties": { "turnIndex": { "type": "integer", "format": "int32", "description": "The conversation turn index that the note is associated with." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote", "description": "A note about a conversation turn." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension.", "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" }, "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." }, "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" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse": { "type": "object", "properties": { "charts": { "description": "The charts under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The value returned by the last `ListChartsResponse`. This value indicates that this is a continuation of a prior `ListCharts` call and that the system should return the next page of data." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse", "description": "The response of listing charts." }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse", "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The next page token." } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "properties": { "userId": { "type": "string", "description": "A user-specified ID representing the participant." }, "role": { "description": "The role of the participant.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "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" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "dialogflowParticipantName": { "type": "string", "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "description": "Request to upload a conversation.", "properties": { "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "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-`" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "parent": { "type": "string", "description": "Required. The parent resource of the conversation." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "properties": { "systemMessages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user." } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "type": "object", "properties": { "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation", "description": "An annotation that was generated during the customer and agent interaction." }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse", "description": "The response from a ListAuthorizedViews request.", "type": "object", "properties": { "authorizedViews": { "description": "The AuthorizedViews under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse", "description": "Response of querying an issue model's statistics.", "properties": { "currentStats": { "description": "The latest label statistics for the queried issue model. Includes results on both training data and data labeled after deployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "properties": { "summaryText": { "type": "string", "description": "The summary text of the performance." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse", "description": "The response for querying performance overview." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse", "description": "Response for an export insights operation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "type": "object", "properties": { "customMetadataKeys": { "type": "array", "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "items": { "type": "string" } }, "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`." }, "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" }, "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" }, "audioBucketUri": { "type": "string", "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`." }, "bucketObjectType": { "type": "string", "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`.", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "properties": { "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "templateQaScorecardId": { "items": { "type": "string" }, "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", "type": "array" }, "maxDownloadCount": { "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer", "format": "int32" }, "feedbackLabelType": { "description": "Optional. The type of feedback labels that will be downloaded.", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "type": "string", "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ] }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "conversationFilter": { "type": "string", "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." }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest", "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable." }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "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": { "description": "The rule ID.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "description": "Response for an export insights operation.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer", "type": "object", "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": { "type": "string", "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "description": "Query source for the answer.", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ] } } }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "description": "Dialogflow interaction data.", "properties": { "dialogflowIntentId": { "type": "string", "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}" }, "confidence": { "type": "number", "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "text": { "description": "The text of this segment.", "type": "string" }, "words": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" }, "description": "A list of the word-specific information for each word in the segment.", "type": "array" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "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" }, "messageTime": { "type": "string", "format": "google-datetime", "description": "The time that the message occurred, if provided." }, "channelTag": { "type": "integer", "format": "int32", "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono." }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "type": "object", "properties": { "joinKeyResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" }, "description": "A list of join key correlation results for each conversation tested." }, "constraintResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" }, "description": "A list of constraint evaluation results for each pair of conversations." } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "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": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "description": "The request to ingest conversations." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "type": "object", "properties": { "generatedSqlQuery": { "type": "string", "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource." }, "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" }, "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" }, "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." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart." }, "GoogleIamV1AuditConfig": { "properties": { "service": { "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.", "type": "string" }, "auditLogConfigs": { "items": { "$ref": "GoogleIamV1AuditLogConfig" }, "description": "The configuration for logging of each type of permission.", "type": "array" } }, "type": "object", "id": "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." }, "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": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" }, "type": { "description": "The type of the entity mention.", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "type": "string", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "description": "Call-specific metadata.", "type": "object", "properties": { "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" }, "agentChannel": { "description": "The audio channel that contains the agent.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data." }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true, "type": "integer", "format": "int32" }, "failedSampleCount": { "readOnly": true, "type": "integer", "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": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "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." }, "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote": { "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote", "description": "A note about a QA question." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation.", "type": "object", "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true, "type": "integer", "format": "int32" }, "failedSampleCount": { "readOnly": true, "type": "integer", "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." } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse", "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata", "description": "Metadata for an export insights operation.", "type": "object", "properties": { "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer", "description": "An answer to a QaQuestion.", "properties": { "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "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" }, "answerSources": { "type": "array", "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" } }, "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "items": { "type": "string" }, "type": "array" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "conversation": { "type": "string", "description": "The conversation the answer applies to." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "type": "object", "properties": { "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag." }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "properties": { "transcriptIndex": { "type": "integer", "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero." }, "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "properties": { "confidence": { "type": "number", "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset." }, "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\"." }, "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "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" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" }, "words": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, "description": "A list of the word-specific information for each word in the segment.", "type": "array" }, "text": { "description": "The text of this segment.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript." }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Metadata about the Conversational Agents playbook dimension.", "properties": { "playbookId": { "type": "string", "description": "Optional. The dialogflow playbook ID." }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "type": "object", "properties": { "dimensions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "description": "A unique combination of dimensions that this slice represents.", "type": "array" }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" } }, "id": "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]" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "properties": { "words": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" }, "description": "A list of the word-specific information for each word in the segment.", "type": "array" }, "text": { "description": "The text of this segment.", "type": "string" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "channelTag": { "type": "integer", "format": "int32", "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono." }, "confidence": { "type": "number", "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset." }, "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\"." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The request to delete an issue model.", "type": "object", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse", "description": "The response for calculating conversation statistics.", "type": "object", "properties": { "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" }, "issueMatchesStats": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "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/`" }, "conversationCount": { "type": "integer", "format": "int32", "description": "The total number of conversations." }, "conversationCountTimeSeries": { "description": "A time series representing the count of conversations created over time that match that requested filter criteria.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries" }, "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." }, "averageTurnCount": { "description": "The average number of turns per conversation.", "type": "integer", "format": "int32" }, "smartHighlighterMatches": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object", "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations." }, "issueMatches": { "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "deprecated": true, "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" } } }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "type": "object", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "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)." }, "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" } }, "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData", "description": "Agent Assist Smart Reply data." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "properties": { "phraseMatcher": { "type": "string", "description": "The unique identifier (the resource name) of the phrase matcher." }, "displayName": { "type": "string", "description": "The human-readable name of the phrase matcher." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "description": "The request to ingest conversations.", "type": "object", "properties": { "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "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": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "description": "Information about the issue.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "type": "object", "properties": { "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}" }, "obfuscatedExternalUserId": { "type": "string", "description": "Obfuscated user ID from Dialogflow." }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "role": { "description": "The role of the participant.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", "description": "Response from import issue model", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "description": "The data for an interruption annotation.", "type": "object", "properties": {} }, "GoogleIamV1TestIamPermissionsResponse": { "id": "GoogleIamV1TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true, "type": "string" }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig": { "type": "object", "properties": { "correlationRules": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" }, "description": "A list of correlation rules to be evaluated for correlation." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig", "description": "A list of correlation rules for a given correlation type." }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation.", "properties": { "ruleResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule.", "type": "array" }, "conversation": { "description": "The conversation resource name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse", "description": "The response message for testing auto labeling rules.", "type": "object", "properties": { "labelResult": { "description": "The result of the test auto labeling rule.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "totalRequestedAnalysesCount": { "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "type": "integer", "format": "int32" }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "relabel": { "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true, "type": "boolean" }, "completedAnalysesCount": { "type": "integer", "format": "int32", "description": "The number of requested analyses that have completed successfully so far." }, "partialErrors": { "readOnly": true, "type": "array", "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation." }, "GoogleCloudCesV1mainToolCall": { "type": "object", "properties": { "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." }, "tool": { "type": "string", "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. Display name of the tool." }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "GoogleCloudCesV1mainToolsetTool" }, "args": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The input parameters and values for the tool in JSON object format." } }, "id": "GoogleCloudCesV1mainToolCall", "description": "Request for the client or the agent to execute the specified tool." }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", "description": "The request to deploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "properties": { "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, "table": { "type": "string", "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error." }, "dataset": { "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." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "properties": { "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest", "description": "Request to import an issue model.", "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "id": "GoogleCloudContactcenterinsightsV1QaAnswer", "description": "An answer to a QaQuestion.", "type": "object", "properties": { "answerSources": { "type": "array", "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" } }, "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "items": { "type": "string" }, "type": "array" }, "questionBody": { "type": "string", "description": "Question text. E.g., \"Did the agent greet the customer?\"" }, "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" }, "conversation": { "type": "string", "description": "The conversation the answer applies to." }, "qaQuestion": { "type": "string", "description": "The QaQuestion answered by this answer." } } }, "GoogleIamV1TestIamPermissionsRequest": { "id": "GoogleIamV1TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "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)." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "description": "A message representing the transcript of a conversation.", "type": "object", "properties": { "transcriptSegments": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" }, "description": "A list of sequential transcript segments that comprise the conversation." } } }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata", "description": "The metadata for querying performance overview.", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension." }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule.", "type": "object", "properties": { "ruleId": { "description": "The rule ID.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "properties": { "displayName": { "type": "string", "description": "The human-readable name of the intent." } }, "type": "object" }, "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.", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "description": "Configuration for the QA feature." }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "type": "object", "properties": { "averageTurnCount": { "type": "number", "format": "float", "description": "The average turn count." }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "knowledgeAssistNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "averageSummarizationSuggestionNormalizedEditDistance": { "type": "number", "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)." }, "averageCustomerSatisfactionRating": { "type": "number", "format": "double", "description": "The average customer satisfaction rating." }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "type": "number", "format": "double" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "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.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion." }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "avgConversationClientTurnSentimentEma": { "type": "number", "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation." }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "type": "number", "format": "double" }, "knowledgeAssistUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "knowledgeSearchAgentQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion." }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerRatio": { "type": "number", "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "knowledgeSearchNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback." }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "type": "number", "format": "double" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "averageSilencePercentage": { "type": "number", "format": "float", "description": "The average silence percentage." }, "averageSummarizationSuggestionEditDistance": { "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "summarizationSuggestionEditRatio": { "type": "number", "format": "double", "description": "Proportion of summarization suggestions that were manually edited." }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "knowledgeSearchResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user." }, "dialogflowInteractionsNoInputRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow interactions that has empty input." }, "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" }, "conversationalAgentsAverageLlmCallLatency": { "type": "number", "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." }, "aaSupervisorEscalatedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention." }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "type": "number", "format": "double" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "dialogflowConversationsEscalationRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent." }, "knowledgeSearchSuggestedQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number", "format": "double" }, "qaTagScores": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags.", "type": "array" }, "dialogflowConversationsEscalationCount": { "type": "number", "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent." }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of agent 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": { "type": "number", "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." }, "containedConversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were contained." }, "summarizationSuggestionResultCount": { "type": "integer", "format": "int32", "description": "Count of summarization suggestions results." }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "knowledgeSearchUriClickRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback." }, "conversationCount": { "type": "integer", "format": "int32", "description": "The conversation count." }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation.", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "partialErrors": { "type": "array", "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse": { "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" }, "analysisRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "The analysis_rule that match the request.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse", "description": "The response of listing views." }, "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { "type": "object", "properties": { "speechRecognizer": { "type": "string", "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`" }, "disableWordTimeOffsets": { "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1mainFeedbackLabel": { "id": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "type": "object", "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "createTime": { "description": "Output only. Create time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Update 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": { "type": "string", "description": "String label used for Topic Modeling." } } }, "GoogleIamV1Policy": { "type": "object", "properties": { "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": { "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`.", "type": "array" }, "auditConfigs": { "type": "array", "items": { "$ref": "GoogleIamV1AuditConfig" }, "description": "Specifies cloud audit logging configuration for this policy." }, "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).", "type": "integer", "format": "int32" } }, "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/)." }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "type": "object", "properties": { "conversation": { "type": "string", "description": "The conversation resource name that had an error during correlation." }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "dialogflowConversation": { "readOnly": true, "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}" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "A Dialogflow source of conversation data." }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "type": "object", "properties": { "failedAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of failed analyses." }, "successfulAnalysisCount": { "description": "Count of successful analyses.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1IntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "type": "object", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "type": "object", "properties": { "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation." }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse", "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." } }, "type": "object" }, "GoogleCloudCesV1mainChunk": { "id": "GoogleCloudCesV1mainChunk", "description": "A chunk of content within a message.", "properties": { "text": { "description": "Optional. Text data.", "type": "string" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "GoogleCloudCesV1mainToolResponse" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "GoogleCloudCesV1mainAgentTransfer" }, "updatedVariables": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "A struct represents variables that were updated in the conversation, keyed by variable names." }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "payload": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Custom payload data." }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "GoogleCloudCesV1mainToolCall" }, "image": { "description": "Optional. Image data.", "$ref": "GoogleCloudCesV1mainImage" }, "blob": { "description": "Optional. Blob data.", "$ref": "GoogleCloudCesV1mainBlob" }, "defaultVariables": { "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." } } }, "GoogleCloudContactcenterinsightsV1Dimension": { "type": "object", "properties": { "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" }, "labelDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" }, "qaScorecardDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" }, "issueDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "readOnly": true }, "conversationProfileDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "readOnly": true }, "dimensionKey": { "description": "The key of the dimension.", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "type": "string", "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" ] }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "agentDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" } }, "id": "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." }, "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest", "description": "The request to deploy a QaScorecardRevision", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "properties": { "score": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. Numerical score of the answer." }, "strValue": { "type": "string", "description": "String value." }, "boolValue": { "type": "boolean", "description": "Boolean value." }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`." }, "normalizedScore": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score." }, "potentialScore": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. The maximum potential score of the question." }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "numValue": { "description": "Numerical value.", "type": "number", "format": "double" }, "skipValue": { "readOnly": true, "type": "boolean", "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question." }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer", "type": "object", "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.", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "type": "string", "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ] } } }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio.", "properties": { "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "turnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" }, "description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", "type": "array" }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1GcsSource" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "type": "object", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "description": "The CES end session annotation." }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "The data for a sentiment annotation.", "type": "object", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number", "format": "float" }, "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryInterval": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "A time window for querying conversations.", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. The start time of the time window." }, "endTime": { "description": "Required. The end time of the time window.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "type": "string", "description": "Optional. The QA scorecard ID." }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse": { "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" }, "authorizedViews": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "description": "The AuthorizedViews under the parent.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse", "description": "The response from a ListAuthorizedViews request." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object", "properties": { "dataPoints": { "type": "array", "description": "The data points that make up the time series .", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" } } } }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData", "description": "The data for an interruption annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object", "properties": { "dataPoints": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series ." } } }, "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { "type": "object", "properties": { "feedbackLabels": { "type": "array", "description": "The feedback labels that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "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": "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion", "description": "A single question to be scored by the Insights QA feature.", "type": "object", "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this question was created." }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "metrics": { "description": "Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question. This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" }, "answerInstructions": { "description": "Instructions describing how to determine the answer.", "type": "string" }, "questionType": { "description": "The type of question.", "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." ], "type": "string", "enum": [ "QA_QUESTION_TYPE_UNSPECIFIED", "CUSTOMIZABLE", "PREDEFINED" ] }, "answerChoices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" }, "description": "A list of valid answers to the question, which the LLM must choose from.", "type": "array" }, "tags": { "items": { "type": "string" }, "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" }, "updateTime": { "description": "Output only. The most recent time at which the question was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "tuningMetadata": { "description": "Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata" }, "name": { "type": "string", "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}" }, "predefinedQuestionConfig": { "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" }, "order": { "type": "integer", "format": "int32", "description": "Defines the order of the question within its parent scorecard revision." }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse": { "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." }, "qaScorecardRevisions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "The QaScorecards under the parent." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse", "description": "The response from a ListQaScorecardRevisions request." }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "type": "object", "properties": { "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "properties": { "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "word": { "type": "string", "description": "The word itself. Includes punctuation marks that surround the word." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript." }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "type": "object", "properties": { "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation", "description": "A piece of metadata that applies to a window of a call." }, "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { "properties": { "labelKey": { "type": "string", "description": "Optional. The label key." }, "labelValue": { "type": "string", "description": "Optional. The label value." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "description": "Metadata about conversation labels." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "properties": { "qaScorecardRevision": { "type": "string", "description": "The QaScorecardRevision scored by this result." }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" }, "type": "array" }, "potentialScore": { "type": "number", "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "agentId": { "type": "string", "description": "ID of the agent that handled the conversation." }, "qaAnswers": { "type": "array", "description": "Set of QaAnswers represented in the result.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" } }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "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" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "score": { "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number", "format": "double" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "properties": { "errorMessages": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "The error message when the generative insights request fails." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "description": "The metadata for generative insights." }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "properties": { "constraintMet": { "type": "boolean", "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A)." }, "ruleId": { "type": "string", "description": "The rule ID." }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "channelTag": { "type": "integer", "format": "int32", "description": "The channel of the audio that the data applies to." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data." }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "properties": { "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "versionId": { "type": "string", "description": "The agent's version ID. Only applicable to automated agents." }, "location": { "description": "The agent's location.", "type": "string" }, "team": { "type": "string", "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "versionDisplayName": { "type": "string", "description": "The agent's version display name. Only applicable to automated agents." }, "agentType": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "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." ] }, "teams": { "type": "array", "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" } }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "entrySubagentId": { "type": "string", "description": "The entry subagent's ID." }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo", "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse": { "properties": { "datasets": { "description": "The datasets that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "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": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse", "description": "The response to list datasets." }, "GoogleIamV1SetIamPolicyRequest": { "id": "GoogleIamV1SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "properties": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`" }, "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse", "description": "The response for generative insights.", "properties": { "generativeResponses": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" }, "description": "The full list of generative responses. Each response is ordered by time.", "type": "array" }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig", "description": "A configuration that defines how to correlate conversations for a given a given project.", "properties": { "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" }, "fullConversationConfig": { "description": "The correlation type config for full conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" }, "createTime": { "description": "Output only. The time at which the correlation config was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the correlation config was last updated." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage", "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "type": "object", "properties": { "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "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" } }, "userProvidedSqlQuery": { "type": "string", "description": "Optional. User provided SQL query" } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "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." }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "type": "boolean", "description": "Whether to run the active phrase matcher annotator(s)." }, "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" }, "runSummarizationAnnotator": { "type": "boolean", "description": "Whether to run the summarization annotator." }, "runInterruptionAnnotator": { "type": "boolean", "description": "Whether to run the interruption annotator." }, "runSilenceAnnotator": { "type": "boolean", "description": "Whether to run the silence annotator." }, "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" } }, "runEntityAnnotator": { "type": "boolean", "description": "Whether to run the entity annotator." }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" }, "runAutoLabelingAnnotator": { "description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "type": "object", "properties": { "texts": { "description": "The parts of the message.", "items": { "type": "string" }, "type": "array" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "description": "A text output message from the system." }, "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "description": "Call-specific metadata.", "properties": { "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" }, "agentChannel": { "description": "The audio channel that contains the agent.", "type": "integer", "format": "int32" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse", "description": "The response of listing conversations.", "type": "object", "properties": { "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" }, "conversations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "The conversations that match the request." } } }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "description": "The data for an issue match annotation.", "type": "object", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "type": "object", "properties": { "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "type": "number", "format": "float" }, "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "type": "object", "properties": { "labeledConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations attached to the issue at this point in time." }, "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": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", "description": "Aggregated statistics about an issue." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "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" }, "qaQuestionIds": { "items": { "type": "string" }, "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" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated." }, "createTime": { "description": "Output only. The time at which the question tag was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "properties": { "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score the tag applies to." }, "tag": { "type": "string", "description": "The tag the score applies to." }, "score": { "type": "number", "format": "double", "description": "The score the tag applies to." }, "potentialScore": { "description": "The potential score the tag applies to.", "type": "number", "format": "double" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "description": "Tags and their corresponding results." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint", "description": "The current chart checkpoint state.", "type": "object", "properties": { "sessionId": { "type": "string", "description": "The session id of the chart." }, "revisionId": { "type": "string", "description": "The revision id of the chart." } } }, "GoogleCloudContactcenterinsightsV1alpha1View": { "id": "GoogleCloudContactcenterinsightsV1alpha1View", "description": "The View resource.", "type": "object", "properties": { "createTime": { "description": "Output only. The time at which this view was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The most recent time at which the view was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "value": { "type": "string", "description": "A filter to reduce conversation results to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details." }, "name": { "type": "string", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}" }, "displayName": { "description": "The human-readable display name of the view.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "properties": { "p50": { "description": "The 50th percentile value.", "type": "number", "format": "double" }, "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." }, "p99": { "type": "number", "format": "double", "description": "The 99th percentile value." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { "properties": { "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "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" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage", "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." }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "description": "The result of an analysis.", "type": "object", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The time at which the analysis ended." }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" } } }, "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource": { "type": "object", "properties": { "generativeInsights": { "description": "Use natural language query to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights" }, "queryMetrics": { "description": "Use the existing QueryMetrics to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource", "description": "The request data for visualizing the dataset in the chart." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest": { "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": { "description": "Optional. A list of conversations to test against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "correlationConfig": { "description": "Required. The correlation config to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "maxSampleCount": { "type": "integer", "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": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest", "description": "The request to test correlation config." }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "type": "object", "properties": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model." }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation", "description": "An annotation that was generated during the customer and agent interaction.", "properties": { "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "createTime": { "type": "string", "format": "google-datetime", "description": "The time at which this annotation was created." }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string", "format": "google-fieldmask" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript.", "properties": { "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "endOffset": { "type": "string", "format": "google-duration", "description": "Time offset of the end 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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "description": "A Cloud Storage source of conversation data.", "type": "object", "properties": { "audioUri": { "type": "string", "description": "Cloud Storage URI that points to a file that contains the conversation audio." }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse", "description": "The response from a GenerateConversationSignedAudio request.", "type": "object", "properties": { "signedAudioUris": { "description": "The signed uris for the audio.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "description": "Call-specific metadata.", "properties": { "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" }, "agentChannel": { "type": "integer", "format": "int32", "description": "The audio channel that contains the agent." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "description": "A wrapper for holding the audio for any given turn." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", "description": "The response to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest", "description": "The message to appeal an assessment." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "description": "Metadata for deploying an issue model." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage", "description": "The message in the conversation.", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "type": "string", "description": "The message id of the message." }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "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." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p50": { "type": "number", "format": "double", "description": "The 50th percentile value." }, "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." } } }, "GoogleCloudContactcenterinsightsV1alpha1Assessment": { "id": "GoogleCloudContactcenterinsightsV1alpha1Assessment", "description": "The assessment resource.", "properties": { "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the assessment was last updated." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the assessment was created." }, "state": { "description": "Output only. The state of the assessment.", "readOnly": true, "type": "string", "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" ] }, "agentInfo": { "description": "Information about the agent the assessment is for.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "name": { "type": "string", "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "type": "object", "properties": { "spreadsheetUri": { "type": "string", "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata." }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse", "description": "The response to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "description": "All the matched issues.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1Widget": { "id": "GoogleCloudContactcenterinsightsV1alpha1Widget", "description": "Represents a dashboard element, could be a nested Container or Chart.", "properties": { "container": { "description": "A container widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "chartReference": { "type": "string", "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}" }, "chart": { "description": "A chart widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer", "type": "object", "properties": { "query": { "type": "string", "description": "Query text. Article Search uses this to store the input query used to generate the search results." }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "querySource": { "description": "Query source for the answer.", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "type": "string", "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "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" }, "answerValue": { "type": "string", "description": "Optional. The full body of the question." }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "type": "object", "properties": { "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "phraseMatcher": { "type": "string", "description": "The unique identifier (the resource name) of the phrase matcher." } }, "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match." }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest": { "properties": { "filter": { "type": "string", "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." }, "queryInterval": { "description": "Required. The time window of the conversations to derive performance stats from.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "comparisonQueryInterval": { "description": "The time window of the conversations to compare the performance to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "agentPerformanceSource": { "description": "Conversations are from a single agent.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest", "description": "The request for summarizing performance according to different metrics for conversations over a specified time window." }, "GoogleCloudContactcenterinsightsV1alpha1Container": { "id": "GoogleCloudContactcenterinsightsV1alpha1Container", "description": "Configurable dashboard's container. Container can contain multiple widgets.", "properties": { "filter": { "type": "string", "description": "Filter applied to all charts in the container. Should support scope later." }, "widgets": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Widget" }, "description": "Widgets in the Container.", "type": "array" }, "description": { "type": "string", "description": "Container description" }, "width": { "description": "The width of the container in grid units.", "type": "integer", "format": "int32" }, "displayName": { "type": "string", "description": "User provided display name of the Container." }, "containerId": { "readOnly": true, "type": "string", "description": "Output only. Unique ID for the container." }, "dateRangeConfig": { "description": "Date range config applied to all charts in the container.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "height": { "type": "integer", "format": "int32", "description": "The height of the container in grid units." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "description": "The conversation resource.", "type": "object", "properties": { "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated." }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "readOnly": true }, "duration": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The duration of the conversation." }, "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string", "format": "google-duration" }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "readOnly": true, "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}" }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo" }, "transcript": { "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "readOnly": true }, "runtimeAnnotations": { "readOnly": true, "type": "array", "description": "Output only. The annotations that were generated during the customer and agent interaction.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" } }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" }, "languageCode": { "type": "string", "description": "A user-specified language code for the conversation." }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the conversation was created." }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "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." }, "medium": { "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "type": "integer", "format": "int32" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "type": "object", "properties": { "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata", "description": "Metadata for creating an issue." }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "description": "The request to analyze conversations in bulk.", "properties": { "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent resource to create analyses in." }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "analysisPercentage": { "type": "number", "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "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" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from." }, "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "properties": { "deidentifyTemplate": { "type": "string", "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`" }, "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "properties": { "percentileTtsLatency": { "description": "The percentile result for TTS 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" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out 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" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "type": "object", "properties": { "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runSilenceAnnotator": { "type": "boolean", "description": "Whether to run the silence annotator." }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" }, "runAutoLabelingAnnotator": { "description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runEntityAnnotator": { "type": "boolean", "description": "Whether to run the entity annotator." }, "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.", "items": { "type": "string" }, "type": "array" }, "runIssueModelAnnotator": { "type": "boolean", "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect." }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" }, "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" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "description": "The conversation resource.", "properties": { "obfuscatedUserId": { "type": "string", "description": "Obfuscated user ID which the customer sent to us." }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "metadataJson": { "type": "string", "description": "Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats." }, "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." }, "medium": { "type": "string", "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." ] }, "turnCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. The number of turns in the conversation." }, "createTime": { "description": "Output only. The time at which the conversation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "transcript": { "readOnly": true, "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "runtimeAnnotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true, "type": "array" }, "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" }, "agentId": { "type": "string", "description": "An opaque, user-specified string representing the human agent who handled the conversation." }, "dialogflowIntents": { "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}" }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" }, "name": { "type": "string", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}" }, "duration": { "readOnly": true, "type": "string", "format": "google-duration", "description": "Output only. The duration of the conversation." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated." }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "latestAnalysis": { "readOnly": true, "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1Analysis" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse", "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { "type": "object", "properties": { "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score." }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" }, "potentialScore": { "type": "number", "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "sourceType": { "type": "string", "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." ] }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "type": "array" } }, "id": "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." }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData", "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher": { "properties": { "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" }, "revisionId": { "readOnly": true, "type": "string", "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" }, "versionTag": { "type": "string", "description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`." }, "type": { "description": "Required. The type of this phrase matcher.", "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rule groups or there is no match.", "If any of the phrase match rule groups are met, there is a match." ], "type": "string", "enum": [ "PHRASE_MATCHER_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ] }, "phraseMatchRuleGroups": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" }, "description": "A list of phase match rule groups that are included in this matcher." }, "activationUpdateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the activation status was updated." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the phrase matcher was updated." }, "revisionCreateTime": { "description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "roleMatch": { "description": "The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher", "description": "The phrase matcher resource." }, "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest": { "properties": {}, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest", "description": "The message to publish an assessment. Draft and appealed assessments can be published. Publishing simply changes the state of the assessment to published, allowing the console and authorized views to filter on the state." }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "properties": { "failedAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of failed analyses." }, "successfulAnalysisCount": { "type": "integer", "format": "int32", "description": "Count of successful analyses." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "properties": { "score": { "description": "Output only. Numerical score of the answer.", "readOnly": true, "type": "number", "format": "double" }, "strValue": { "description": "String value.", "type": "string" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`." }, "normalizedScore": { "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "readOnly": true, "type": "number", "format": "double" }, "potentialScore": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. The maximum potential score of the question." }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "numValue": { "description": "Numerical value.", "type": "number", "format": "double" }, "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.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "description": "Info for correlating across conversations.", "type": "object", "properties": { "correlationTypes": { "readOnly": true, "type": "array", "items": { "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "type": "string", "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] }, "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": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" }, "mergedFullConversationCorrelationId": { "readOnly": true, "type": "string", "description": "Output only. The full conversation correlation id this conversation is a merged conversation of." } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "properties": { "processedObjectCount": { "description": "The number of objects processed during the download operation.", "type": "integer", "format": "int32" }, "successfulDownloadCount": { "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", "type": "integer", "format": "int32" }, "totalFilesWritten": { "type": "integer", "format": "int32", "description": "Total number of files written to the provided Cloud Storage bucket." }, "fileNames": { "readOnly": true, "type": "array", "description": "Output only. Full name of the files written to Cloud storage.", "items": { "type": "string" } } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Statistics for BulkDownloadFeedbackLabels operation." }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "type": "object", "properties": { "endTime": { "description": "The time at which the analysis ended.", "type": "string", "format": "google-datetime" }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "description": "The result of an analysis." }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "sampledConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations sampled." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." }, "conversationCorrelationErrors": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "description": "A list of errors that occurred during correlation, one for each conversation that failed." }, "failedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed correlation." } } }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data.", "properties": { "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "type": "number", "format": "double", "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": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "properties": { "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p50": { "type": "number", "format": "double", "description": "The 50th percentile value." }, "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th." }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" }, "type": "array" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "description": "A message representing the transcript of a conversation." }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisOperation": { "readOnly": true, "type": "string", "description": "Output only. The operation name for a successfully created analysis operation, if any." }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "appliedRedactionConfig": { "readOnly": true, "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "description": "Agent Assist Smart Reply data.", "type": "object", "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).", "type": "number", "format": "double" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Map that contains metadata about the Smart Reply and the document from which it originates." }, "queryRecord": { "type": "string", "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}" }, "reply": { "description": "The content of the reply.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "properties": { "joinKeyResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" }, "description": "A list of join key correlation results for each conversation tested.", "type": "array" }, "constraintResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" }, "description": "A list of constraint evaluation results for each pair of conversations." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModel", "description": "The issue model resource.", "properties": { "displayName": { "type": "string", "description": "The representative name for the issue model." }, "modelType": { "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model.", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ] }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "readOnly": true, "type": "string", "format": "int64" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "readOnly": true }, "state": { "readOnly": true, "type": "string", "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "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" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse": { "properties": { "assessments": { "type": "array", "description": "The assessments that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse", "description": "The response of listing assessments." }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", "description": "The response to deploy an issue model." }, "GoogleProtobufEmpty": { "id": "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); }", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object", "properties": { "dataPoints": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series .", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "description": "The request to deploy an issue model.", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The issue model to deploy." } } }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "type": "object", "properties": { "normalizedScore": { "readOnly": true, "type": "number", "format": "double", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score." }, "naValue": { "type": "boolean", "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`." }, "strValue": { "type": "string", "description": "String value." }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "score": { "description": "Output only. Numerical score of the answer.", "readOnly": true, "type": "number", "format": "double" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "readOnly": true, "type": "number", "format": "double" }, "skipValue": { "readOnly": true, "type": "boolean", "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated." }, "numValue": { "description": "Numerical value.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question." }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "properties": { "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", "description": "A wrapper for holding the audio for any given turn.", "type": "object", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "type": "string", "format": "google-duration", "description": "The duration of the audio." } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "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.", "properties": { "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." }, "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "items": { "type": "string" }, "type": "array" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which the question tag was created." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "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": { "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": "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, "type": "string" }, "trainingConversationsCount": { "description": "Output only. Number of conversations used in training. Output only.", "readOnly": true, "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model." } }, "description": "", "servicePath": "", "resources": { "projects": { "resources": { "locations": { "methods": { "generativeInsights": { "parameterOrder": [ "location" ], "parameters": { "location": { "type": "string", "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.generativeInsights", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generativeInsights", "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "path": "v1alpha1/{+location}:generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "updateSettings": { "parameters": { "name": { "location": "path", "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/settings$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Required. The list of fields to be updated." } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.updateSettings", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates project-level settings.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" } }, "bulkDownloadFeedbackLabels": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The parent resource for new feedback labels.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "httpMethod": "POST" }, "getSettings": { "description": "Gets project-level settings.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "parameters": { "name": { "type": "string", "description": "Required. The name of the settings resource to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.getSettings", "httpMethod": "GET" }, "listAllFeedbackLabels": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List all feedback labels by project number.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of all feedback labels per project.", "required": true }, "pageToken": { "type": "string", "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." }, "pageSize": { "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32" }, "filter": { "type": "string", "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" } }, "parameterOrder": [ "parent" ] }, "updateCorrelationConfig": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates correlation config.", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. The list of fields to be updated." } } }, "bulkDeleteFeedbackLabels": { "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete feedback labels in bulk using a filter.", "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels" }, "queryMetrics": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "description": "Query metrics.", "path": "v1alpha1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "location" ], "parameters": { "location": { "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.queryMetrics", "httpMethod": "POST" }, "getCorrelationConfig": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "type": "string", "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "description": "Gets correlation config.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" } }, "queryPerformanceOverview": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "httpMethod": "POST", "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.", "path": "v1alpha1/{+parent}:queryPerformanceOverview", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "testCorrelationConfig": { "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "httpMethod": "POST", "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Tests correlation config on a conversation.", "path": "v1alpha1/{+location}:testCorrelationConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig" }, "getEncryptionSpec": { "description": "Gets location-level encryption key specification.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the encryption spec resource to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "httpMethod": "GET" }, "bulkUploadFeedbackLabels": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource for new feedback labels.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations." } }, "resources": { "conversations": { "methods": { "generateSignedAudio": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "description": "Gets the signed URI for the audio for the given conversation.", "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The name of the conversation to sign.", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "httpMethod": "GET" }, "sample": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.sample", "path": "v1alpha1/{+parent}/conversations:sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" } }, "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversation.", "required": true, "location": "path", "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-`" } }, "id": "contactcenterinsights.projects.locations.conversations.create", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "ingest": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource for new conversations.", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.ingest", "path": "v1alpha1/{+parent}/conversations:ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports conversations and processes them according to the user's configuration.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" } }, "list": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.list", "parameterOrder": [ "parent" ], "parameters": { "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" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "parent": { "description": "Required. The parent resource of the conversation.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "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." }, "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)." }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "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." ], "type": "string", "location": "query", "description": "The level of details of the conversation. Default is `BASIC`." } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists conversations." }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.conversations.delete", "parameters": { "name": { "location": "path", "description": "Required. The name of the conversation to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "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" } }, "parameterOrder": [ "name" ] }, "upload": { "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "path": "v1alpha1/{+parent}/conversations:upload", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "description": "Required. The parent resource of the conversation.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.upload", "httpMethod": "POST" }, "bulkDelete": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "path": "v1alpha1/{+parent}/conversations:bulkDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes multiple conversations in a single request.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "calculateStats": { "description": "Gets conversation statistics.", "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "parameters": { "location": { "type": "string", "location": "path", "description": "Required. The location of the conversations.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties." } }, "parameterOrder": [ "location" ], "id": "contactcenterinsights.projects.locations.conversations.calculateStats", "httpMethod": "GET" }, "patch": { "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.conversations.patch", "parameterOrder": [ "name" ], "parameters": { "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "description": "Optional. If set to true, the conversation will be updated with auto labeling results.", "location": "query", "type": "boolean" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "updateMask": { "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings`", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "type": "boolean", "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored.", "location": "query" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a conversation." }, "bulkAnalyze": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "description": "Analyzes multiple conversations in a single request.", "path": "v1alpha1/{+parent}/conversations:bulkAnalyze", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource to create analyses in.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "get": { "parameters": { "view": { "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "location": "query", "description": "The level of details of the conversation. Default is `FULL`.", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The name of the conversation to get.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.get", "httpMethod": "GET", "description": "Gets a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } } }, "resources": { "analyses": { "methods": { "get": { "description": "Gets an analysis.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the analysis to get.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "httpMethod": "GET" }, "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The parent resource of the analysis.", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "description": "Creates an analysis. The long running operation is done when the analysis has completed.", "path": "v1alpha1/{+parent}/analyses", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "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" }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the analyses.", "required": true, "location": "path", "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." } }, "id": "contactcenterinsights.projects.locations.conversations.analyses.list", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "description": "Lists analyses.", "path": "v1alpha1/{+parent}/analyses", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse" } }, "delete": { "id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "location": "path", "description": "Required. The name of the analysis to delete.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "description": "Deletes an analysis.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "assessments": { "methods": { "finalize": { "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to finalize.", "required": true, "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "description": "Finalize an Assessment.", "path": "v1alpha1/{+name}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "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." }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "location": "query", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "httpMethod": "GET", "description": "List Assessments.", "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" } }, "delete": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the assessment to delete.", "required": true }, "force": { "type": "boolean", "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "location": "query" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "description": "Delete an Assessment.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the assessment to get.", "required": true } }, "parameterOrder": [ "name" ] }, "appeal": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to appeal.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "path": "v1alpha1/{+name}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Appeal an Assessment.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" } }, "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Assessment.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.assessments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the assessment.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" } } }, "publish": { "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the assessment to publish.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "description": "Publish an Assessment.", "path": "v1alpha1/{+name}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } } }, "resources": { "notes": { "methods": { "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "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" }, "parent": { "type": "string", "location": "path", "description": "Required. The parent resource of the notes.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/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." } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "description": "List Notes.", "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" } }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "description": "Required. The name of the note to delete.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Note.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Create Note.", "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The parent resource of the note.", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ] }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`" } }, "parameterOrder": [ "name" ] } } } } }, "segments": { "methods": { "bulkAnalyze": { "path": "v1alpha1/{+parent}/segments:bulkAnalyze", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Analyzes multiple conversations in a single request.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource to create analyses in.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze" } } }, "feedbackLabels": { "methods": { "list": { "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "httpMethod": "GET", "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": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "description": "Required. The parent resource of the feedback labels.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "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." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels" }, "delete": { "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to delete.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Get feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the feedback label to get.", "required": true } } }, "create": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the feedback label.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels" }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" }, "updateMask": { "description": "Required. The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "httpMethod": "PATCH", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Update feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } } } } }, "operations": { "methods": { "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "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": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "contactcenterinsights.projects.locations.operations.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ] }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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`.", "path": "v1alpha1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string" } } }, "list": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.operations.list", "parameters": { "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations" } } }, "assessmentRules": { "methods": { "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "path": "v1alpha1/{+parent}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an assessment rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.assessmentRules.create", "parameters": { "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])?$`." }, "parent": { "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ] }, "patch": { "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "parameters": { "name": { "type": "string", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" }, "updateMask": { "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.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an assessment rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}" }, "get": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.assessmentRules.get", "parameters": { "name": { "type": "string", "description": "Required. The name of the assessment rule to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get an assessment rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the assessment rules.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "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" }, "pageSize": { "location": "query", "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.", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.assessmentRules.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "path": "v1alpha1/{+parent}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists assessment rules.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" } }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an assessment rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "description": "Required. The name of the assessment rule to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.assessmentRules.delete" } } }, "datasets": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "path": "v1alpha1/{+parent}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List datasets matching the input.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the dataset.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "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`", "location": "query", "type": "string" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.datasets.list" }, "delete": { "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.datasets.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The name of the dataset to delete.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete a dataset.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}" }, "bulkUploadFeedbackLabels": { "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "parameters": { "parent": { "location": "path", "description": "Required. The parent resource for new feedback labels.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels" }, "bulkDeleteFeedbackLabels": { "description": "Delete feedback labels in bulk using a filter.", "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "httpMethod": "POST" }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the dataset to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.datasets.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a dataset.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" } }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a dataset.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "required": true, "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. The list of fields to update.", "location": "query" } }, "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.datasets.patch" }, "listAllFeedbackLabels": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of all feedback labels per project.", "required": true }, "pageToken": { "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "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" } }, "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", "description": "List all feedback labels by project number.", "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" } }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource for new feedback labels.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the dataset.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "datasetId": { "description": "Optional. The ID to use for the dataset.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.create", "path": "v1alpha1/{+parent}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a dataset.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" } } }, "resources": { "insightsdata": { "methods": { "export": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "description": "Export insights data to a destination defined in the request body.", "path": "v1alpha1/{+parent}/insightsdata:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource to export data from.", "required": true, "location": "path", "type": "string" } } } } }, "conversations": { "methods": { "sample": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.conversations.sample", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the dataset.", "required": true } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "path": "v1alpha1/{+parent}/conversations:sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample" }, "bulkDelete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "path": "v1alpha1/{+parent}/conversations:bulkDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes multiple conversations in a single request.", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete" }, "calculateStats": { "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "httpMethod": "POST", "parameters": { "location": { "location": "path", "description": "Required. The location of the conversations.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "description": "Gets conversation statistics.", "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats" }, "get": { "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The name of the conversation to get.", "required": true, "location": "path" }, "view": { "type": "string", "description": "The level of details of the conversation. Default is `FULL`.", "location": "query", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "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." ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}" }, "ingest": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", "path": "v1alpha1/{+parent}/conversations:ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports conversations and processes them according to the user's configuration.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } } }, "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource of the conversation.", "required": true, "location": "path", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "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." }, "filter": { "type": "string", "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "pageToken": { "type": "string", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "location": "query" }, "orderBy": { "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).", "type": "string" }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "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." ], "type": "string", "location": "query", "description": "The level of details of the conversation. Default is `BASIC`." } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists conversations.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" } }, "delete": { "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "parameters": { "name": { "description": "Required. The name of the conversation to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" }, "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" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}" }, "generateSignedAudio": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "description": "Gets the signed URI for the audio for the given conversation.", "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the conversation to sign.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" } } } }, "resources": { "feedbackLabels": { "methods": { "create": { "description": "Create feedback label.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameters": { "feedbackLabelId": { "type": "string", "location": "query", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." }, "parent": { "type": "string", "description": "Required. The parent resource of the feedback label.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "httpMethod": "POST" }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "parameters": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" }, "updateMask": { "description": "Required. The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ] }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Get feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to get.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "name" ] }, "list": { "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", "httpMethod": "GET", "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the feedback labels.", "required": true }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "description": "Required. The name of the feedback label to delete.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete" } } } } } } }, "issueModels": { "methods": { "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "description": "Creates an issue model.", "path": "v1alpha1/{+parent}/issueModels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.issueModels.create", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the issue model.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "calculateIssueModelStats": { "path": "v1alpha1/{+issueModel}:calculateIssueModelStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an issue model's statistics.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "parameters": { "issueModel": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The resource name of the issue model to query against.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "issueModel" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats" }, "import": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels:import", "path": "v1alpha1/{+parent}/issueModels:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports an issue model from a Cloud Storage bucket.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.issueModels.import", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the issue model.", "required": true, "type": "string" } } }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "Gets an issue model.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "id": "contactcenterinsights.projects.locations.issueModels.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the issue model to get.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "parameterOrder": [ "name" ] }, "deploy": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.issueModels.deploy", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The issue model to deploy.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", "path": "v1alpha1/{+name}:deploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "export": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "path": "v1alpha1/{+name}:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports an issue model to the provided destination.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.issueModels.export", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The issue model to export.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } } }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an issue model.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.issueModels.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "location": "path", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "The list of fields to be updated.", "location": "query" } }, "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "description": "Lists issue models.", "path": "v1alpha1/{+parent}/issueModels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.issueModels.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the issue model.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an issue model.", "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.issueModels.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "description": "Required. The name of the issue model to delete.", "required": true, "location": "path" } } }, "undeploy": { "description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", "path": "v1alpha1/{+name}:undeploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "description": "Required. The issue model to undeploy.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "httpMethod": "POST" } }, "resources": { "issues": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "path": "v1alpha1/{+parent}/issues", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists issues.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the issue.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.issueModels.issues.list" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an issue.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "location": "path", "description": "Required. The name of the issue to delete.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.issueModels.issues.delete" }, "patch": { "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "required": true, "location": "path" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "The list of fields to be updated." } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an issue.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}" }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The parent resource of the issue.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "httpMethod": "POST", "description": "Creates an issue.", "path": "v1alpha1/{+parent}/issues", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "description": "Gets an issue.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "description": "Required. The name of the issue to get.", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "httpMethod": "GET" } } } } }, "analysisRules": { "methods": { "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get a analysis rule.", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.analysisRules.get", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the AnalysisRule to get.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$" } } }, "create": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.analysisRules.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a analysis rule." }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a analysis rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.analysisRules.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "required": true, "location": "path", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "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." } }, "parameterOrder": [ "name" ] }, "list": { "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the analysis rules.", "required": true, "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.analysisRules.list", "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists analysis rules.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" } }, "delete": { "id": "contactcenterinsights.projects.locations.analysisRules.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the analysis rule to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "description": "Deletes a analysis rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "views": { "methods": { "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "Creates a view.", "path": "v1alpha1/{+parent}/views", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "id": "contactcenterinsights.projects.locations.views.create", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ] }, "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a view.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "location": "path", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.views.patch" }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a view.", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.views.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the view to get.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$" } } }, "list": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "description": "Lists views.", "path": "v1alpha1/{+parent}/views", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.views.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "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.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the views.", "required": true, "type": "string" }, "pageToken": { "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", "type": "string" } } }, "delete": { "parameters": { "name": { "type": "string", "description": "Required. The name of the view to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.views.delete", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a view.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleProtobufEmpty" } } } }, "qaQuestionTags": { "methods": { "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "description": "Creates a QaQuestionTag.", "path": "v1alpha1/{+parent}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaQuestionTag.", "required": true, "location": "path", "type": "string" }, "qaQuestionTagId": { "type": "string", "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "location": "query" } }, "parameterOrder": [ "parent" ] }, "patch": { "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" }, "updateMask": { "type": "string", "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", "location": "query" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "description": "Updates a QaQuestionTag.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "contactcenterinsights.projects.locations.qaQuestionTags.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "location": "path", "description": "Required. The name of the QaQuestionTag to get.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "description": "Gets a QaQuestionTag.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a QaQuestionTag.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the QaQuestionTag to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" } }, "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestionTags.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions (ie. AND operators). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_id` - id of the scorecard to list tags for * `revision_id` - id of the scorecard revision to list tags for` * `qa_question_id - id of the question to list tags for`", "location": "query" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "path": "v1alpha1/{+parent}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the question tags." } } }, "authorizedViewSets": { "methods": { "create": { "description": "Create AuthorizedViewSet", "path": "v1alpha1/{+parent}/authorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "parameters": { "authorizedViewSetId": { "location": "query", "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent resource of the AuthorizedViewSet.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "httpMethod": "POST" }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "required": true, "location": "path" }, "updateMask": { "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: * `display_name`", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an AuthorizedViewSet.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "description": "Get AuthorizedViewSet", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the AuthorizedViewSet to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" } } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "description": "List AuthorizedViewSets", "path": "v1alpha1/{+parent}/authorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the AuthorizedViewSets.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "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.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data.", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. The order by expression to order authorized view sets listed in the response.", "location": "query" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "httpMethod": "GET" }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the AuthorizedViewSet to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "force": { "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.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an AuthorizedViewSet.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}" } }, "resources": { "authorizedViews": { "methods": { "setIamPolicy": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "httpMethod": "POST", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "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.", "required": true, "location": "path" } }, "parameterOrder": [ "resource" ], "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.", "path": "v1alpha1/{+resource}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy" }, "testIamPermissions": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "path": "v1alpha1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "location": "path", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions" }, "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.", "path": "v1alpha1/{+parent}:queryPerformanceOverview", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "httpMethod": "POST" }, "generativeInsights": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "path": "v1alpha1/{+location}:generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.generativeInsights", "httpMethod": "POST", "parameters": { "location": { "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "parameterOrder": [ "location" ] }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "description": "Create AuthorizedView", "path": "v1alpha1/{+parent}/authorizedViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the AuthorizedView.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "authorizedViewId": { "type": "string", "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "location": "query" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "httpMethod": "POST" }, "queryMetrics": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Query metrics.", "path": "v1alpha1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "httpMethod": "POST", "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true, "type": "string" } }, "parameterOrder": [ "location" ] }, "getIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1alpha1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "httpMethod": "GET", "parameters": { "resource": { "type": "string", "location": "path", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "resource" ] }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "path": "v1alpha1/{+parent}/authorizedViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List AuthorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "description": "Optional. The order by expression to order authorized views listed in the response.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "pageSize": { "type": "integer", "format": "int32", "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." }, "filter": { "location": "query", "description": "Optional. The filter expression to filter authorized views listed in the response.", "type": "string" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list" }, "search": { "parameters": { "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "required": true, "type": "string" }, "query": { "description": "Optional. The query expression to search authorized views.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "httpMethod": "GET", "description": "SearchAuthorizedViewSets", "path": "v1alpha1/{+parent}/authorizedViews:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" } }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the AuthorizedView to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "description": "Deletes an AuthorizedView.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "required": true, "location": "path" }, "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "httpMethod": "PATCH", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "description": "Updates an AuthorizedView.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The name of the AuthorizedView to get.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get AuthorizedView", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } } }, "resources": { "conversations": { "methods": { "calculateStats": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats", "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "location": "path", "description": "Required. The location of the conversations.", "required": true }, "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" } }, "parameterOrder": [ "location" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats" }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the conversation to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "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." ], "type": "string", "description": "The level of details of the conversation. Default is `FULL`.", "location": "query" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a conversation.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "description": "Lists conversations.", "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "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" }, "filter": { "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "description": "Required. The parent resource of the conversation.", "required": true, "location": "path" }, "pageToken": { "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", "type": "string" }, "orderBy": { "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).", "type": "string" }, "view": { "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "description": "The level of details of the conversation. Default is `BASIC`.", "location": "query", "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "httpMethod": "GET" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The name of the conversation to delete.", "required": true, "location": "path" }, "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" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete" }, "generateSignedAudio": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The name of the conversation to sign.", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "description": "Gets the signed URI for the audio for the given conversation.", "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" } } }, "resources": { "feedbackLabels": { "methods": { "create": { "parameterOrder": [ "parent" ], "parameters": { "feedbackLabelId": { "location": "query", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the feedback label.", "required": true } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create feedback label.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "patch": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update feedback label.", "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "location": "query" } } }, "get": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "description": "Required. The name of the feedback label to get.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "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": { "location": "query", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "required": true, "location": "path", "type": "string" }, "pageToken": { "location": "query", "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" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "description": "Required. The name of the feedback label to delete.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ] } } }, "assessments": { "methods": { "list": { "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List Assessments.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "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." }, "filter": { "type": "string", "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list" }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to delete.", "required": true, "type": "string" }, "force": { "type": "boolean", "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "location": "query" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "httpMethod": "DELETE", "description": "Delete an Assessment.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "response": { "$ref": "GoogleProtobufEmpty" } }, "finalize": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the assessment to finalize.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "description": "Finalize an Assessment.", "path": "v1alpha1/{+name}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the assessment to get.", "required": true } }, "parameterOrder": [ "name" ] }, "appeal": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the assessment to appeal.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Appeal an Assessment.", "path": "v1alpha1/{+name}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal" }, "create": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the assessment.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" } }, "parameterOrder": [ "parent" ] }, "publish": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "description": "Required. The name of the assessment to publish.", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "path": "v1alpha1/{+name}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Publish an Assessment." } }, "resources": { "notes": { "methods": { "list": { "parameters": { "parent": { "description": "Required. The parent resource of the notes.", "required": true, "location": "path", "type": "string", "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." }, "pageSize": { "type": "integer", "format": "int32", "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." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "httpMethod": "GET", "description": "List Notes.", "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" } }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "description": "Required. The name of the note to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Note.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}" }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the note.", "required": true } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Note.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "patch": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch", "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" }, "updateMask": { "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`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}" } } } } } } }, "operations": { "methods": { "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "parameterOrder": [ "name" ], "parameters": { "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" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } } }, "cancel": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get" } } } } } } }, "dashboards": { "methods": { "list": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.dashboards.list", "parameters": { "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", "description": "Optional. The filter expression to filter dashboards listed in the response.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the dashboards.", "required": true }, "pageToken": { "type": "string", "location": "query", "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." }, "orderBy": { "type": "string", "description": "Optional. The order by expression to order dashboards listed in the response.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "path": "v1alpha1/{+parent}/dashboards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Dashboards.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards" }, "delete": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Required. The name of the dashboard to delete.", "required": true, "location": "path" } }, "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.dashboards.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Dashboard.", "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the dashboard.", "required": true, "type": "string" }, "dashboardId": { "type": "string", "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" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.dashboards.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "path": "v1alpha1/{+parent}/dashboards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Dashboard.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "patch": { "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.dashboards.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "required": true, "location": "path" }, "updateMask": { "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", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Dashboard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}" }, "get": { "parameters": { "name": { "description": "Required. The name of the dashboard to get.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.dashboards.get", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a Dashboard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } } }, "resources": { "charts": { "methods": { "get": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "description": "Required. The name of the chart to get.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a Chart.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}" }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "path": "v1alpha1/{+parent}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Chart.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Required. The parent resource of the chart.", "required": true, "location": "path" }, "chartId": { "type": "string", "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])?$`.", "location": "query" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.dashboards.charts.create" }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "description": "Updates a Chart.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "location": "path", "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "required": true, "type": "string" }, "updateMask": { "type": "string", "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`" } } }, "list": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path", "description": "Required. The parent resource of the charts.", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.dashboards.charts.list", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "description": "Lists Charts.", "path": "v1alpha1/{+parent}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Chart.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "id": "contactcenterinsights.projects.locations.dashboards.charts.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the chart to delete.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$" } }, "parameterOrder": [ "name" ] } } } } }, "encryptionSpec": { "methods": { "initialize": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "path": "v1alpha1/{+name}:initialize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$" } } } } }, "phraseMatchers": { "methods": { "create": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "path": "v1alpha1/{+parent}/phraseMatchers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a phrase matcher." }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "required": true, "location": "path", "type": "string" }, "updateMask": { "location": "query", "description": "The list of fields to be updated.", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "httpMethod": "PATCH", "description": "Updates a phrase matcher.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "get": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the phrase matcher to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a phrase matcher." }, "list": { "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "httpMethod": "GET", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the phrase matcher.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "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." }, "pageSize": { "type": "integer", "format": "int32", "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." }, "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse" }, "description": "Lists phrase matchers.", "path": "v1alpha1/{+parent}/phraseMatchers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers" }, "delete": { "httpMethod": "DELETE", "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the phrase matcher to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a phrase matcher." } } }, "qaScorecards": { "methods": { "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaScorecard.", "required": true, "location": "path", "type": "string" }, "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" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "path": "v1alpha1/{+parent}/qaScorecards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a QaScorecard.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" } }, "patch": { "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "location": "path", "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$" }, "updateMask": { "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`", "location": "query" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Updates a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}" }, "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Gets a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "id": "contactcenterinsights.projects.locations.qaScorecards.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The name of the QaScorecard to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$" } }, "parameterOrder": [ "name" ] }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "description": "Deletes a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the QaScorecard to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$" }, "force": { "type": "boolean", "description": "Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "location": "query" } } }, "list": { "id": "contactcenterinsights.projects.locations.qaScorecards.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource of the scorecards.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.", "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "qaScorecardSources": { "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 of one or more sources.", "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." ], "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "repeated": true } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "description": "Lists QaScorecards.", "path": "v1alpha1/{+parent}/qaScorecards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "revisions": { "methods": { "tuneQaScorecardRevision": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Fine tune one or more QaModels.", "path": "v1alpha1/{+parent}:tuneQaScorecardRevision", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource for new fine tuning job instance.", "required": true } }, "parameterOrder": [ "parent" ] }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "path": "v1alpha1/{+parent}/revisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a QaScorecardRevision.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "description": "Required. The parent resource of the QaScorecardRevision.", "required": true, "location": "path" }, "qaScorecardRevisionId": { "type": "string", "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" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a QaScorecardRevision.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to get.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get" }, "deploy": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to deploy.", "required": true, "location": "path", "type": "string" } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "description": "Deploy a QaScorecardRevision.", "path": "v1alpha1/{+name}:deploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" } }, "undeploy": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the QaScorecardRevision to undeploy.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "path": "v1alpha1/{+name}:undeploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Undeploy a QaScorecardRevision.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy" }, "delete": { "description": "Deletes a QaScorecardRevision.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the QaScorecardRevision to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" }, "force": { "type": "boolean", "location": "query", "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." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", "httpMethod": "DELETE" }, "list": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "qaScorecardSources": { "description": "Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards Revisions from Scorecards of one or more sources.", "location": "query", "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." ], "repeated": true, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ] }, "pageSize": { "type": "integer", "format": "int32", "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." }, "filter": { "type": "string", "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character.", "required": true }, "pageToken": { "location": "query", "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.", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "description": "Lists all revisions under the parent QaScorecard.", "path": "v1alpha1/{+parent}/revisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "qaQuestions": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "description": "Deletes a QaQuestion.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "description": "Required. The name of the QaQuestion to delete.", "required": true, "location": "path", "type": "string" } } }, "list": { "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the questions.", "required": true }, "pageToken": { "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", "type": "string" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "path": "v1alpha1/{+parent}/qaQuestions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists QaQuestions." }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "location": "path", "description": "Required. The name of the QaQuestion to get.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "httpMethod": "GET", "description": "Gets a QaQuestion.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } }, "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "description": "Required. The parent resource of the QaQuestion.", "required": true, "location": "path" }, "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" } }, "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "path": "v1alpha1/{+parent}/qaQuestions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a QaQuestion.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } }, "patch": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$" }, "updateMask": { "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: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", "location": "query" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "description": "Updates a QaQuestion.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } }, "insightsdata": { "methods": { "export": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource to export data from.", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.insightsdata.export", "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "description": "Export insights data to a destination defined in the request body.", "path": "v1alpha1/{+parent}/insightsdata:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } } } }, "autoLabelingRules": { "methods": { "get": { "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "description": "Gets an auto labeling rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "location": "path", "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "required": true, "type": "string" } } }, "create": { "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "parameterOrder": [ "parent" ], "parameters": { "autoLabelingRuleId": { "type": "string", "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." }, "parent": { "type": "string", "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "path": "v1alpha1/{+parent}/autoLabelingRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an auto labeling rule." }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "location": "query" } }, "httpMethod": "PATCH", "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an auto labeling rule.", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } }, "test": { "description": "Tests auto labeling rules against a conversation.", "path": "v1alpha1/{+parent}/autoLabelingRules:test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "httpMethod": "POST" }, "list": { "path": "v1alpha1/{+parent}/autoLabelingRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists auto labeling rules.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}", "required": true, "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The next_page_token value returned from a previous List request, if any.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "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." } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "contactcenterinsights.projects.locations.autoLabelingRules.list" }, "delete": { "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "description": "Deletes an auto labeling rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "version": "v1alpha1", "id": "contactcenterinsights:v1alpha1", "ownerName": "Google", "ownerDomain": "google.com", "canonicalName": "Contactcenterinsights", "batchPath": "batch", "fullyEncodeReservedExpansion": true, "basePath": "" }