{ "description": "", "baseUrl": "https://contactcenterinsights.googleapis.com/", "fullyEncodeReservedExpansion": true, "protocol": "rest", "discoveryVersion": "v1", "parameters": { "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "type": "string", "location": "query", "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" ], "description": "Data format for response.", "default": "json" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "key": { "location": "query", "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." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 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." } } } }, "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "kind": "discovery#restDescription", "revision": "20260410", "name": "contactcenterinsights", "version": "v1alpha1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerDomain": "google.com", "schemas": { "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote": { "description": "A note about a conversation turn.", "type": "object", "properties": { "turnIndex": { "format": "int32", "description": "The conversation turn index that the note is associated with.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "readOnly": true }, "analysisOperation": { "readOnly": true, "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata" }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "type": "object", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "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" }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "text": { "description": "The text of this segment.", "type": "string" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" } }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" } } }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "description": "Information about the issue.", "type": "object", "properties": { "score": { "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueAssignment" }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "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" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" }, "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "description": "Default configuration when creating Analyses in Insights.", "type": "object", "properties": { "uploadConversationAnalysisPercentage": { "format": "double", "description": "Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].", "type": "number" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "runtimeIntegrationAnalysisPercentage": { "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", "description": "Metadata used for import issue model.", "type": "object", "properties": { "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1Assessment": { "id": "GoogleCloudContactcenterinsightsV1alpha1Assessment", "description": "The assessment resource.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", "type": "string" }, "createTime": { "description": "Output only. The time at which the assessment was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The time at which the assessment was last updated.", "type": "string", "format": "google-datetime" }, "state": { "readOnly": true, "enumDescriptions": [ "The state is unspecified. This value should not be used.", "The default state of all new assessments.", "The assessment has been published.", "The assessment has been appealed.", "The assessment has been finalized." ], "enum": [ "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED", "APPEALED", "FINALIZED" ], "type": "string", "description": "Output only. The state of the assessment." }, "agentInfo": { "description": "Information about the agent the assessment is for.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" } } }, "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": { "displayName": { "description": "The representative name for the entity.", "type": "string" }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ], "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "description": "The entity type.", "type": "string" }, "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1mainEntity" }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig": { "description": "Date range configuration for dashboard charts.", "type": "object", "properties": { "absoluteDateRange": { "description": "An absolute date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "relativeDateRange": { "description": "A relative date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "createTime": { "readOnly": true, "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": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote": { "description": "A note about a QA question.", "type": "object", "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination": { "description": "Google Sheets destination configuration.", "type": "object", "properties": { "sheet": { "description": "Optional. The sheet name.", "type": "string" }, "spreadsheetId": { "description": "Optional. An existing Google Sheets ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "description": "Response for an export insights operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issues": { "description": "All the matched issues.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } }, "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "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": { "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. Dataset update time.", "type": "string", "readOnly": true }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "type": { "description": "Dataset usage type.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] } } }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", "description": "Aggregated statistics about an issue.", "type": "object", "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": { "format": "int64", "description": "Number of conversations attached to the issue at this point in time.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" }, "GoogleCloudContactcenterinsightsV1alpha1UserInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "description": "Information about a user.", "type": "object", "properties": { "username": { "description": "The user's username.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for download.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "readOnly": true }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" }, "description": "The results for each applicable constraint rule.", "type": "array" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "description": "The result of an analysis.", "type": "object", "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" }, "endTime": { "description": "The time at which the analysis ended.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "description": "Request to upload a conversation.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata", "description": "Conversation metadata related to quality management.", "type": "object", "properties": { "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "type": "string", "format": "google-duration" }, "customerSatisfactionRating": { "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer" }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Input only. The feedback labels associated with the conversation.", "type": "array" }, "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata" }, "GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination": { "description": "Cloud Storage destination configuration.", "type": "object", "properties": { "uri": { "description": "Required. The Cloud Storage URI to export the results to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "description": "The response to an SampleConversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" } }, "unclassifiedConversationsCount": { "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string" }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "type": "object", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string", "readOnly": true }, "annotatorSelector": { "readOnly": true, "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" } }, "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "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": "GoogleCloudContactcenterinsightsV1mainDataset" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule" } }, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "properties": { "potentialScore": { "format": "double", "description": "Output only. The maximum potential score of the question.", "type": "number", "readOnly": true }, "skipValue": { "readOnly": true, "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "type": "boolean" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "normalizedScore": { "format": "double", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "readOnly": true }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "score": { "readOnly": true, "format": "double", "description": "Output only. Numerical score of the answer.", "type": "number" }, "strValue": { "description": "String value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "type": "object", "properties": { "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet": { "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Update time.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object", "properties": { "confidenceScore": { "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse", "description": "The response of listing assessments.", "type": "object", "properties": { "assessments": { "description": "The assessments that match the request.", "type": "array", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse", "description": "The response of listing notes.", "type": "object", "properties": { "notes": { "description": "The notes that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "type": "object", "properties": { "conversationDataOptions": { "description": "Options for configuring the conversation data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" }, "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`.", "type": "string", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ] }, "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": { "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "type": "array", "items": { "type": "string" } }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension.", "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "description": "The response of testing correlation config.", "type": "object", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse" }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "properties": { "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "correctnessLevel": { "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "type": "string" }, "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "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" }, "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse": { "description": "The response message for listing auto labeling rules.", "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" }, "autoLabelingRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "The auto labeling rules.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "GoogleCloudContactcenterinsightsV1alpha1RedirectAction": { "description": "The redirect action to be taken when the chart is clicked.", "type": "object", "properties": { "relativePath": { "description": "The relative path to redirect to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" }, "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig", "description": "Regex match configuration.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse", "description": "The response of listing assessment rules.", "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" }, "assessmentRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "The assessment rules that match the request.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "description": "Request to export an issue model.", "type": "object", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { "description": "The request to create an issue model.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" }, "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\").", "type": "string", "readOnly": true }, "sourceId": { "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "type": "object", "properties": { "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string", "readOnly": true }, "correlationTypes": { "items": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] }, "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "type": "array", "readOnly": true }, "mergedFullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "description": "Configs for the input data used to create the issue model.", "type": "object", "properties": { "trainingConversationsCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "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", "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`." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.", "type": "object", "properties": { "totalValidLabelCount": { "description": "Total number of valid labels provided for the question at the time of tuining.", "type": "string", "format": "int64" }, "datasetValidationWarnings": { "description": "A list of any applicable data validation warnings about the question's feedback labels.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified data validation warning.", "A non-trivial percentage of the feedback labels are invalid.", "The quantity of valid feedback labels provided is less than the recommended minimum.", "One or more of the answers have less than the recommended minimum of feedback labels.", "All the labels in the dataset come from a single answer choice." ], "enum": [ "DATASET_VALIDATION_WARNING_UNSPECIFIED", "TOO_MANY_INVALID_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" ] } }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest": { "description": "The request to undeploy a QaScorecardRevision", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "description": "The request to ingest conversations.", "type": "object", "properties": { "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "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": { "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": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "description": "The request for updating a QaQuestionTag.", "type": "object", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" }, "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" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag.", "type": "object", "properties": { "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" }, "tag": { "description": "Tag name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript.", "type": "object", "properties": { "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "endOffset": { "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination": { "description": "BigQuery destination configuration.", "type": "object", "properties": { "dataset": { "description": "Required. The name of the BigQuery dataset.", "type": "string" }, "table": { "description": "Required. The BigQuery table name.", "type": "string" }, "projectId": { "description": "Optional. A project ID or number.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination" }, "GoogleCloudContactcenterinsightsV1SherlockStep": { "description": "A step in the agent's reasoning process (Trajectory Step).", "type": "object", "properties": { "toolOutput": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "description": "Output only. The output response from the tool execution.", "type": "object" }, "thought": { "readOnly": true, "description": "Output only. The reasoning or internal monologue of the agent.", "type": "string" }, "toolCalls": { "description": "Output only. The tool call issued by the agent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ToolCall" }, "readOnly": true }, "textInput": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. Natural language input stimulus.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1SherlockStep" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata", "description": "The metadata for generative insights.", "type": "object", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "description": "A wrapper for system messages per turn.", "type": "object", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "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.", "type": "string", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension.", "type": "object", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata", "description": "The metadata for an IngestConversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "partialErrors": { "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "request": { "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "readOnly": true }, "sampledConversations": { "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization.", "type": "object", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "enumDeprecated": [ false, true, true ], "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "description": "Default summarization model to be used." }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } } }, "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).", "type": "object", "properties": { "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the settings was created.", "type": "string" }, "pubsubNotificationSettings": { "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}", "type": "object" }, "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" }, "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" }, "conversationTtl": { "format": "google-duration", "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" }, "updateTime": { "readOnly": true, "description": "Output only. The time at which the settings were last updated.", "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" }, "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" }, "diagnosticMetricConfig": { "description": "Optional. Configuration for diagnostic metrics.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig" }, "analysisConfig": { "description": "Default analysis settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "type": "object", "properties": { "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" } }, "intents": { "description": "All the matched intents in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" } }, "qaScorecardResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" }, "description": "Results of scoring QaScorecards.", "type": "array" }, "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "description": "All the entities in the call.", "type": "object" }, "phraseMatchers": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "description": "All the matched phrase matchers in the call.", "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "annotations": { "description": "A list of call annotations that apply to this call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" } }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" } } }, "GoogleCloudContactcenterinsightsV1mainDiagnosticReport": { "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "type": "object", "properties": { "intentStats": { "readOnly": true, "description": "Output only. A breakdown of metrics grouped by intent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats" } }, "lossPatterns": { "readOnly": true, "description": "Output only. A list of loss patterns identified for the entire project/dataset.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainLossPattern" } }, "metrics": { "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainMetricValue" }, "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "readOnly": true, "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "description": "A message representing the transcript of a conversation.", "type": "object", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" } } } }, "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.", "type": "object", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "description": "The metadata for an IngestConversations operation.", "type": "object", "properties": { "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.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true }, "ingestConversationsStats": { "readOnly": true, "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "type": "object", "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" } }, "constraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" }, "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "description": "A Cloud Storage source of conversation data.", "type": "object", "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainGcsSource" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage", "description": "The message in the conversation.", "type": "object", "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" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "systemMessage": { "description": "A message from the system in response to the user.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage" } } }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "description": "A Cloud Storage source of conversation data.", "type": "object", "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "type": "object", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "type": "object", "properties": { "textType": { "description": "The type of text output.", "type": "string", "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] }, "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "properties": { "potentialScore": { "readOnly": true, "description": "Output only. The maximum potential score of the question.", "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.", "type": "boolean", "readOnly": true }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "normalizedScore": { "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double", "readOnly": true }, "score": { "format": "double", "description": "Output only. Numerical score of the answer.", "type": "number", "readOnly": true }, "strValue": { "description": "String value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "type": "object", "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "format": "int32", "readOnly": true }, "failedSampleCount": { "readOnly": true, "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "properties": { "correctnessLevel": { "description": "The correctness level of an answer.", "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ] }, "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "description": "The conversation resource.", "type": "object", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "type": "string" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "readOnly": true, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "type": "object" }, "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" }, "medium": { "description": "Immutable. The conversation medium.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource" }, "runtimeAnnotations": { "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object" }, "createTime": { "readOnly": true, "description": "Output only. The time at which the conversation was created.", "type": "string", "format": "google-datetime" }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" }, "duration": { "description": "Output only. The duration of the conversation.", "type": "string", "format": "google-duration", "readOnly": true }, "metadataJson": { "description": "Input only. 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" }, "transcript": { "readOnly": true, "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "expireTime": { "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "startTime": { "format": "google-datetime", "description": "The time at which the conversation started.", "type": "string" }, "turnCount": { "readOnly": true, "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32" }, "latestAnalysis": { "readOnly": true, "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data.", "type": "object", "properties": { "confidenceScore": { "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": "number" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "type": "object", "properties": { "annotations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "description": "A list of call annotations that apply to this call.", "type": "array" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" }, "description": "All the entities in the call.", "type": "object" }, "phraseMatchers": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "description": "All the matched phrase matchers in the call.", "type": "object" }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" } }, "intents": { "description": "All the matched intents in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" } }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" } } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse", "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata", "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "description": "Conversation-level silence data.", "type": "object", "properties": { "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource": { "description": "Google Cloud Storage Object details to get the feedback label file from.", "type": "object", "properties": { "objectUri": { "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`", "type": "string" }, "format": { "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "description": "Required. File format which will be ingested.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource" }, "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.", "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Statistics for BulkDownloadFeedbackLabels operation.", "type": "object", "properties": { "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" }, "fileNames": { "description": "Output only. Full name of the files written to Cloud storage.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "totalFilesWritten": { "description": "Total number of files written to the provided Cloud Storage bucket.", "type": "integer", "format": "int32" }, "processedObjectCount": { "description": "The number of objects processed during the download operation.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart.", "type": "object", "properties": { "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.", "type": "string", "deprecated": true }, "generatedSqlQuery": { "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse", "description": "Response of querying an issue model's statistics.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "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.", "type": "object", "properties": { "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" }, "description": "The results for each applicable constraint rule.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "properties": { "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "createTime": { "format": "google-datetime", "description": "The time at which this annotation was created.", "type": "string" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1AnswerFeedback" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1FaqAnswerData" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" } }, "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult", "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" } } }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "type": "object", "properties": { "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "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" }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Create time of the label.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "properties": { "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" } }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" } }, "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" }, "qaAnswers": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" }, "description": "Set of QaAnswers represented in the result.", "type": "array" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "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.", "type": "string", "format": "google-datetime", "readOnly": true }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "description": "Call-specific metadata.", "type": "object", "properties": { "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" }, "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1Container": { "id": "GoogleCloudContactcenterinsightsV1alpha1Container", "description": "Configurable dashboard's container. Container can contain multiple widgets.", "type": "object", "properties": { "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "description": { "description": "Container description", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to all charts in the container.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "displayName": { "description": "User provided display name of the Container.", "type": "string" }, "containerId": { "readOnly": true, "description": "Output only. Unique ID for the container.", "type": "string" }, "widgets": { "description": "Widgets in the Container.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Widget" } }, "width": { "format": "int32", "description": "The width of the container in grid units.", "type": "integer" }, "height": { "description": "The height of the container in grid units.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse", "description": "The response from a ListQaScorecards request.", "type": "object", "properties": { "qaScorecards": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "The QaScorecards under the parent.", "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" } } }, "GoogleCloudCesV1mainMessage": { "id": "GoogleCloudCesV1mainMessage", "description": "A message within a conversation.", "type": "object", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "eventTime": { "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "type": "string", "format": "google-datetime" }, "chunks": { "items": { "$ref": "GoogleCloudCesV1mainChunk" }, "description": "Optional. Content of the message as a series of chunks.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher": { "description": "The phrase matcher resource.", "type": "object", "properties": { "revisionId": { "description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", "type": "string", "readOnly": true }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "string" }, "revisionCreateTime": { "description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", "type": "string", "format": "google-datetime", "readOnly": true }, "activationUpdateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the activation status was updated.", "type": "string", "readOnly": true }, "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.", "type": "string", "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ] }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "phraseMatchRuleGroups": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" }, "description": "A list of phase match rule groups that are included in this matcher.", "type": "array" }, "updateTime": { "description": "Output only. The most recent time at which the phrase matcher was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "versionTag": { "description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.", "type": "string" }, "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" }, "type": { "description": "Required. The type of this phrase matcher.", "type": "string", "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rule groups or there is no match.", "If any of the phrase match rule groups are met, there is a match." ], "enum": [ "PHRASE_MATCHER_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "description": "The CES diagnostic information.", "type": "object", "properties": { "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn.", "type": "array" }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } } }, "GoogleCloudCesV1mainToolResponse": { "id": "GoogleCloudCesV1mainToolResponse", "description": "The execution result of a specific tool from the client or the agent.", "type": "object", "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. Display name of the tool.", "type": "string" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object" }, "id": { "description": "Optional. The matching ID of the tool call the response is for.", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool that got executed.", "$ref": "GoogleCloudCesV1mainToolsetTool" } } }, "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "description": "Metadata about conversation labels.", "type": "object", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "description": "The data for a silence annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "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.", "type": "object", "properties": { "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" }, "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats": { "id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats", "description": "A breakdown of metrics grouped by intent.", "type": "object", "properties": { "intentDisplayName": { "readOnly": true, "description": "Output only. The display name of the intent.", "type": "string" }, "lossPatterns": { "readOnly": true, "description": "Output only. A list of loss patterns identified for this intent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainLossPattern" } }, "intentId": { "readOnly": true, "description": "Output only. The unique identifier for the intent (from Discovery Engine).", "type": "string" }, "metrics": { "readOnly": true, "type": "object", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainMetricValue" }, "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." }, "conversationCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of conversations associated with this intent.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse": { "description": "The response of listing issue models.", "type": "object", "properties": { "issueModels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "The issue models that match the request.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "description": "A BigQuery Table Reference.", "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": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" }, "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse": { "description": "The response of listing dashboards.", "type": "object", "properties": { "dashboards": { "description": "The dashboards under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "GoogleCloudContactcenterinsightsV1Analysis": { "id": "GoogleCloudContactcenterinsightsV1Analysis", "description": "The analysis resource.", "type": "object", "properties": { "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" }, "requestTime": { "readOnly": true, "description": "Output only. The time at which the analysis was requested.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string" }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio.", "type": "object", "properties": { "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" } } } }, "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest", "description": "The request to deploy a QaScorecardRevision", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "format": "int32", "description": "Maximum number of conversations to delete.", "type": "integer" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "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" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "GoogleRpcStatus": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "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" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } }, "id": "GoogleRpcStatus" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "description": "Conversation-level silence data.", "type": "object", "properties": { "silenceDuration": { "format": "google-duration", "description": "Amount of time calculated to be in silence.", "type": "string" }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "type": "number", "format": "float" } } }, "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": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", "description": "The response for querying performance overview.", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource", "description": "The entity whose performance is being queried is a single agent.", "type": "object", "properties": { "agentId": { "description": "Required. Agent id to query performance overview for.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "description": "Request to import an issue model.", "type": "object", "properties": { "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object" }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" }, "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "id": "GoogleCloudContactcenterinsightsV1alpha1Issue", "description": "The issue resource.", "type": "object", "properties": { "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this issue was created.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated.", "type": "string", "readOnly": true }, "sampleUtterances": { "readOnly": true, "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "description": "Wrapper for storing the generative response for a chart.", "type": "object", "properties": { "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "type": "object" }, "generatedSqlQuery": { "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource.", "type": "string" }, "textMessage": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "textOutput": { "deprecated": true, "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { "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": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "description": "The result of an analysis.", "type": "object", "properties": { "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" }, "endTime": { "description": "The time at which the analysis ended.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListDiagnosticsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListDiagnosticsResponse", "description": "The response from a ListDiagnostics request.", "type": "object", "properties": { "diagnostics": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Diagnostic" }, "description": "Optional. The diagnostics that match the request.", "type": "array" }, "nextPageToken": { "description": "Optional. 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" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest", "description": "The request for querying metrics.", "type": "object", "properties": { "timeGranularity": { "enum": [ "TIME_GRANULARITY_UNSPECIFIED", "NONE", "DAILY", "HOURLY", "PER_MINUTE", "PER_5_MINUTES", "MONTHLY" ], "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)." ], "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "type": "string" }, "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" }, "measureMask": { "format": "google-fieldmask", "description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\".", "type": "string" }, "filter": { "description": "Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). ", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIssue": { "description": "The issue resource.", "type": "object", "properties": { "displayName": { "description": "The representative name for the issue.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this issue was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime" }, "sampleUtterances": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array" }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssue" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse", "description": "The response for querying metrics.", "type": "object", "properties": { "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "slices": { "items": { "$ref": "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.", "type": "array" }, "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "properties": { "request": { "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "readOnly": true }, "sampledConversations": { "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true }, "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata" }, "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": { "conversationFilter": { "description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "annotatorSelector": { "description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this analysis rule was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which this analysis rule was updated.", "type": "string" }, "displayName": { "description": "Display Name of the analysis rule.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata", "description": "Metadata for creating an issue.", "type": "object", "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest", "description": "Request to import an issue model.", "type": "object", "properties": { "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "type": "object", "properties": { "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" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "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" }, "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" }, "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" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "properties": { "request": { "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "readOnly": true }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "description": "Metadata about the client sentiment category dimension.", "type": "object", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "type": "object", "properties": { "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The create time of the conversation.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The update time of the conversation.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport": { "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "type": "object", "properties": { "intentStats": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats" }, "description": "Output only. A breakdown of metrics grouped by intent.", "type": "array", "readOnly": true }, "lossPatterns": { "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPattern" }, "description": "Output only. A list of loss patterns identified for the entire project/dataset.", "type": "array" }, "metrics": { "type": "object", "readOnly": true, "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricValue" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "request": { "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "channelTag": { "format": "int32", "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", "type": "integer" }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "text": { "description": "The text of this segment.", "type": "string" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" } }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" } } }, "GoogleCloudContactcenterinsightsV1EntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "properties": { "type": { "description": "The type of the entity mention.", "type": "string", "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ] }, "entityUniqueId": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" }, "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1EntityMentionData" }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "description": "An answer to a QaQuestion.", "type": "object", "properties": { "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" } } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "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.", "type": "object", "properties": { "alternateIds": { "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "name": { "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "createTime": { "format": "google-datetime", "description": "Output only. The timestamp that the revision was created.", "type": "string", "readOnly": true }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EDITABLE", "TRAINING", "TRAINING_FAILED", "READY", "DELETING", "TRAINING_CANCELLED" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "The scorecard revision can be edited.", "Scorecard model training is in progress.", "Scorecard revision model training failed.", "The revision can be used in analysis.", "Scorecard is being deleted.", "Scorecard model training was explicitly cancelled by the user." ], "description": "Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "properties": { "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" }, "failedAnalysisCount": { "description": "Count of failed analyses.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "type": "object", "properties": { "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated.", "type": "string" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation", "description": "The conversation used to generate the chart.", "type": "object", "properties": { "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "description": "The create time of the conversation.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "The update time of the conversation.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "properties": { "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "bucketObjectType": { "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "type": "string" }, "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": { "items": { "type": "string" }, "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1HoldData": { "id": "GoogleCloudContactcenterinsightsV1HoldData", "description": "The data for a hold annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "correlatedConversationsCount": { "format": "int32", "description": "The number of conversations correlated.", "type": "integer" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" } } }, "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.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which the authorized view was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the authorized view was updated.", "type": "string" }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" }, "conversationFilter": { "description": "A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.", "type": "string" } } }, "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": { "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "description": "Query source for the answer.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ToolCall": { "id": "GoogleCloudContactcenterinsightsV1alpha1ToolCall", "description": "A tool call from the agent.", "type": "object", "properties": { "toolName": { "readOnly": true, "description": "Output only. The name of the tool being called.", "type": "string" }, "input": { "description": "Output only. The input arguments to the tool.", "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1mainToolCall": { "id": "GoogleCloudContactcenterinsightsV1mainToolCall", "description": "A tool call from the agent.", "type": "object", "properties": { "toolName": { "description": "Output only. The name of the tool being called.", "type": "string", "readOnly": true }, "input": { "description": "Output only. The input arguments to the tool.", "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse": { "description": "The response of listing views.", "type": "object", "properties": { "analysisRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "The analysis_rule that match the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "maxDownloadCount": { "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer", "format": "int32" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" }, "feedbackLabelType": { "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ] }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "templateQaScorecardId": { "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", "items": { "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" }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination": { "id": "GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination", "description": "BigQuery destination configuration.", "type": "object", "properties": { "projectId": { "description": "Optional. A project ID or number.", "type": "string" }, "dataset": { "description": "Required. The name of the BigQuery dataset.", "type": "string" }, "table": { "description": "Required. The BigQuery table name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" } }, "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "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.", "type": "object", "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" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" }, "sourceType": { "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "description": "What created the score.", "type": "string" } } }, "GoogleIamV1TestIamPermissionsResponse": { "id": "GoogleIamV1TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "description": "Metadata used for export issue model.", "type": "object", "properties": { "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "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.", "type": "object", "properties": { "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" }, "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" } } }, "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": { "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" }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "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. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object", "properties": { "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object" }, "confidenceScore": { "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata", "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" } } }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The data for a sentiment annotation.", "type": "object", "properties": { "score": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number", "format": "float" }, "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number", "format": "float" } } }, "GoogleCloudContactcenterinsightsV1alpha1Dimension": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dimension", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", "type": "object", "properties": { "labelDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" }, "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "readOnly": true }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "readOnly": true }, "mediumDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata" }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "readOnly": true }, "dimensionKey": { "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "description": "The key of the dimension.", "type": "string" }, "agentDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" } } }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "description": "The result of an analysis.", "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" }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse": { "description": "The response from a GenerateConversationSignedAudio request.", "type": "object", "properties": { "signedAudioUris": { "description": "The signed uris for the audio.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "GoogleCloudContactcenterinsightsV1alpha1Note": { "description": "The conversation assessment note resource.", "type": "object", "properties": { "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote" }, "noteCreator": { "readOnly": true, "description": "Output only. The user that created the note.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UserInfo" }, "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which the note was created.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the note was last updated.", "type": "string" }, "conversationTurnNote": { "description": "The note is associated with a conversation turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "content": { "description": "The note content.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "GoogleCloudContactcenterinsightsV1Intent": { "id": "GoogleCloudContactcenterinsightsV1Intent", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "type": "object", "properties": { "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "The feedback labels that match the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "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" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", "description": "Response from import issue model", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsMetadata": { "description": "Metadata for a DiagnoseConversations operation.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The request that created the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest" }, "diagnosticReport": { "description": "Output only. The diagnostic report containing metrics and intent breakdowns.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", "readOnly": true }, "partialTrajectories": { "deprecated": true, "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", "readOnly": true, "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialTrajectorySteps": { "readOnly": true, "description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep" } }, "latestStep": { "description": "Output only. The most recent thought or action from the agent.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep", "readOnly": true }, "fullReport": { "readOnly": true, "description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", "type": "boolean" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "metricType": { "type": "string", "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "description": "Output only. The type of metric being diagnosed." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsMetadata" }, "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" }, "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" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "createTime": { "description": "Output only. Create time of the label.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "type": "object", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "format": "double", "description": "The score the tag applies to.", "type": "number" }, "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object", "properties": { "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "format": { "description": "Required. File format in which the labels will be exported.", "type": "string", "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ] }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "analysisOperation": { "readOnly": true, "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string" }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" }, "appliedRedactionConfig": { "readOnly": true, "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" } } }, "GoogleCloudContactcenterinsightsV1GcsSource": { "id": "GoogleCloudContactcenterinsightsV1GcsSource", "description": "A Cloud Storage source of conversation data.", "type": "object", "properties": { "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination", "description": "Cloud Storage destination configuration.", "type": "object", "properties": { "uri": { "description": "Required. The Cloud Storage URI to export the results to.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote": { "id": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote", "description": "A note about the entire parent assessment.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest", "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "type": "object", "properties": { "fullReport": { "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", "type": "boolean" }, "maxSteps": { "format": "int32", "description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", "type": "integer" }, "requestId": { "description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" }, "dryRun": { "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", "type": "boolean" }, "taskQuery": { "description": "Optional. A natural language description of the analysis goal or question.", "type": "string" }, "metricType": { "description": "Optional. The type of metric being diagnosed.", "type": "string", "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ] }, "filter": { "description": "Optional. AIP-160 compliant filter for selecting target conversations.", "type": "string" }, "instructions": { "description": "Optional. Specific instructions for the agent.", "type": "string" }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", "type": "string" }, "outputConfig": { "description": "Optional. The configuration for the output of the task.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfig" }, "validateOnly": { "description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "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" }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "maxDownloadCount": { "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "feedbackLabelType": { "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string", "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ] }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "templateQaScorecardId": { "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", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata", "description": "The metadata for querying performance overview.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "type": "integer", "format": "int32" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true }, "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" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "description": "The response to an IngestConversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "type": "object", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" } } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "properties": { "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "type": "object", "properties": { "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1mainSherlockStep": { "id": "GoogleCloudContactcenterinsightsV1mainSherlockStep", "description": "A step in the agent's reasoning process (Trajectory Step).", "type": "object", "properties": { "thought": { "readOnly": true, "description": "Output only. The reasoning or internal monologue of the agent.", "type": "string" }, "toolCalls": { "description": "Output only. The tool call issued by the agent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainToolCall" }, "readOnly": true }, "textInput": { "description": "Output only. Natural language input stimulus.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "toolOutput": { "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. The output response from the tool execution.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations.", "type": "object", "properties": { "conversationTotalCustomerMessageCount": { "format": "int32", "description": "The customer message count.", "type": "integer" }, "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" }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "type": "number", "format": "double" }, "averageAgentSentimentScore": { "format": "float", "description": "The average agent's sentiment score.", "type": "number" }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "format": "double", "description": "Average latency of dialogflow webhook calls.", "type": "number" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "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" }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "conversationCount": { "description": "The conversation count.", "type": "integer", "format": "int32" }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "conversationTotalAgentMessageCount": { "format": "int32", "description": "The agent message count.", "type": "integer" }, "knowledgeAssistUriClickRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "knowledgeAssistResultCount": { "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number", "format": "double" }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "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" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number" }, "knowledgeSearchSuggestedQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number" }, "aiCoachSuggestionAgentUsageRatio": { "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number" }, "averageCustomerSatisfactionRating": { "format": "double", "description": "The average customer satisfaction rating.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "averageQaQuestionNormalizedScore": { "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.", "type": "number" }, "averageDuration": { "format": "google-duration", "description": "The average duration.", "type": "string" }, "averageTurnCount": { "format": "float", "description": "The average turn count.", "type": "number" }, "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" }, "dialogflowInteractionsNoMatchRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "conversationAiCoachSuggestionCount": { "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer" }, "summarizationSuggestionEditRatio": { "format": "double", "description": "Proportion of summarization suggestions that were manually edited.", "type": "number" }, "aaSupervisorAssignedConversationsCount": { "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "conversationalAgentsAverageLlmCallLatency": { "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "qaTagScores": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags.", "type": "array" }, "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" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "description": "Dialogflow interaction data.", "type": "object", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "type": "object", "properties": { "ruleResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule.", "type": "array" }, "conversation": { "description": "The conversation resource name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination": { "description": "Google Sheets destination configuration.", "type": "object", "properties": { "spreadsheetId": { "description": "Optional. An existing Google Sheets ID.", "type": "string" }, "sheet": { "description": "Optional. The sheet name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "description": "Metadata for creating an issue.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "description": "The response to an IngestConversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "type": "object", "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" } }, "constraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" }, "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModel", "description": "The issue model resource.", "type": "object", "properties": { "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "type": "string", "format": "int64", "readOnly": true }, "languageCode": { "description": "Language of the model.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string", "readOnly": true }, "state": { "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "type": "string" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "trainingStats": { "readOnly": true, "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" }, "modelType": { "description": "Type of the model.", "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ] }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "type": "object", "properties": { "percentileTtsLatency": { "description": "The percentile result for TTS 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" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat 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" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1InterruptionData" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "type": "object", "properties": { "fullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string" }, "correlationTypes": { "readOnly": true, "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "type": "array", "items": { "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "type": "string" } }, "mergedFullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "description": "Response from export issue model", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "properties": { "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "agentInfo": { "description": "Information about agents involved in the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" } }, "waitDuration": { "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent.", "type": "string" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse", "description": "The response of listing phrase matchers.", "type": "object", "properties": { "phraseMatchers": { "description": "The phrase matchers that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1SilenceData": { "id": "GoogleCloudContactcenterinsightsV1SilenceData", "description": "The data for a silence annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data.", "type": "object", "properties": { "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "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": "number" } } }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object", "properties": { "confidenceScore": { "format": "float", "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object" } } }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" } }, "id": "GoogleLongrunningOperation" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion", "description": "A single question to be scored by the Insights QA feature.", "type": "object", "properties": { "predefinedQuestionConfig": { "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" }, "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" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the question was updated.", "type": "string", "format": "google-datetime" }, "questionType": { "description": "The type of question.", "type": "string", "enumDescriptions": [ "The type of the question is unspecified.", "The default question type. The question is fully customizable by the user.", "The question type is using a predefined model provided by CCAI teams. Users are not allowed to edit the question_body, answer_choices, upload feedback labels for the question nor fine-tune the question. However, users may edit other fields like question tags, question order, etc." ], "enum": [ "QA_QUESTION_TYPE_UNSPECIFIED", "CUSTOMIZABLE", "PREDEFINED" ] }, "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" }, "answerInstructions": { "description": "Instructions describing how to determine the answer.", "type": "string" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this question was created.", "type": "string", "format": "google-datetime" }, "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" }, "order": { "description": "Defines the order of the question within its parent scorecard revision.", "type": "integer", "format": "int32" }, "tags": { "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question.", "type": "array", "items": { "type": "string" } }, "answerChoices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" }, "description": "A list of valid answers to the question, which the LLM must choose from.", "type": "array" }, "name": { "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "type": "object", "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" } } } }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "description": "Word-level info for words in a transcript.", "type": "object", "properties": { "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "startOffset": { "format": "google-duration", "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string" }, "endOffset": { "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "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" }, "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": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" }, "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": { "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest", "description": "Request for TuneQaScorecardRevision endpoint.", "type": "object", "properties": { "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" }, "correlatedConversationsCount": { "format": "int32", "description": "The number of conversations correlated.", "type": "integer" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } } } }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "description": "The request to deploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "description": "A time series representing conversations over time.", "type": "object", "properties": { "intervalDuration": { "description": "The duration of each interval.", "type": "string", "format": "google-duration" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "properties": { "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" }, "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse" }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "description": "The call participant speaking for a given utterance.", "type": "object", "properties": { "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "role": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The role of the participant.", "type": "string" }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string", "deprecated": true } }, "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant" }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment", "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" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string", "readOnly": true }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "description": "The request to deploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "description": "Information about an agent involved in the conversation.", "type": "object", "properties": { "location": { "description": "The agent's location.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "teams": { "items": { "type": "string" }, "description": "User-specified strings representing the agent's teams.", "type": "array" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "team": { "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "type": "string" }, "agentType": { "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "properties": { "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" } }, "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" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "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.", "type": "string", "format": "google-datetime", "readOnly": true }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" }, "qaAnswers": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" }, "description": "Set of QaAnswers represented in the result.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1IssueModel": { "id": "GoogleCloudContactcenterinsightsV1IssueModel", "description": "The issue model resource.", "type": "object", "properties": { "trainingStats": { "readOnly": true, "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats" }, "modelType": { "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model.", "type": "string" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated.", "type": "string" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "issueCount": { "format": "int64", "description": "Output only. Number of issues in this issue model.", "type": "string", "readOnly": true }, "languageCode": { "description": "Language of the model.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "state": { "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "type": "string" } } }, "GoogleCloudContactcenterinsightsV1Issue": { "description": "The issue resource.", "type": "object", "properties": { "displayName": { "description": "The representative name for the issue.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue was created.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime" }, "sampleUtterances": { "readOnly": true, "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" } }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Issue" }, "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.", "type": "object", "properties": { "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" }, "name": { "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which the question tag was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the question tag was updated.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest", "description": "The message to appeal an assessment.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation", "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "properties": { "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object", "properties": { "textType": { "description": "The type of the text message.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] }, "text": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup": { "description": "A message representing a rule in the phrase matcher.", "type": "object", "properties": { "phraseMatchRules": { "description": "A list of phrase match rules that are included in this group.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" } }, "type": { "description": "Required. The type of this phrase match rule group.", "type": "string", "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rules or there is no match.", "If any of the phrase match rules are met, there is a match." ], "enum": [ "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "Google Sheets document details to write the feedback labels to.", "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. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "description": "Call-specific metadata.", "type": "object", "properties": { "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" }, "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse", "description": "The response from a ListQaQuestionTags request.", "type": "object", "properties": { "qaQuestionTags": { "description": "The parent resource of the questions.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "type": "object", "properties": { "medium": { "description": "Required. The medium transcript objects represent.", "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig": { "description": "A list of correlation rules for a given correlation type.", "type": "object", "properties": { "correlationRules": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" }, "description": "A list of correlation rules to be evaluated for correlation.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" }, "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": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse": { "description": "The response to list datasets.", "type": "object", "properties": { "datasets": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "description": "The datasets that match the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "description": "Response from import issue model", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { "description": "Call-specific metadata.", "type": "object", "properties": { "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" }, "customerChannel": { "format": "int32", "description": "The audio channel that contains the customer.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "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" }, "members": { "items": { "type": "string" }, "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`.", "type": "array" }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "id": "GoogleIamV1Binding" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "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" }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "properties": { "agentId": { "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" }, "agentChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "customerChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model.", "type": "object", "properties": { "trainingConversationsCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "medium": { "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "deprecated": true, "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" ] } } }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData" }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData" }, "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}", "type": "string", "deprecated": true }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "role": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The role of the participant.", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "description": "The response to an SampleConversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata" }, "GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse", "description": "The response from a DiagnoseConversations request.", "type": "object", "properties": { "fullTrajectories": { "readOnly": true, "items": { "type": "string" }, "type": "array", "deprecated": true, "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory)." }, "fullTrajectorySteps": { "readOnly": true, "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1SherlockStep" } }, "answer": { "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", "type": "string", "readOnly": true }, "exportUri": { "readOnly": true, "description": "Output only. If an external destination was requested, the URI of the exported data.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "properties": { "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "customMetadataKeys": { "items": { "type": "string" }, "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "type": "array" }, "bucketObjectType": { "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "type": "string" }, "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" }, "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": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" }, "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)", "type": "object", "properties": { "displayName": { "description": "Display name for the dataaset", "type": "string" }, "ttl": { "format": "google-duration", "description": "Optional. Option TTL for the dataset.", "type": "string" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "description": "Output only. Dataset create time.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. Dataset update time.", "type": "string", "format": "google-datetime", "readOnly": true }, "type": { "description": "Dataset usage type.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "GoogleCloudContactcenterinsightsV1ToolCall": { "id": "GoogleCloudContactcenterinsightsV1ToolCall", "description": "A tool call from the agent.", "type": "object", "properties": { "toolName": { "readOnly": true, "description": "Output only. The name of the tool being called.", "type": "string" }, "input": { "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. The input arguments to the tool.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData", "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" }, "reply": { "description": "The content of the reply.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", "description": "Response from import issue model", "type": "object", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "description": "The request to export insights.", "type": "object", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" }, "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "exportSchemaVersion": { "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "description": "Optional. Version of the export schema.", "type": "string" }, "writeDisposition": { "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "description": "Options for what to do if the destination table already exists.", "type": "string" } } }, "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": { "description": "Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`", "type": "string" } }, "id": "GoogleCloudCesV1mainToolsetTool" }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata", "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "readOnly": true } } }, "GoogleIamV1Policy": { "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/).", "type": "object", "properties": { "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array", "items": { "$ref": "GoogleIamV1Binding" } }, "auditConfigs": { "items": { "$ref": "GoogleIamV1AuditConfig" }, "description": "Specifies cloud audit logging configuration for this policy.", "type": "array" }, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "etag": { "format": "byte", "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" } } }, "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": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "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" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "id": "GoogleTypeExpr" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "Google Sheets document details to write the feedback labels to.", "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. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "description": "The request for deleting a QaQuestionTag.", "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "description": "An error that occurred during correlation for a specific conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse": { "description": "The response from a DiagnoseConversations request.", "type": "object", "properties": { "fullTrajectories": { "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", "deprecated": true, "items": { "type": "string" }, "type": "array", "readOnly": true }, "answer": { "readOnly": true, "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", "type": "string" }, "exportUri": { "readOnly": true, "description": "Output only. If an external destination was requested, the URI of the exported data.", "type": "string" }, "fullTrajectorySteps": { "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep" }, "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse" }, "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.", "type": "object", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "description": "Metadata about the Conversational Agents tool dimension.", "type": "object", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse", "description": "The response for querying performance overview.", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest", "description": "The request for generative insights.", "type": "object", "properties": { "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" }, "sessionId": { "description": "Optional. The session id of the conversation. If the session id is not specified, backend will generate a random session id. If the session id is specified, will associate user-provided user_query with the provided session id.", "type": "string" }, "chart": { "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.", "type": "object" }, "sqlQuery": { "description": "Optional. The SQL query specified by the user. This query must be in BigQuery SQL dialect. The `filter` field will also be ignored, as it is assumed that any filtering is already included in the SQL query.", "type": "string" }, "filter": { "description": "Filter for the data that can be specified in addition to the natural language query. Users are encouraged to use this field to populate time-windows.", "type": "string" }, "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" }, "naturalLanguageQuery": { "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored.", "type": "string" }, "comparisonFilter": { "description": "Optional. Filter for the data that can be specified in addition to the natural language query. This `filter` is specifically used for charts where comparisons are possible. For example, \"compare to last month\" or \"compare to previous quarter\".", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { "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" }, "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" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDeploymentDisplayName": { "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "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" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "duplicatesSkippedCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32", "readOnly": true }, "processedObjectCount": { "format": "int32", "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "readOnly": true }, "failedIngestCount": { "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "description": "The issue model resource.", "type": "object", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated.", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "readOnly": true }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "state": { "description": "Output only. State of the model.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ] }, "issueCount": { "format": "int64", "description": "Output only. Number of issues in this issue model.", "type": "string", "readOnly": true }, "languageCode": { "description": "Language of the model.", "type": "string" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "description": "The request to create an issue.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "properties": { "customerChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "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": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "description": "Agent Assist Smart Reply data.", "type": "object", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object" }, "confidenceScore": { "format": "double", "description": "The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1SherlockStep": { "id": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep", "description": "A step in the agent's reasoning process (Trajectory Step).", "type": "object", "properties": { "toolOutput": { "description": "Output only. The output response from the tool execution.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true }, "thought": { "description": "Output only. The reasoning or internal monologue of the agent.", "type": "string", "readOnly": true }, "toolCalls": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ToolCall" }, "description": "Output only. The tool call issued by the agent.", "type": "array", "readOnly": true }, "textInput": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. Natural language input stimulus.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "type": "object", "properties": { "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" }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM 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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse", "description": "The response for calculating conversation statistics.", "type": "object", "properties": { "conversationCount": { "description": "The total number of conversations.", "type": "integer", "format": "int32" }, "issueMatches": { "deprecated": true, "additionalProperties": { "type": "integer", "format": "int32" }, "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "type": "object" }, "customHighlighterMatches": { "additionalProperties": { "type": "integer", "format": "int32" }, "description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", "type": "object" }, "smartHighlighterMatches": { "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } }, "averageDuration": { "description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration.", "type": "string", "format": "google-duration" }, "averageTurnCount": { "format": "int32", "description": "The average number of turns per conversation.", "type": "integer" }, "conversationCountTimeSeries": { "description": "A time series representing the count of conversations created over time that match that requested filter criteria.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries" }, "issueMatchesStats": { "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/`", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" } } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "feedbackLabelType": { "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ] }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "templateQaScorecardId": { "items": { "type": "string" }, "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse", "description": "The response of listing issues.", "type": "object", "properties": { "issues": { "description": "The issues that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } } } }, "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": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse": { "description": "The response from a DiagnoseConversations request.", "type": "object", "properties": { "answer": { "readOnly": true, "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", "type": "string" }, "exportUri": { "description": "Output only. If an external destination was requested, the URI of the exported data.", "type": "string", "readOnly": true }, "fullTrajectorySteps": { "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep" }, "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", "type": "array" }, "fullTrajectories": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", "deprecated": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse" }, "GoogleCloudCesV1mainAgentTransfer": { "id": "GoogleCloudCesV1mainAgentTransfer", "description": "Represents an event indicating the transfer of a conversation to a different agent.", "type": "object", "properties": { "targetAgent": { "description": "Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "displayName": { "description": "Output only. Display name of the agent.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse": { "description": "The response of listing views.", "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" }, "views": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "The views that match the request.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "type": "object", "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "format": "int32", "readOnly": true }, "failedSampleCount": { "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" }, "GoogleCloudContactcenterinsightsV1MetricValue": { "description": "Deprecated: MetricValue is no longer used for diagnostics.", "deprecated": true, "type": "object", "properties": { "sourceId": { "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "type": "string", "readOnly": true }, "hitCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of positive matches (hits) for this metric.", "type": "integer" }, "value": { "readOnly": true, "format": "double", "description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", "type": "number" }, "conversations": { "readOnly": true, "description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", "type": "array", "items": { "type": "string" } }, "totalCount": { "format": "int32", "description": "Output only. The total number of items evaluated for this metric.", "type": "integer", "readOnly": true }, "displayName": { "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "type": "string", "readOnly": true }, "metricType": { "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." } }, "id": "GoogleCloudContactcenterinsightsV1MetricValue" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation.", "type": "object", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DiagnoseConversationsMetadata": { "description": "Metadata for a DiagnoseConversations operation.", "type": "object", "properties": { "fullReport": { "readOnly": true, "description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", "type": "boolean" }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "metricType": { "description": "Output only. The type of metric being diagnosed.", "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "type": "string" }, "diagnosticReport": { "readOnly": true, "description": "Output only. The diagnostic report containing metrics and intent breakdowns.", "$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReport" }, "request": { "readOnly": true, "description": "Output only. The request that created the operation.", "$ref": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "partialTrajectories": { "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", "deprecated": true, "type": "array", "items": { "type": "string" }, "readOnly": true }, "latestStep": { "description": "Output only. The most recent thought or action from the agent.", "$ref": "GoogleCloudContactcenterinsightsV1SherlockStep", "readOnly": true }, "partialTrajectorySteps": { "readOnly": true, "description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1SherlockStep" } } }, "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata", "description": "Metadata for creating an issue.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse": { "description": "The response from a ListAuthorizedViewSet request.", "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": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "The AuthorizedViewSets under the parent.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model.", "type": "object", "properties": { "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1HoldData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1SilenceData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "description": "The metadata for generative insights.", "type": "object", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "properties": { "agentId": { "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" }, "agentChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "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": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", "description": "The response to deploy an issue model.", "type": "object", "properties": {} }, "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" } } }, "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.", "type": "object", "properties": { "displayName": { "description": "Display Name of the assessment rule.", "type": "string" }, "name": { "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this assessment rule was created.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which this assessment rule was updated.", "type": "string" }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive.", "type": "boolean" }, "sampleRule": { "description": "The sample rule for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "properties": { "labelValue": { "description": "Optional. The label value.", "type": "string" }, "labelKey": { "description": "Optional. The label key.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "description": "Tags and their corresponding results.", "type": "object", "properties": { "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "type": "object", "properties": { "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "textSections": { "additionalProperties": { "type": "string" }, "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "type": "object" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "confidence": { "format": "float", "description": "The confidence score of the summarization.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { "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.", "type": "object", "properties": { "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec from LLM", "type": "object" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1OutputConfig": { "description": "Configuration for where to export or return the analysis findings.", "type": "object", "properties": { "bigqueryDestination": { "description": "Optional. Export to BigQuery.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination" }, "googleSheetsDestination": { "description": "Optional. Export directly to a Google Sheet.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGoogleSheetsDestination" }, "gcsDestination": { "description": "Optional. Export to a Cloud Storage bucket.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfig" }, "GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination": { "description": "Google Sheets destination configuration.", "type": "object", "properties": { "spreadsheetId": { "description": "Optional. An existing Google Sheets ID.", "type": "string" }, "sheet": { "description": "Optional. The sheet name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "description": "The response to an IngestConversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "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" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "phraseMatchers": { "items": { "type": "string" }, "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array" }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "issueModels": { "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", "type": "array", "items": { "type": "string" } }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "id": "GoogleCloudContactcenterinsightsV1mainSampleRule", "description": "Message for sampling conversations.", "type": "object", "properties": { "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number", "format": "double" }, "conversationFilter": { "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.", "type": "string" }, "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" } } }, "GoogleIamV1AuditConfig": { "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.", "type": "object", "properties": { "auditLogConfigs": { "items": { "$ref": "GoogleIamV1AuditLogConfig" }, "description": "The configuration for logging of each type of permission.", "type": "array" }, "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" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn.", "type": "object", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data.", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse": { "description": "The response from a ListAuthorizedViews request.", "type": "object", "properties": { "authorizedViews": { "description": "The AuthorizedViews under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1Diagnostic": { "description": "The diagnostic resource.", "type": "object", "properties": { "report": { "description": "Output only. The report containing the findings of the diagnostic.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", "readOnly": true }, "name": { "description": "Immutable. Identifier. The resource name of the diagnostic.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the diagnostic was created.", "type": "string" }, "analysisSummary": { "readOnly": true, "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", "type": "string" }, "conversationFilter": { "readOnly": true, "description": "Output only. The filter used to select the conversations that were included in the diagnostic.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Diagnostic" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "type": "object", "properties": { "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The create time of the conversation.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The update time of the conversation.", "type": "string", "format": "google-datetime" } } }, "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.", "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule", "description": "The data for a phrase match rule.", "type": "object", "properties": { "negated": { "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", "type": "boolean" }, "query": { "description": "Required. The phrase to be matched.", "type": "string" }, "config": { "description": "Provides additional information about the rule that specifies how to apply the rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig" } } }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "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": "GoogleCloudContactcenterinsightsV1EncryptionSpec" } } }, "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": { "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object" }, "type": { "description": "The entity type.", "type": "string", "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ], "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ] }, "salience": { "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "id": "GoogleCloudContactcenterinsightsV1Entity" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "description": "The response for querying metrics.", "type": "object", "properties": { "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource", "description": "A Dialogflow source of conversation data.", "type": "object", "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "dialogflowConversation": { "readOnly": true, "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "description": "Tags and their corresponding results.", "type": "object", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "format": "double", "description": "The score the tag applies to.", "type": "number" }, "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" }, "normalizedScore": { "format": "double", "description": "The normalized score the tag applies to.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "description": "The analysis resource.", "type": "object", "properties": { "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" }, "requestTime": { "format": "google-datetime", "description": "Output only. The time at which the analysis was requested.", "type": "string", "readOnly": true }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string", "readOnly": true }, "analysisResult": { "readOnly": true, "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p99": { "format": "double", "description": "The 99th percentile value.", "type": "number" }, "p90": { "description": "The 90th percentile value.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "description": "Request to import an issue model.", "type": "object", "properties": { "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "description": "Information about the issue.", "type": "object", "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": { "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination": { "description": "BigQuery destination configuration.", "type": "object", "properties": { "dataset": { "description": "Required. The name of the BigQuery dataset.", "type": "string" }, "table": { "description": "Required. The BigQuery table name.", "type": "string" }, "projectId": { "description": "Optional. A project ID or number.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigBigQueryDestination" }, "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": {}, "id": "GoogleProtobufEmpty" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata", "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "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 }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "partialErrors": { "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1Chart": { "id": "GoogleCloudContactcenterinsightsV1alpha1Chart", "description": "Configurable dashboard's widget that displays data as a chart.", "type": "object", "properties": { "displayName": { "description": "User provided display name of the chart.", "type": "string" }, "chartVisualizationType": { "description": "Chart visualization type.", "type": "string", "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." ], "enum": [ "CHART_VISUALIZATION_TYPE_UNSPECIFIED", "BAR", "LINE", "AREA", "PIE", "SCATTER", "TABLE", "SCORE_CARD", "SUNBURST", "GAUGE", "SANKEY" ] }, "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "height": { "format": "int32", "description": "The height of the chart in grid units.", "type": "integer" }, "width": { "description": "The width of the chart in grid units.", "type": "integer", "format": "int32" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource" }, "action": { "description": "Optional action to be taken when the chart is clicked.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartAction" }, "description": { "description": "Chart description", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Chart last update time.", "type": "string", "format": "google-datetime" }, "chartType": { "description": "Output only. Chart type.", "readOnly": true, "enumDescriptions": [ "Unspecified chart type.", "Pre-defined chart type.", "Configurable chart type." ], "enum": [ "CHART_TYPE_UNSPECIFIED", "SYSTEM_DEFINED", "USER_DEFINED" ], "type": "string" }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Chart create time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "description": "The request to ingest conversations.", "type": "object", "properties": { "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "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" } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization.", "type": "object", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "enumDeprecated": [ false, true, true ], "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "type": "string", "description": "Default summarization model to be used." }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "description": "The request to deploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object", "properties": { "dataPoints": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series .", "type": "array" } } }, "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": { "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "issueModels": { "items": { "type": "string" }, "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", "type": "array" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "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" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "phraseMatchers": { "items": { "type": "string" }, "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "description": "Request to export an issue model.", "type": "object", "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" } } }, "GoogleCloudCesV1mainSpan": { "id": "GoogleCloudCesV1mainSpan", "description": "A span is a unit of work or a single operation during the request processing.", "type": "object", "properties": { "startTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The start time of the span.", "type": "string" }, "name": { "description": "Output only. The name of the span.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The end time of the span.", "type": "string", "format": "google-datetime" }, "duration": { "format": "google-duration", "description": "Output only. The duration of the span.", "type": "string", "readOnly": true }, "attributes": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "readOnly": true, "description": "Output only. Key-value attributes associated with the span.", "type": "object" }, "childSpans": { "description": "Output only. The child spans that are nested under this span.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "description": "Response from export issue model", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversation": { "id": "GoogleCloudContactcenterinsightsV1mainConversation", "description": "The conversation resource.", "type": "object", "properties": { "duration": { "readOnly": true, "description": "Output only. The duration of the conversation.", "type": "string", "format": "google-duration" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which the conversation was created.", "type": "string", "readOnly": true }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" }, "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." ], "description": "Immutable. The conversation medium.", "type": "string" }, "ttl": { "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "type": "string", "readOnly": true }, "dialogflowIntents": { "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "type": "object" }, "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" } }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource" }, "runtimeAnnotations": { "readOnly": true, "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "readOnly": true }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32", "readOnly": true }, "latestAnalysis": { "readOnly": true, "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis" }, "metadataJson": { "description": "Input only. 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" }, "expireTime": { "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string", "format": "google-datetime" }, "transcript": { "readOnly": true, "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "properties": { "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" }, "failedAnalysisCount": { "description": "Count of failed analyses.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension.", "type": "object", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "analysisPercentage": { "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number", "format": "float" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "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" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "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": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" } } }, "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest": { "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "id": "GoogleCloudContactcenterinsightsV1mainSilenceData", "description": "The data for a silence annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "description": "Info for correlating across conversations.", "type": "object", "properties": { "fullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string" }, "correlationTypes": { "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." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "type": "string" }, "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "type": "array", "readOnly": true }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule.", "type": "object", "properties": { "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "description": "The request to ingest conversations.", "type": "object", "properties": { "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "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" }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "description": "The request to export insights.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "writeDisposition": { "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "description": "Options for what to do if the destination table already exists.", "type": "string" }, "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "exportSchemaVersion": { "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "description": "Optional. Version of the export schema.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata" }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension.", "type": "object", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "A Dialogflow source of conversation data.", "type": "object", "properties": { "dialogflowConversation": { "readOnly": true, "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "type": "object", "properties": { "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "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": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" } } }, "GoogleCloudCesV1mainChunk": { "id": "GoogleCloudCesV1mainChunk", "description": "A chunk of content within a message.", "type": "object", "properties": { "blob": { "description": "Optional. Blob data.", "$ref": "GoogleCloudCesV1mainBlob" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "GoogleCloudCesV1mainToolResponse" }, "text": { "description": "Optional. Text data.", "type": "string" }, "payload": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Custom payload data.", "type": "object" }, "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." } }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "GoogleCloudCesV1mainToolCall" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "GoogleCloudCesV1mainAgentTransfer" }, "image": { "description": "Optional. Image data.", "$ref": "GoogleCloudCesV1mainImage" }, "updatedVariables": { "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The request to delete an issue model.", "type": "object", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "properties": { "successfulAnalysisCount": { "description": "Count of successful analyses.", "type": "integer", "format": "int32" }, "failedAnalysisCount": { "description": "Count of failed analyses.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult", "description": "The result of a single correlation rule.", "type": "object", "properties": { "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" }, "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest": { "description": "The request message for testing auto labeling rules.", "type": "object", "properties": { "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "conversation": { "description": "Required. Conversation data to test rules against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "partialErrors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "readOnly": true }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "description": "Metadata about the conversation medium dimension.", "type": "object", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "description": "Metadata for creating an issue model.", "type": "object", "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "properties": { "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call.", "type": "array" }, "waitDuration": { "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent.", "type": "string" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse", "description": "The response from a ListAuthorizedViews request.", "type": "object", "properties": { "authorizedViews": { "description": "The AuthorizedViews under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "description": "Metadata for an export insights operation.", "type": "object", "properties": { "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "completedExportCount": { "description": "The number of conversations that were exported successfully.", "type": "integer", "format": "int32" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1Dataset": { "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", "type": "object", "properties": { "displayName": { "description": "Display name for the dataaset", "type": "string" }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. Dataset update time.", "type": "string", "format": "google-datetime" }, "type": { "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "description": "Dataset usage type.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Dataset" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "description": "The results for each applicable constraint rule.", "type": "array" }, "conversationA": { "description": "The first conversation resource name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest", "description": "The request for summarizing performance according to different metrics for conversations over a specified time window.", "type": "object", "properties": { "queryInterval": { "description": "Required. The time window of the conversations to derive performance stats from.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "filter": { "description": "Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "description": "Request to upload a conversation.", "type": "object", "properties": { "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" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "description": "Conversation-level silence data.", "type": "object", "properties": { "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" }, "silencePercentage": { "format": "float", "description": "Percentage of the total conversation spent in silence.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" }, "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest": { "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "type": "object", "properties": { "maxSteps": { "description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", "type": "integer", "format": "int32" }, "requestId": { "description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" }, "fullReport": { "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", "type": "boolean" }, "filter": { "description": "Optional. AIP-160 compliant filter for selecting target conversations.", "type": "string" }, "taskQuery": { "description": "Optional. A natural language description of the analysis goal or question.", "type": "string" }, "metricType": { "description": "Optional. The type of metric being diagnosed.", "type": "string", "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ] }, "dryRun": { "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", "type": "boolean" }, "instructions": { "description": "Optional. Specific instructions for the agent.", "type": "string" }, "validateOnly": { "description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", "type": "boolean" }, "outputConfig": { "description": "Optional. The configuration for the output of the task.", "$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfig" }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "description": "The request for deleting a QaQuestionTag.", "type": "object", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "type": "object", "properties": { "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" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "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" }, "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" }, "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" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "type": "object", "properties": { "successfulSampleCount": { "format": "int32", "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "readOnly": true }, "failedSampleCount": { "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats" }, "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": { "exemptedMembers": { "items": { "type": "string" }, "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array" }, "logType": { "description": "The log type that this config enables.", "type": "string", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainMetricValue": { "id": "GoogleCloudContactcenterinsightsV1mainMetricValue", "type": "object", "properties": { "value": { "readOnly": true, "description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", "type": "number", "format": "double" }, "conversations": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", "type": "array" }, "hitCount": { "description": "Output only. The number of positive matches (hits) for this metric.", "type": "integer", "format": "int32", "readOnly": true }, "sourceId": { "readOnly": true, "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "type": "string" }, "metricType": { "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." }, "totalCount": { "format": "int32", "description": "Output only. The total number of items evaluated for this metric.", "type": "integer", "readOnly": true } }, "deprecated": true, "description": "Deprecated: MetricValue is no longer used for diagnostics." }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "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" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { "description": "The request for updating a QaQuestionTag.", "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "properties": { "createTime": { "readOnly": true, "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": "string" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" }, "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": { "description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "GoogleCloudContactcenterinsightsV1OutputConfig": { "description": "Configuration for where to export or return the analysis findings.", "type": "object", "properties": { "googleSheetsDestination": { "description": "Optional. Export directly to a Google Sheet.", "$ref": "GoogleCloudContactcenterinsightsV1OutputConfigGoogleSheetsDestination" }, "gcsDestination": { "description": "Optional. Export to a Cloud Storage bucket.", "$ref": "GoogleCloudContactcenterinsightsV1OutputConfigGcsDestination" }, "bigqueryDestination": { "description": "Optional. Export to BigQuery.", "$ref": "GoogleCloudContactcenterinsightsV1OutputConfigBigQueryDestination" } }, "id": "GoogleCloudContactcenterinsightsV1OutputConfig" }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "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.", "type": "string", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "properties": { "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer", "format": "int32" }, "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "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.", "type": "object", "properties": { "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "score": { "format": "double", "description": "The overall numerical score of the result.", "type": "number" }, "sourceType": { "description": "What created the score.", "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ] } }, "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "description": "Statistics for BulkDownloadFeedbackLabels operation.", "type": "object", "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" }, "fileNames": { "readOnly": true, "description": "Output only. Full name of the files written to Cloud storage.", "type": "array", "items": { "type": "string" } }, "totalFilesWritten": { "description": "Total number of files written to the provided Cloud Storage bucket.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "description": "The conversation resource.", "type": "object", "properties": { "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object" }, "latestSummary": { "readOnly": true, "description": "Output only. Latest summary of the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" }, "runtimeAnnotations": { "readOnly": true, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" } }, "ttl": { "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string" }, "medium": { "description": "Immutable. The conversation medium.", "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "type": "string" }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "readOnly": true, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "type": "object" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the conversation was created.", "type": "string" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "readOnly": true }, "duration": { "format": "google-duration", "description": "Output only. The duration of the conversation.", "type": "string", "readOnly": true }, "expireTime": { "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.", "type": "string" }, "transcript": { "readOnly": true, "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "metadataJson": { "description": "Input only. 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" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32", "readOnly": true }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "readOnly": true }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "startTime": { "format": "google-datetime", "description": "The time at which the conversation started.", "type": "string" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "description": "The call participant speaking for a given utterance.", "type": "object", "properties": { "role": { "description": "The role of the participant.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string", "deprecated": true }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats": { "description": "A breakdown of metrics grouped by intent.", "type": "object", "properties": { "intentDisplayName": { "description": "Output only. The display name of the intent.", "type": "string", "readOnly": true }, "lossPatterns": { "description": "Output only. A list of loss patterns identified for this intent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPattern" }, "readOnly": true }, "intentId": { "readOnly": true, "description": "Output only. The unique identifier for the intent (from Discovery Engine).", "type": "string" }, "metrics": { "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricValue" }, "type": "object", "readOnly": true }, "conversationCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of conversations associated with this intent.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats" }, "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination": { "description": "Cloud Storage destination configuration.", "type": "object", "properties": { "uri": { "description": "Required. The Cloud Storage URI to export the results to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1OutputConfigGcsDestination" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { "description": "The response of testing correlation config.", "type": "object", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "description": "An answer to a QaQuestion.", "type": "object", "properties": { "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } }, "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" }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" }, "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "description": "Information about an agent involved in the conversation.", "type": "object", "properties": { "displayName": { "description": "The agent's name.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "type": "string", "deprecated": true }, "agentType": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "teams": { "items": { "type": "string" }, "description": "User-specified strings representing the agent's teams.", "type": "array" }, "location": { "description": "The agent's location.", "type": "string" } } }, "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": { "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "conversation": { "readOnly": true, "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string" }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse": { "description": "The response of listing conversations.", "type": "object", "properties": { "conversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "The conversations that match the request.", "type": "array" }, "nextPageToken": { "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "description": "Configuration for summarization.", "type": "object", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "type": "string", "enumDeprecated": [ false, true, true ], "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." ], "description": "Default summarization model to be used." }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "description": "The response to undeploy an issue model.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse": { "description": "The response from a ListQaQuestions request.", "type": "object", "properties": { "qaQuestions": { "description": "The QaQuestions under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } }, "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": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "description": "Metadata for an export insights operation.", "type": "object", "properties": { "completedExportCount": { "format": "int32", "description": "The number of conversations that were exported successfully.", "type": "integer" }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "failedExportCount": { "format": "int32", "description": "The number of conversations that failed to be exported.", "type": "integer" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse": { "description": "The response of listing charts.", "type": "object", "properties": { "nextPageToken": { "description": "The value returned by the last `ListChartsResponse`. This value indicates that this is a continuation of a prior `ListCharts` call and that the system should return the next page of data.", "type": "string" }, "charts": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "The charts under the parent.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "description": "A segment of a full transcript.", "type": "object", "properties": { "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" }, "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": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "text": { "description": "The text of this segment.", "type": "string" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" } }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "channelTag": { "format": "int32", "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", "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" } } }, "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": { "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "description": "The request to delete an issue model.", "type": "object", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo": { "description": "Message for schedule info.", "type": "object", "properties": { "timeZone": { "description": "The timezone to use for the groc expression. If not specified, defaults to UTC.", "type": "string" }, "startTime": { "format": "google-datetime", "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created.", "type": "string" }, "schedule": { "description": "The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...", "type": "string" }, "endTime": { "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.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse", "description": "The response from a ListQaScorecardRevisions request.", "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" }, "qaScorecardRevisions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "The QaScorecards under the parent.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse", "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata", "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "readOnly": true }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "partialErrors": { "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsMetadata": { "description": "Metadata for a DiagnoseConversations operation.", "type": "object", "properties": { "diagnosticReport": { "readOnly": true, "description": "Output only. The diagnostic report containing metrics and intent breakdowns.", "$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport" }, "request": { "readOnly": true, "description": "Output only. The request that created the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest" }, "latestStep": { "description": "Output only. The most recent thought or action from the agent.", "$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep", "readOnly": true }, "partialTrajectorySteps": { "description": "Output only. The intermediate trajectory updates. This can be used for live progress tracking of the agent's thoughts and actions as it works through the analysis.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep" }, "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "partialTrajectories": { "readOnly": true, "items": { "type": "string" }, "type": "array", "deprecated": true, "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory)." }, "fullReport": { "readOnly": true, "description": "Output only. If true, the agent generated a full diagnostic report for all sub-agents.", "type": "boolean" }, "metricType": { "description": "Output only. The type of metric being diagnosed.", "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsMetadata" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "type": "object", "properties": { "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "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" } } }, "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.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights": { "description": "Request that use natural language query to generate the chart.", "type": "object", "properties": { "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "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" }, "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "chartSpec": { "description": "Chart spec for the chart.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "sqlQuery": { "description": "SQL query used to generate the chart.", "type": "string" }, "chartConversations": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" }, "deprecated": true, "description": "Output only. The chart conversations used to generate the chart." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights" }, "GoogleCloudContactcenterinsightsV1alpha1MetricValue": { "id": "GoogleCloudContactcenterinsightsV1alpha1MetricValue", "type": "object", "properties": { "displayName": { "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "type": "string", "readOnly": true }, "metricType": { "enum": [ "METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ], "readOnly": true, "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "type": "string", "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." }, "totalCount": { "description": "Output only. The total number of items evaluated for this metric.", "type": "integer", "format": "int32", "readOnly": true }, "value": { "readOnly": true, "description": "Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).", "type": "number", "format": "double" }, "conversations": { "items": { "type": "string" }, "description": "Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`", "type": "array", "readOnly": true }, "sourceId": { "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "type": "string", "readOnly": true }, "hitCount": { "description": "Output only. The number of positive matches (hits) for this metric.", "type": "integer", "format": "int32", "readOnly": true } }, "deprecated": true, "description": "Deprecated: MetricValue is no longer used for diagnostics." }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "description": "Message for sampling conversations.", "type": "object", "properties": { "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" }, "samplePercentage": { "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number" }, "sampleRow": { "format": "int64", "description": "Number of the conversations that we should sample based on the dimension.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource": { "description": "Google Sheets document details to get the feedback label file from.", "type": "object", "properties": { "spreadsheetUri": { "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource" }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "properties": { "magnitude": { "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number" }, "score": { "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint": { "description": "The current chart checkpoint state.", "type": "object", "properties": { "sessionId": { "description": "The session id of the chart.", "type": "string" }, "revisionId": { "description": "The revision id of the chart.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule", "description": "Rule for auto-labeling conversations.", "type": "object", "properties": { "displayName": { "description": "The user-provided display name of the rule.", "type": "string" }, "description": { "description": "The description of the rule.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the rule was updated.", "type": "string", "format": "google-datetime" }, "active": { "description": "Whether the rule is active.", "type": "boolean" }, "labelKey": { "description": "The label key. This is also the {auto_labeling_rule} in the resource name. Only settable if label_key_type is LABEL_KEY_TYPE_CUSTOM.", "type": "string" }, "conditions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition" }, "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.", "type": "array" }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this rule was created.", "type": "string", "format": "google-datetime" }, "labelKeyType": { "description": "The type of the label key.", "type": "string", "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ] } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array" }, "request": { "readOnly": true, "description": "Output only. The original request for download.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" }, "downloadStats": { "readOnly": true, "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" } } }, "GoogleCloudContactcenterinsightsV1DiagnosticReport": { "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "type": "object", "properties": { "metrics": { "readOnly": true, "type": "object", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1MetricValue" }, "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." }, "intentStats": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats" }, "description": "Output only. A breakdown of metrics grouped by intent.", "type": "array", "readOnly": true }, "lossPatterns": { "description": "Output only. A list of loss patterns identified for the entire project/dataset.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1LossPattern" }, "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1DiagnosticReport" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse", "description": "The response of testing correlation config.", "type": "object", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1alpha1View": { "id": "GoogleCloudContactcenterinsightsV1alpha1View", "description": "The View resource.", "type": "object", "properties": { "name": { "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this view was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The most recent time at which the view was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "displayName": { "description": "The human-readable display name of the view.", "type": "string" }, "value": { "description": "A filter to reduce conversation results to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1Dashboard": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dashboard", "description": "Configurable dashboard", "type": "object", "properties": { "displayName": { "description": "User provided display name of the dashboard.", "type": "string" }, "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": { "description": "Filter applied to all charts in the dashboard. Should support scope later.", "type": "string" }, "description": { "description": "Dashboard description", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Dashboard last update time.", "type": "string" }, "readOnly": { "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.", "type": "boolean", "readOnly": true }, "name": { "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Dashboard creation time.", "type": "string", "readOnly": true }, "dateRangeConfig": { "description": "Date range config applied to all charts in the dashboard.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "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" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "description": "All the matched issues.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" } } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards.", "type": "object", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", "description": "Aggregated statistics about an issue.", "type": "object", "properties": { "labeledConversationsCount": { "format": "int64", "description": "Number of conversations attached to the issue at this point in time.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "properties": { "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssue" }, "parent": { "description": "Required. The parent resource of the issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "GoogleCloudCesV1mainToolCall": { "description": "Request for the client or the agent to execute the specified tool.", "type": "object", "properties": { "args": { "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "displayName": { "readOnly": true, "description": "Output only. Display name of the tool.", "type": "string" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "toolsetTool": { "description": "Optional. The toolset tool to execute.", "$ref": "GoogleCloudCesV1mainToolsetTool" } }, "id": "GoogleCloudCesV1mainToolCall" }, "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": { "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "type": "string" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn.", "type": "object", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition": { "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition", "description": "Condition for auto-labeling conversations.", "type": "object", "properties": { "condition": { "description": "A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.", "type": "string" }, "value": { "description": "CEL expression to be evaluated as the value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecard": { "description": "A QaScorecard represents a collection of questions to be scored during analysis.", "type": "object", "properties": { "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, "description": { "description": "A text description explaining the intent of the scorecard.", "type": "string" }, "createTime": { "description": "Output only. The time at which this scorecard was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the scorecard was updated.", "type": "string" }, "isDefault": { "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.", "type": "boolean" }, "displayName": { "description": "The user-specified display name of the scorecard.", "type": "string" }, "source": { "description": "Output only. The source of the scorecard.", "type": "string", "readOnly": true, "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" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "type": "string", "format": "google-fieldmask" }, "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" } }, "id": "GoogleIamV1SetIamPolicyRequest" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata", "description": "Metadata for an export insights operation.", "type": "object", "properties": { "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" }, "completedExportCount": { "description": "The number of conversations that were exported successfully.", "type": "integer", "format": "int32" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "description": "The analysis resource.", "type": "object", "properties": { "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "readOnly": true }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string", "format": "google-datetime", "readOnly": true }, "requestTime": { "readOnly": true, "description": "Output only. The time at which the analysis was requested.", "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" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for processing transcript objects.", "type": "object", "properties": { "medium": { "description": "Required. The medium transcript objects represent.", "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "description": "Request to export an issue model.", "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" }, "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]", "type": "object", "properties": { "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "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" }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "description": "The CES diagnostic information.", "type": "object", "properties": { "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn.", "type": "array" }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "description": "A text output message from the system.", "type": "object", "properties": { "texts": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } }, "type": { "description": "The type of the text message.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "description": "Information about an agent involved in the conversation.", "type": "object", "properties": { "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "teams": { "description": "User-specified strings representing the agent's teams.", "type": "array", "items": { "type": "string" } }, "location": { "description": "The agent's location.", "type": "string" }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "team": { "deprecated": true, "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "type": "string" }, "agentType": { "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris": { "id": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris", "description": "Signed audio URIs for a conversation.", "type": "object", "properties": { "signedGcsAudioUri": { "description": "The signed URI for the audio from the Cloud Storage conversation source.", "type": "string" }, "signedTurnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "description": "The signed URI for the audio corresponding to each turn in the conversation.", "type": "array" }, "signedDialogflowAudioUri": { "description": "The signed URI for the audio from the Dialogflow conversation source.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "description": "Metadata about the conversation medium dimension.", "type": "object", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "description": "Metadata about the client sentiment category dimension.", "type": "object", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "properties": { "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange": { "description": "Relative date range configuration.", "type": "object", "properties": { "unit": { "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "description": "Required. The unit of time.", "type": "string" }, "quantity": { "description": "Required. The quantity of units in the past.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "type": "object", "properties": { "percentileEndToEndLatency": { "description": "The percentile result for end to end chat 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" }, "percentileTtsLatency": { "description": "The percentile result for TTS 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" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data.", "type": "object", "properties": { "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.", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "confidence": { "format": "float", "description": "The confidence score of the summarization.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "description": "Response from export issue model", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "description": "The data for a hold annotation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "description": "Metadata for deploying an issue model.", "type": "object", "properties": { "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "description": "One channel of conversation-level sentiment data.", "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse", "description": "The response to undeploy an issue model.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "description": "The request to export insights.", "type": "object", "properties": { "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "writeDisposition": { "description": "Options for what to do if the destination table already exists.", "type": "string", "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] }, "exportSchemaVersion": { "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "description": "Optional. Version of the export schema.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "description": "Metadata used for export issue model.", "type": "object", "properties": { "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "type": "object", "properties": { "qaScorecardRevisions": { "items": { "type": "string" }, "description": "List of QaScorecardRevisions.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "properties": { "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" } }, "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "description": "Collection of tags and their scores.", "type": "array" }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The timestamp that the revision was created.", "type": "string", "readOnly": true }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" } }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse", "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" } } }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "description": "The CES diagnostic information.", "type": "object", "properties": { "messages": { "description": "The messages in the turn.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" } }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "properties": { "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object", "properties": { "textType": { "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "type": "string" }, "text": { "items": { "type": "string" }, "description": "The parts of the message.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "description": "Response for an export insights operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "properties": { "strValue": { "description": "String value.", "type": "string" }, "score": { "readOnly": true, "description": "Output only. Numerical score of the answer.", "type": "number", "format": "double" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "normalizedScore": { "format": "double", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "readOnly": true }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "skipValue": { "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "type": "boolean", "readOnly": true }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "type": "number", "format": "double", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval": { "description": "A single interval in a time series.", "type": "object", "properties": { "startTime": { "description": "The start time of this interval.", "type": "string", "format": "google-datetime" }, "conversationCount": { "format": "int32", "description": "The number of conversations created in this interval.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval" }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "description": "An answer to a QaQuestion.", "type": "object", "properties": { "tags": { "items": { "type": "string" }, "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array" }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" } } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "description": "The request to create an issue model.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" }, "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.", "type": "object", "properties": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Create time of the label.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "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" }, "reply": { "description": "The content of the reply.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig": { "description": "Exact match configuration.", "type": "object", "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest": { "description": "The request for calculating conversation statistics.", "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "description": "The request to create an issue model.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "description": "A data point contains the metric values mapped to an interval.", "type": "object", "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" }, "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": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation.", "type": "object", "properties": { "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" } }, "conversation": { "description": "The conversation resource name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "The data for an issue match annotation.", "type": "object", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1alpha1ChartAction": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "description": "The action to be taken when the chart is clicked.", "type": "object", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" } } }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "properties": { "transcriptIndex": { "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer" }, "wordIndex": { "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "type": "object", "properties": { "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "description": "All the entities in the call.", "type": "object" }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" } }, "sentiments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" }, "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array" }, "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "description": "All the matched intents in the call.", "type": "object" }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" } }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" }, "annotations": { "description": "A list of call annotations that apply to this call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" } }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" } } }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension.", "type": "object", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1Issue" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" }, "GoogleIamV1TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "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": "array", "items": { "type": "string" } } }, "id": "GoogleIamV1TestIamPermissionsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1Widget": { "description": "Represents a dashboard element, could be a nested Container or Chart.", "type": "object", "properties": { "chart": { "description": "A chart widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "chartReference": { "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "container": { "description": "A container widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Widget" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "description": "Request to upload a conversation.", "type": "object", "properties": { "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" }, "speechConfig": { "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" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversation" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "properties": { "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "correctnessLevel": { "description": "The correctness level of an answer.", "type": "string", "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "type": "object", "properties": { "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "maxDeleteCount": { "format": "int32", "description": "Maximum number of conversations to delete.", "type": "integer" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "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" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } } }, "GoogleCloudCesV1mainImage": { "id": "GoogleCloudCesV1mainImage", "description": "Represents an image input or output in the conversation.", "type": "object", "properties": { "data": { "format": "byte", "description": "Required. Raw bytes of the image.", "type": "string" }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource", "description": "The request data for visualizing the dataset in the chart.", "type": "object", "properties": { "queryMetrics": { "description": "Use the existing QueryMetrics to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics" }, "generativeInsights": { "description": "Use natural language query to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights" } } }, "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats": { "id": "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats", "description": "A breakdown of metrics grouped by intent.", "type": "object", "properties": { "conversationCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of conversations associated with this intent.", "type": "integer" }, "intentId": { "readOnly": true, "description": "Output only. The unique identifier for the intent (from Discovery Engine).", "type": "string" }, "metrics": { "readOnly": true, "type": "object", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1MetricValue" }, "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics." }, "intentDisplayName": { "description": "Output only. The display name of the intent.", "type": "string", "readOnly": true }, "lossPatterns": { "description": "Output only. A list of loss patterns identified for this intent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1LossPattern" }, "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations.", "type": "object", "properties": { "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "averageCustomerSatisfactionRating": { "format": "double", "description": "The average customer satisfaction rating.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "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" }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "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" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "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" }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "type": "number" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number", "format": "double" }, "summarizationSuggestionResultCount": { "format": "int32", "description": "Count of summarization suggestions results.", "type": "integer" }, "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "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" }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "type": "number", "format": "double" }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "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" }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer" }, "aiCoachSuggestionAgentUsageCount": { "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "averageQaNormalizedScore": { "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number", "format": "double" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "dialogflowConversationsEscalationRatio": { "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "conversationAiCoachSuggestionCount": { "format": "int32", "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer" }, "summarizationSuggestionEditRatio": { "format": "double", "description": "Proportion of summarization suggestions that were manually edited.", "type": "number" }, "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" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "averageTurnCount": { "format": "float", "description": "The average turn count.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage", "description": "The message in the conversation.", "type": "object", "properties": { "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" }, "createTime": { "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": "string", "readOnly": true }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "description": "The message id of the message.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations": { "description": "Wrapper for a list of conversations.", "type": "object", "properties": { "conversations": { "description": "Optional. The conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "GoogleCloudContactcenterinsightsV1alpha1LossPattern": { "id": "GoogleCloudContactcenterinsightsV1alpha1LossPattern", "description": "A loss pattern of a virtual agent and suggested fixes.", "type": "object", "properties": { "description": { "readOnly": true, "description": "Output only. A markdown description of the loss pattern.", "type": "string" }, "examples": { "description": "Output only. A markdown of loss pattern examples.", "type": "string", "readOnly": true }, "displayName": { "description": "Output only. The display name of the loss pattern.", "type": "string", "readOnly": true }, "suggestedFixes": { "description": "Output only. A markdown description of the suggested fixes.", "type": "string", "readOnly": true }, "percentage": { "readOnly": true, "description": "Output only. The percentage of conversations that match this loss pattern.", "type": "number", "format": "double" }, "conversationIds": { "readOnly": true, "description": "Output only. A list of conversation IDs that match this loss pattern.", "type": "array", "items": { "type": "string" } }, "id": { "readOnly": true, "description": "Output only. The unique identifier for the loss pattern.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "duplicatesSkippedCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32", "readOnly": true }, "processedObjectCount": { "format": "int32", "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "readOnly": true }, "failedIngestCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "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": "GoogleCloudContactcenterinsightsV1EncryptionSpec" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "properties": { "querySource": { "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "description": "Query source for the answer.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { "description": "Message representing a possible answer to the question.", "type": "object", "properties": { "strValue": { "description": "String value.", "type": "string" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "score": { "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.", "type": "number" }, "numValue": { "description": "Numerical value.", "type": "number", "format": "double" }, "key": { "description": "A short string used as an identifier.", "type": "string" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig": { "description": "A configuration that defines how to correlate conversations for a given a given project.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" }, "createTime": { "description": "Output only. The time at which the correlation config was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. The time at which the correlation config was last updated.", "type": "string", "readOnly": true }, "fullConversationConfig": { "description": "The correlation type config for full conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object", "properties": { "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "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" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics", "description": "Request data that use the existing QueryMetrics.", "type": "object", "properties": { "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object", "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "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" } } }, "GoogleCloudContactcenterinsightsV1mainLossPattern": { "id": "GoogleCloudContactcenterinsightsV1mainLossPattern", "description": "A loss pattern of a virtual agent and suggested fixes.", "type": "object", "properties": { "suggestedFixes": { "description": "Output only. A markdown description of the suggested fixes.", "type": "string", "readOnly": true }, "percentage": { "readOnly": true, "format": "double", "description": "Output only. The percentage of conversations that match this loss pattern.", "type": "number" }, "conversationIds": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. A list of conversation IDs that match this loss pattern.", "type": "array" }, "id": { "description": "Output only. The unique identifier for the loss pattern.", "type": "string", "readOnly": true }, "description": { "readOnly": true, "description": "Output only. A markdown description of the loss pattern.", "type": "string" }, "examples": { "readOnly": true, "description": "Output only. A markdown of loss pattern examples.", "type": "string" }, "displayName": { "description": "Output only. The display name of the loss pattern.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "The feedback labels that match the request.", "type": "array" }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse", "description": "The response to list analyses.", "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" }, "analyses": { "description": "The analyses that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" } } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p90": { "description": "The 90th percentile value.", "type": "number", "format": "double" } } }, "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.", "type": "object", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", "type": "boolean" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" }, "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest": { "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "type": "object", "properties": { "filter": { "description": "Optional. AIP-160 compliant filter for selecting target conversations.", "type": "string" }, "taskQuery": { "description": "Optional. A natural language description of the analysis goal or question.", "type": "string" }, "metricType": { "description": "Optional. The type of metric being diagnosed.", "type": "string", "enumDescriptions": [ "Metric type is unspecified.", "Escalation rate.", "Containment rate." ], "enum": [ "DIAGNOSTIC_METRIC_TYPE_UNSPECIFIED", "ESCALATION", "CONTAINMENT" ] }, "dryRun": { "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", "type": "boolean" }, "maxSteps": { "format": "int32", "description": "Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.", "type": "integer" }, "requestId": { "description": "Optional. Required. A unique ID that identifies the request. If the service receives two `DiagnoseConversationsRequest`s with the same `request_id`, then the second request will be ignored; instead, the response of the first request will be returned. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" }, "fullReport": { "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", "type": "boolean" }, "validateOnly": { "description": "Optional. If true, the request will only be validated (permissions, filter syntax, etc.) without actually triggering the analysis.", "type": "boolean" }, "outputConfig": { "description": "Optional. The configuration for the output of the task.", "$ref": "GoogleCloudContactcenterinsightsV1OutputConfig" }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", "type": "string" }, "instructions": { "description": "Optional. Specific instructions for the agent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "type": "object", "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" } } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", "description": "Response for an export insights operation.", "type": "object", "properties": {} }, "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.", "type": "object", "properties": { "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "readOnly": true }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata" }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata", "readOnly": true }, "issueDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "readOnly": true }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "readOnly": true }, "dimensionKey": { "description": "The key of the dimension.", "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" ], "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ] }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { "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.", "type": "object", "properties": { "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer.", "type": "string" }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" } } }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "description": "A BigQuery Table Reference.", "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": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" }, "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": { "displayName": { "description": "The representative name for the entity.", "type": "string" }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ], "description": "The entity type.", "type": "string" }, "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" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "type": "object", "properties": { "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" }, "textType": { "description": "The type of text output.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ] } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "description": "Configs for the input data used to create the issue model.", "type": "object", "properties": { "medium": { "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "deprecated": true, "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": { "readOnly": true, "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "description": "The metadata for querying performance overview.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations.", "type": "object", "properties": { "aiCoachSuggestionAgentUsageRatio": { "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number" }, "averageCustomerSatisfactionRating": { "format": "double", "description": "The average customer satisfaction rating.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "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" }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "knowledgeSearchSuggestedQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number" }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "type": "number" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "avgConversationClientTurnSentimentEma": { "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number" }, "summarizationSuggestionResultCount": { "format": "int32", "description": "Count of summarization suggestions results.", "type": "integer" }, "dialogflowWebhookFailureRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that failed.", "type": "number" }, "knowledgeSearchAgentQuerySourceRatio": { "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.", "type": "number" }, "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" }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "knowledgeSearchResultCount": { "format": "int32", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "type": "number", "format": "double" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "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" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "conversationTotalCustomerMessageCount": { "format": "int32", "description": "The customer message count.", "type": "integer" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "qaTagScores": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags.", "type": "array" }, "averageQaNormalizedScore": { "format": "double", "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "dialogflowConversationsEscalationRatio": { "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "description": "The number of conversations transferred to a human agent.", "type": "integer" }, "averageDuration": { "format": "google-duration", "description": "The average duration.", "type": "string" }, "averageTurnCount": { "description": "The average turn count.", "type": "number", "format": "float" }, "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" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", "description": "The response for listing all feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object" }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" }, "unclassifiedConversationsCount": { "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", "description": "Metadata for deploying an issue model.", "type": "object", "properties": { "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "properties": { "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "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" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "description": "The response to undeploy an issue model.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "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}", "type": "string", "readOnly": true }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "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).", "type": "number" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "type": "object", "properties": { "errorMessages": { "items": { "$ref": "GoogleRpcStatus" }, "description": "The error message when the generative insights request fails.", "type": "array" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata" }, "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.", "type": "object", "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio.", "type": "object", "properties": { "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" }, "turnLevelAudios": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", "type": "array" }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GcsSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension.", "type": "object", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "description": "The data for an issue match annotation.", "type": "object", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } }, "id": "GoogleCloudContactcenterinsightsV1IssueMatchData" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "phraseMatchers": { "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array", "items": { "type": "string" } }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "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": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "issueModels": { "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", "type": "array", "items": { "type": "string" } }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag.", "type": "object", "properties": { "averageTagNormalizedScore": { "format": "double", "description": "Average tag normalized score per tag.", "type": "number" }, "tag": { "description": "Tag name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest", "description": "The request to test correlation config.", "type": "object", "properties": { "filter": { "description": "Optional. Filter to select conversations to test correlation against. Conversations matching this filter will be sampled based on start time. The most recent `max_sample_count` conversations will be selected. If no conversations match the filter, the request will fail with an `INVALID_ARGUMENT` error.", "type": "string" }, "maxSampleCount": { "format": "int32", "description": "Optional. The maximum number of conversations to sample when using the `filter`. If not set, defaults to 1000. Values greater than 1000 are coerced to 1000. This field is ignored if `conversations` is provided.", "type": "integer" }, "conversations": { "description": "Optional. A list of conversations to test against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "correlationConfig": { "description": "Required. The correlation config to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" } } }, "GoogleCloudContactcenterinsightsV1LossPattern": { "id": "GoogleCloudContactcenterinsightsV1LossPattern", "description": "A loss pattern of a virtual agent and suggested fixes.", "type": "object", "properties": { "suggestedFixes": { "readOnly": true, "description": "Output only. A markdown description of the suggested fixes.", "type": "string" }, "percentage": { "readOnly": true, "description": "Output only. The percentage of conversations that match this loss pattern.", "type": "number", "format": "double" }, "conversationIds": { "items": { "type": "string" }, "description": "Output only. A list of conversation IDs that match this loss pattern.", "type": "array", "readOnly": true }, "id": { "readOnly": true, "description": "Output only. The unique identifier for the loss pattern.", "type": "string" }, "description": { "description": "Output only. A markdown description of the loss pattern.", "type": "string", "readOnly": true }, "examples": { "description": "Output only. A markdown of loss pattern examples.", "type": "string", "readOnly": true }, "displayName": { "readOnly": true, "description": "Output only. The display name of the loss pattern.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryInterval": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "A time window for querying conversations.", "type": "object", "properties": { "startTime": { "format": "google-datetime", "description": "Required. The start time of the time window.", "type": "string" }, "endTime": { "description": "Required. The end time of the time window.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "description": "Issue Modeling result on a conversation.", "type": "object", "properties": { "issues": { "description": "All the matched issues.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } }, "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "description": "A message representing the transcript of a conversation.", "type": "object", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" } } } }, "GoogleCloudContactcenterinsightsV1SampleRule": { "description": "Message for sampling conversations.", "type": "object", "properties": { "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" }, "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" }, "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "samplePercentage": { "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1SampleRule" }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "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]", "type": "object", "properties": { "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" } }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" } } }, "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "description": "Dialogflow interaction data.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "completedAnalysesCount": { "description": "The number of requested analyses that have completed successfully so far.", "type": "integer", "format": "int32" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "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" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig", "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined.", "type": "object", "properties": { "type": { "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." ], "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" ], "description": "The type of the predefined question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" } } }, "GoogleCloudCesV1mainBlob": { "id": "GoogleCloudCesV1mainBlob", "description": "Represents a blob input or output in the conversation.", "type": "object", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "description": "Required. Raw bytes of the blob.", "type": "string", "format": "byte" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics", "description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.", "type": "object", "properties": { "accuracy": { "readOnly": true, "format": "double", "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object", "properties": { "text": { "items": { "type": "string" }, "description": "The parts of the message.", "type": "array" }, "textType": { "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "description": "The type of the text message.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "description": "Average QA normalized score for the tag.", "type": "object", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object" }, "confidenceScore": { "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).", "type": "number" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "description": "Configuration for diagnostic metrics.", "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" } } } }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object", "properties": { "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "format": { "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "description": "Required. File format in which the labels will be exported.", "type": "string" }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "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": { "format": "google-datetime", "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "description": "Statistics for IngestConversations operation.", "type": "object", "properties": { "duplicatesSkippedCount": { "readOnly": true, "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer", "format": "int32" }, "successfulIngestCount": { "readOnly": true, "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32" }, "processedObjectCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer" }, "failedIngestCount": { "readOnly": true, "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "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.", "type": "object", "properties": { "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "name": { "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the question tag was updated.", "type": "string", "format": "google-datetime" }, "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" } } }, "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data.", "type": "object", "properties": { "textSections": { "additionalProperties": { "type": "string" }, "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "type": "object" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "description": "Agent Assist Smart Compose suggestion data.", "type": "object", "properties": { "confidenceScore": { "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": "number" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "description": "Metadata about the QA question dimension.", "type": "object", "properties": { "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "type": "object", "properties": { "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Required. The medium transcript objects represent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule", "description": "A correlation rule that defines how to join conversations for a given correlation type.", "type": "object", "properties": { "ruleId": { "description": "Required. The unique identifier of the rule.", "type": "string" }, "joinKeyExpression": { "description": "Optional. A cel expression (go/cel) to be evaluated as a string value. This string value will be used as the join key for the correlation.", "type": "string" }, "active": { "description": "Optional. Whether the config is active to be evaluated.", "type": "boolean" }, "constraintExpression": { "description": "Optional. A cel expression (go/cel) to be evaluated as a boolean value. Two variables conversation_a and conversation_b will be available for evaluation. This expression should evaluate to true if conversation_a and conversation_b should be joined. This is used as an extra constraint on top of the join_key_expression to further refine the group of conversations that are joined together and will be evaluated in both directions. for two conversations c1 and c2 and the result will be OR'd. We will evaluate: f(c1, c2) OR f(c2, c1)", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p99": { "format": "double", "description": "The 99th percentile value.", "type": "number" }, "p90": { "format": "double", "description": "The 90th percentile value.", "type": "number" } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "description": "The response to an SampleConversations operation.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig", "description": "Configuration information of a phrase match rule.", "type": "object", "properties": { "exactMatchConfig": { "description": "The configuration for the exact match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig" }, "regexMatchConfig": { "description": "The configuration for the regex match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig" } } }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "description": "The data for a hold annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "GoogleCloudContactcenterinsightsV1mainIntent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntent" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "properties": { "querySource": { "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "description": "Query source for the answer.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object", "properties": { "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer", "format": "int32" }, "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer", "format": "int32" } } }, "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" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "type": "object", "properties": { "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "startOffset": { "format": "google-duration", "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string" }, "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" }, "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.", "type": "object", "properties": { "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "textOutput": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" }, "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "description": "The conversation source, which is a combination of transcript and audio.", "type": "object", "properties": { "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource" }, "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" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output.", "type": "object", "properties": { "textType": { "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of text output.", "type": "string" }, "text": { "items": { "type": "string" }, "description": "The text output from the LLM.", "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", "description": "The response to deploy an issue model.", "type": "object", "properties": {} }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "description": "The response for querying metrics.", "type": "object", "properties": { "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" }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" } }, "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "description": "The metadata for querying performance overview.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "description": "The result of a single constraint rule on the pair of conversations.", "type": "object", "properties": { "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "GoogleCloudContactcenterinsightsV1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "properties": { "score": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number", "format": "float" }, "magnitude": { "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1SentimentData" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The conversation transcript for the chart.", "type": "object", "properties": { "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" } }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The create time of the conversation.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The update time of the conversation.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object", "properties": { "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "format": { "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format in which the labels will be exported.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "description": "The data for an issue match annotation.", "type": "object", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart.", "type": "object", "properties": { "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.", "type": "string", "deprecated": true }, "generatedSqlQuery": { "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainOutputConfig": { "id": "GoogleCloudContactcenterinsightsV1mainOutputConfig", "description": "Configuration for where to export or return the analysis findings.", "type": "object", "properties": { "bigqueryDestination": { "description": "Optional. Export to BigQuery.", "$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigBigQueryDestination" }, "googleSheetsDestination": { "description": "Optional. Export directly to a Google Sheet.", "$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigGoogleSheetsDestination" }, "gcsDestination": { "description": "Optional. Export to a Cloud Storage bucket.", "$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfigGcsDestination" } } }, "GoogleCloudContactcenterinsightsV1Dimension": { "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.", "type": "object", "properties": { "labelDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" }, "issueDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the issue dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "readOnly": true }, "mediumDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "readOnly": true }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "readOnly": true }, "dimensionKey": { "description": "The key of the dimension.", "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" ], "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." ] }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "readOnly": true }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse", "description": "The response to deploy an issue model.", "type": "object", "properties": {} } }, "canonicalName": "Contactcenterinsights", "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "id": "contactcenterinsights:v1alpha1", "title": "Contact Center AI Insights API", "resources": { "projects": { "resources": { "locations": { "resources": { "datasets": { "methods": { "create": { "parameters": { "datasetId": { "description": "Optional. The ID to use for the dataset.", "type": "string", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the dataset." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "id": "contactcenterinsights.projects.locations.datasets.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/datasets", "description": "Creates a dataset." }, "patch": { "description": "Updates a dataset.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "id": "contactcenterinsights.projects.locations.datasets.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parameters": { "updateMask": { "description": "Optional. The list of fields to update.", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}" }, "list": { "description": "List datasets matching the input.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/datasets", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the dataset.", "required": true }, "pageSize": { "location": "query", "format": "int32", "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.", "type": "integer" }, "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" }, "filter": { "location": "query", "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`", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.datasets.list" }, "listAllFeedbackLabels": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "description": "Required. The parent resource of all feedback labels per project.", "required": true }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "description": "List all feedback labels by project number.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:listAllFeedbackLabels" }, "get": { "description": "Gets a dataset.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "parameters": { "name": { "description": "Required. The name of the dataset to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.get" }, "bulkDeleteFeedbackLabels": { "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "description": "Delete feedback labels in bulk using a filter." }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.datasets.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "parameters": { "name": { "description": "Required. The name of the dataset to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Delete a dataset.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkUploadFeedbackLabels": { "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "parameterOrder": [ "parent" ] }, "bulkDownloadFeedbackLabels": { "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource for new feedback labels.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" } } }, "resources": { "conversations": { "methods": { "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "parameters": { "force": { "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean", "location": "query" }, "name": { "description": "Required. The name of the conversation to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "description": "Deletes a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "parameters": { "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.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "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" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "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." ], "location": "query", "type": "string", "description": "The level of details of the conversation. Default is `BASIC`." }, "parent": { "description": "Required. The parent resource of the conversation.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations", "description": "Lists conversations." }, "ingest": { "description": "Imports conversations and processes them according to the user's configuration.", "path": "v1alpha1/{+parent}/conversations:ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource for new conversations.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest" }, "calculateStats": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "parameters": { "location": { "description": "Required. The location of the conversations.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", "description": "Gets conversation statistics.", "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "sample": { "id": "contactcenterinsights.projects.locations.datasets.conversations.sample", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "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." }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "parameters": { "view": { "description": "The level of details of the conversation. Default is `FULL`.", "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." ], "location": "query", "type": "string" }, "name": { "description": "Required. The name of the conversation to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "description": "Gets a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "generateSignedAudio": { "description": "Gets the signed URI for the audio for the given conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:generateSignedAudio", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "parameters": { "name": { "required": true, "description": "Required. The name of the conversation to sign.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio" }, "bulkDelete": { "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "parameters": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+parent}/conversations:bulkDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes multiple conversations in a single request." } }, "resources": { "feedbackLabels": { "methods": { "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the feedback label to delete." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", "description": "Delete feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "description": "List feedback labels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string", "location": "query" }, "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" }, "pageSize": { "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the feedback labels." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels", "description": "Create feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "parameters": { "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the feedback label." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" }, "updateMask": { "description": "Required. The list of fields to be updated.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Update feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Get feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get", "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" } } } } }, "insightsdata": { "methods": { "export": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource to export data from." } }, "parameterOrder": [ "parent" ], "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" ] } } } } }, "insightsdata": { "methods": { "export": { "path": "v1alpha1/{+parent}/insightsdata:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Export insights data to a destination defined in the request body.", "id": "contactcenterinsights.projects.locations.insightsdata.export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "parameters": { "parent": { "description": "Required. The parent resource to export data from.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "qaScorecards": { "resources": { "revisions": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets a QaScorecardRevision.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the QaScorecardRevision to get.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" } }, "tuneQaScorecardRevision": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "parameters": { "parent": { "required": true, "description": "Required. The parent resource for new fine tuning job instance.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "description": "Fine tune one or more QaModels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:tuneQaScorecardRevision" }, "create": { "parameters": { "qaScorecardRevisionId": { "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the QaScorecardRevision.", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/revisions", "description": "Creates a QaScorecardRevision." }, "deploy": { "description": "Deploy a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:deploy", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "parameters": { "name": { "description": "Required. The name of the QaScorecardRevision to deploy.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" } }, "undeploy": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "description": "Required. The name of the QaScorecardRevision to undeploy.", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy", "description": "Undeploy a QaScorecardRevision.", "path": "v1alpha1/{+name}:undeploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "parameters": { "force": { "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.", "type": "boolean", "location": "query" }, "name": { "required": true, "description": "Required. The name of the QaScorecardRevision to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", "description": "Deletes a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/revisions", "description": "Lists all revisions under the parent QaScorecard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "parameters": { "qaScorecardSources": { "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "repeated": true, "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." ], "location": "query", "type": "string", "description": "Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards Revisions from Scorecards of one or more sources." }, "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 }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "pageToken": { "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" } } }, "resources": { "qaQuestions": { "methods": { "create": { "description": "Create a QaQuestion.", "path": "v1alpha1/{+parent}/qaQuestions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "description": "Required. The parent resource of the QaQuestion.", "required": true }, "qaQuestionId": { "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", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions" }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}" }, "updateMask": { "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", "type": "string", "location": "query", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "description": "Updates a QaQuestion.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the QaQuestion to delete." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "description": "Deletes a QaQuestion.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "description": "Lists QaQuestions.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaQuestions", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "parameters": { "pageToken": { "location": "query", "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.", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "description": "Required. The parent resource of the questions.", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets a QaQuestion.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "description": "Required. The name of the QaQuestion to get.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } } } } } } }, "methods": { "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "parameters": { "force": { "description": "Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "type": "boolean", "location": "query" }, "name": { "required": true, "description": "Required. The name of the QaScorecard to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "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" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the scorecards.", "required": true }, "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 of one or more sources.", "repeated": true, "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" ], "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "id": "contactcenterinsights.projects.locations.qaScorecards.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaScorecards", "description": "Lists QaScorecards." }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaScorecards", "description": "Create a QaScorecard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the QaScorecard." }, "qaScorecardId": { "description": "Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.qaScorecards.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" } }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "required": true } }, "parameterOrder": [ "name" ], "description": "Updates a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "id": "contactcenterinsights.projects.locations.qaScorecards.get", "parameters": { "name": { "required": true, "description": "Required. The name of the QaScorecard to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "description": "Gets a QaScorecard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "qaQuestionTags": { "methods": { "create": { "description": "Creates a QaQuestionTag.", "path": "v1alpha1/{+parent}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "parameters": { "qaQuestionTagId": { "location": "query", "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the QaQuestionTag." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags" }, "patch": { "description": "Updates a QaQuestionTag.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "parameters": { "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}" }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "type": "string", "description": "Required. The name of the QaQuestionTag to delete.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "description": "Deletes a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaQuestionTags", "description": "Lists the question tags.", "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestionTags.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions (ie. AND operators). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_id` - id of the scorecard to list tags for * `revision_id` - id of the scorecard revision to list tags for` * `qa_question_id - id of the question to list tags for`", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" } }, "get": { "description": "Gets a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the QaQuestionTag to get." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.get" } } }, "assessmentRules": { "methods": { "list": { "description": "Lists assessment rules.", "path": "v1alpha1/{+parent}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" }, "id": "contactcenterinsights.projects.locations.assessmentRules.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "parameters": { "parent": { "description": "Required. The parent resource of the assessment rules.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string" } }, "parameterOrder": [ "parent" ] }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "parameters": { "name": { "required": true, "description": "Required. The name of the assessment rule to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.assessmentRules.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes an assessment rule." }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`" }, "assessmentRuleId": { "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])?$`.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "id": "contactcenterinsights.projects.locations.assessmentRules.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessmentRules", "description": "Creates an assessment rule." }, "patch": { "parameters": { "name": { "required": true, "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Updates an assessment rule." }, "get": { "id": "contactcenterinsights.projects.locations.assessmentRules.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the assessment rule to get.", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get an assessment rule." } } }, "authorizedViewSets": { "resources": { "authorizedViews": { "resources": { "operations": { "methods": { "list": { "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "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.", "type": "boolean", "location": "query" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}/operations" }, "cancel": { "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1alpha1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "conversations": { "methods": { "get": { "description": "Gets a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "parameters": { "name": { "description": "Required. The name of the conversation to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string" }, "view": { "description": "The level of details of the conversation. Default is `FULL`.", "location": "query", "type": "string", "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" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get" }, "generateSignedAudio": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the conversation to sign." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation." }, "calculateStats": { "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "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": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string", "location": "query" } }, "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" } }, "list": { "parameters": { "pageToken": { "location": "query", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "type": "string" }, "view": { "description": "The level of details of the conversation. Default is `BASIC`.", "location": "query", "type": "string", "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." ] }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "description": "Required. The parent resource of the conversation.", "required": true }, "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "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" }, "pageSize": { "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", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations", "description": "Lists conversations." }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The name of the conversation to delete.", "required": true }, "force": { "location": "query", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes a conversation." } }, "resources": { "assessments": { "resources": { "notes": { "methods": { "create": { "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the note.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "parameters": { "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`", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "description": "Update Note.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "parameters": { "pageSize": { "description": "Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "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.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the notes." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "description": "List Notes.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/notes" }, "delete": { "parameters": { "name": { "description": "Required. The name of the note to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes a Note." } } } }, "methods": { "publish": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "parameters": { "name": { "description": "Required. The name of the assessment to publish.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "description": "Publish an Assessment.", "path": "v1alpha1/{+name}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "appeal": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "parameters": { "name": { "required": true, "description": "Required. The name of the assessment to appeal.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "description": "Appeal an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:appeal" }, "get": { "description": "Get Assessment.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "parameters": { "name": { "description": "Required. The name of the assessment to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}" }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string", "location": "query" }, "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", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list", "description": "List Assessments.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments" }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "parameters": { "force": { "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "type": "boolean", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the assessment to delete." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete an Assessment." }, "finalize": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the assessment to finalize." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "description": "Finalize an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:finalize" }, "create": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "description": "Required. The parent resource of the assessment.", "required": true } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Assessment." } } }, "feedbackLabels": { "methods": { "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Get feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "parameters": { "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource of the feedback label.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "description": "Create feedback label.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Update feedback label.", "parameters": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "list": { "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the feedback labels.", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels" }, "delete": { "description": "Delete feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "Required. The name of the feedback label to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete" } } } } } }, "methods": { "get": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "description": "Required. The name of the AuthorizedView to get.", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Get AuthorizedView" }, "queryMetrics": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "parameters": { "location": { "required": true, "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" } }, "parameterOrder": [ "location" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Query metrics." }, "setIamPolicy": { "parameters": { "resource": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "required": true, "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." } }, "parameterOrder": [ "resource" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "testIamPermissions": { "httpMethod": "POST", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "resource" ], "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.", "path": "v1alpha1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "search": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "query": { "location": "query", "description": "Optional. The query expression to search authorized views.", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "required": true }, "orderBy": { "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string", "location": "query" }, "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.", "type": "integer", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "description": "SearchAuthorizedViewSets", "path": "v1alpha1/{+parent}/authorizedViews:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "Required. The name of the AuthorizedView to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", "description": "Deletes an AuthorizedView.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "getIamPolicy": { "path": "v1alpha1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "parameters": { "resource": { "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/[^/]+$", "type": "string", "location": "path" }, "options.requestedPolicyVersion": { "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } }, "parameterOrder": [ "resource" ], "httpMethod": "GET", "response": { "$ref": "GoogleIamV1Policy" } }, "generativeInsights": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.generativeInsights", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights", "parameters": { "location": { "required": true, "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "location" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+location}:generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics." }, "queryPerformanceOverview": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}: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" ] }, "create": { "description": "Create AuthorizedView", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViews", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the AuthorizedView." }, "authorizedViewId": { "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "parameters": { "name": { "location": "path", "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 }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Updates an AuthorizedView.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViews", "description": "List AuthorizedViewSets", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "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.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "description": "Optional. The filter expression to filter authorized views listed in the response.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse" } } } } }, "methods": { "create": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "parameters": { "authorizedViewSetId": { "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the AuthorizedViewSet.", "required": true } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "Create AuthorizedViewSet", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViewSets" }, "patch": { "description": "Updates an AuthorizedViewSet.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "required": true }, "updateMask": { "location": "query", "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: * `display_name`", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } }, "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "parameters": { "name": { "required": true, "description": "Required. The name of the AuthorizedViewSet to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string" }, "force": { "location": "query", "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "type": "boolean" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an AuthorizedViewSet." }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "parameters": { "pageSize": { "description": "Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized view sets listed in the response.", "type": "string" }, "parent": { "description": "Required. The parent resource of the AuthorizedViewSets.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "description": "List AuthorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViewSets" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "parameters": { "name": { "description": "Required. The name of the AuthorizedViewSet to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Get AuthorizedViewSet" } } }, "dashboards": { "resources": { "charts": { "methods": { "create": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the chart.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string" }, "chartId": { "location": "query", "description": "Optional. A unique ID for the new Chart. This ID will become the final component of the Chart's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "id": "contactcenterinsights.projects.locations.dashboards.charts.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "Creates a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/charts" }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "parameters": { "name": { "required": true, "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "type": "string" } }, "parameterOrder": [ "name" ], "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" ] }, "delete": { "description": "Deletes a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "type": "string", "description": "Required. The name of the chart to delete.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.delete" }, "list": { "id": "contactcenterinsights.projects.locations.dashboards.charts.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the charts.", "required": true } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" }, "path": "v1alpha1/{+parent}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Charts." }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the chart to get." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "description": "Gets a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } } }, "methods": { "get": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.get", "parameters": { "name": { "required": true, "description": "Required. The name of the dashboard to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Required. The name of the dashboard to delete.", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "id": "contactcenterinsights.projects.locations.dashboards.delete", "description": "Deletes a Dashboard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "description": "Lists Dashboards.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/dashboards", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the dashboards.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "filter": { "location": "query", "description": "Optional. The filter expression to filter dashboards listed in the response.", "type": "string" }, "orderBy": { "description": "Optional. The order by expression to order dashboards listed in the response.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "Optional. The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.dashboards.list" }, "create": { "description": "Creates a Dashboard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/dashboards", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "parent": { "description": "Required. The parent resource of the dashboard.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "dashboardId": { "location": "query", "description": "Optional. A unique ID for the new Dashboard. This ID will become the final component of the Dashboard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "id": "contactcenterinsights.projects.locations.dashboards.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` * `description`", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } } } }, "autoLabelingRules": { "methods": { "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "parameters": { "name": { "required": true, "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "description": "Gets an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "test": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "description": "Tests auto labeling rules against a conversation.", "path": "v1alpha1/{+parent}/autoLabelingRules:test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes an auto labeling rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}" } }, "parameterOrder": [ "name" ] }, "list": { "path": "v1alpha1/{+parent}/autoLabelingRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists auto labeling rules.", "id": "contactcenterinsights.projects.locations.autoLabelingRules.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "parameters": { "parent": { "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of auto labeling rules to return in a single response. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous List request, if any.", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" } }, "create": { "parameters": { "autoLabelingRuleId": { "description": "Required. The ID to use for the auto labeling rule, which will become the final component of the auto labeling rule's resource name.", "type": "string", "location": "query" }, "parent": { "required": true, "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/autoLabelingRules", "description": "Creates an auto labeling rule." }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "parameters": { "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string" }, "updateMask": { "description": "Optional. The list of fields to be updated.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "description": "Updates an auto labeling rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "operations": { "methods": { "list": { "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.", "type": "boolean", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "id": "contactcenterinsights.projects.locations.operations.list", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "cancel": { "id": "contactcenterinsights.projects.locations.operations.cancel", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled." } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "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`." }, "get": { "id": "contactcenterinsights.projects.locations.operations.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "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." } } }, "phraseMatchers": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/phraseMatchers", "description": "Creates a phrase matcher.", "parameters": { "parent": { "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "patch": { "description": "Updates a phrase matcher.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "parameters": { "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "delete": { "parameters": { "name": { "required": true, "description": "Required. The name of the phrase matcher to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes a phrase matcher." }, "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource of the phrase matcher.", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "pageToken": { "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.", "type": "string" }, "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" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/phraseMatchers", "description": "Lists phrase matchers." }, "get": { "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "parameters": { "name": { "required": true, "description": "Required. The name of the phrase matcher to get.", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a phrase matcher." } } }, "analysisRules": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/analysisRules", "description": "Creates a analysis rule.", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "id": "contactcenterinsights.projects.locations.analysisRules.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Updates a analysis rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.analysisRules.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "contactcenterinsights.projects.locations.analysisRules.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the analysis rule to delete." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "description": "Deletes a analysis rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists analysis rules.", "id": "contactcenterinsights.projects.locations.analysisRules.list", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "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.", "type": "integer" }, "parent": { "description": "Required. The parent resource of the analysis rules.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" } }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "parameters": { "name": { "description": "Required. The name of the AnalysisRule to get.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "id": "contactcenterinsights.projects.locations.analysisRules.get", "description": "Get a analysis rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } }, "issueModels": { "resources": { "issues": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the issue." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issues", "description": "Lists issues." }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "parameters": { "name": { "required": true, "description": "Required. The name of the issue to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes an issue." }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "parameters": { "updateMask": { "description": "The list of fields to be updated.", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "description": "Updates an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "create": { "description": "Creates an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issues", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "description": "Required. The parent resource of the issue.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } }, "get": { "description": "Gets an issue.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "parameters": { "name": { "description": "Required. The name of the issue to get.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ] } } } }, "methods": { "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.issueModels.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "parameters": { "name": { "required": true, "description": "Required. The name of the issue model to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Deletes an issue model.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "description": "Required. The name of the issue model to get.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "id": "contactcenterinsights.projects.locations.issueModels.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets an issue model." }, "import": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.issueModels.import", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the issue model." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels:import", "description": "Imports an issue model from a Cloud Storage bucket.", "path": "v1alpha1/{+parent}/issueModels:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issueModels", "description": "Creates an issue model.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the issue model." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.issueModels.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "patch": { "parameters": { "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "description": "The list of fields to be updated.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "id": "contactcenterinsights.projects.locations.issueModels.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Updates an issue model." }, "deploy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:deploy", "description": "Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", "parameters": { "name": { "description": "Required. The issue model to deploy.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.deploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "export": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.issueModels.export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The issue model to export." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "description": "Exports an issue model to the provided destination.", "path": "v1alpha1/{+name}:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "undeploy": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", "parameters": { "name": { "required": true, "description": "Required. The issue model to undeploy.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:undeploy" }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the issue model.", "required": true } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.issueModels.list", "description": "Lists issue models.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issueModels" }, "calculateIssueModelStats": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "parameters": { "issueModel": { "description": "Required. The resource name of the issue model to query against.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "issueModel" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "description": "Gets an issue model's statistics.", "path": "v1alpha1/{+issueModel}:calculateIssueModelStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "views": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets a view.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "description": "Required. The name of the view to get.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.views.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" } }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.views.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/views", "description": "Creates a view." }, "patch": { "id": "contactcenterinsights.projects.locations.views.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "required": true, "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a view." }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the view to delete." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.views.delete", "description": "Deletes a view.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/views", "description": "Lists views.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "parameters": { "pageSize": { "location": "query", "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.", "type": "integer" }, "pageToken": { "location": "query", "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.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource of the views." } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.views.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" } } } }, "diagnostics": { "methods": { "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a diagnostic.", "id": "contactcenterinsights.projects.locations.diagnostics.delete", "parameters": { "name": { "description": "Required. The name of the diagnostic to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/diagnostics/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/diagnostics/{diagnosticsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDiagnosticsResponse" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the diagnostics.", "required": true }, "pageSize": { "description": "Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListDiagnostics` call. Provide this to retrieve the subsequent page.", "type": "string" }, "filter": { "location": "query", "description": "Optional. A filter to apply to the list (e.g. `create_time \u003e \"2023-01-01T00:00:00Z\"`).", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/diagnostics", "id": "contactcenterinsights.projects.locations.diagnostics.list", "description": "Lists diagnostics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/diagnostics" }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Diagnostic" }, "id": "contactcenterinsights.projects.locations.diagnostics.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/diagnostics/{diagnosticsId}", "parameters": { "name": { "description": "Required. The name of the diagnostic to retrieve.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/diagnostics/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Gets a diagnostic.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "encryptionSpec": { "methods": { "initialize": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:initialize", "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.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "type": "string", "location": "path", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "conversations": { "resources": { "feedbackLabels": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Get feedback label.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the feedback label to get." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "create": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "parameters": { "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource of the feedback label.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels" }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "parameters": { "updateMask": { "description": "Required. The list of fields to be updated.", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "parent": { "required": true, "description": "Required. The parent resource of the feedback labels.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ] }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "parameters": { "name": { "required": true, "description": "Required. The name of the feedback label to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } } } }, "assessments": { "resources": { "notes": { "methods": { "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "parameters": { "parent": { "description": "Required. The parent resource of the notes.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" }, "pageToken": { "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "pageSize": { "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.", "type": "integer", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "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" ] }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "parameters": { "name": { "description": "Required. The name of the note to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "parameters": { "parent": { "description": "Required. The parent resource of the note.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Note." }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "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", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Update Note." } } } }, "methods": { "publish": { "description": "Publish an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:publish", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "parameters": { "name": { "description": "Required. The name of the assessment to publish.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" } }, "appeal": { "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "parameters": { "name": { "description": "Required. The name of the assessment to appeal.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+name}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Appeal an Assessment." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Get Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the assessment to get.", "required": true } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "delete": { "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "parameters": { "force": { "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "type": "boolean", "location": "query" }, "name": { "description": "Required. The name of the assessment to delete.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete an Assessment." }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" }, "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "type": "string" }, "pageSize": { "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments", "description": "List Assessments." }, "create": { "id": "contactcenterinsights.projects.locations.conversations.assessments.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the assessment.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Assessment." }, "finalize": { "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "parameters": { "name": { "required": true, "description": "Required. The name of the assessment to finalize.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "path": "v1alpha1/{+name}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Finalize an Assessment." } } }, "analyses": { "methods": { "delete": { "description": "Deletes an analysis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the analysis to delete." } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "id": "contactcenterinsights.projects.locations.conversations.analyses.delete" }, "list": { "description": "Lists analyses.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/analyses", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse" }, "parameters": { "pageToken": { "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.", "type": "string" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string", "location": "query" }, "pageSize": { "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.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "required": true, "description": "Required. The parent resource of the analyses.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "id": "contactcenterinsights.projects.locations.conversations.analyses.list" }, "create": { "path": "v1alpha1/{+parent}/analyses", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an analysis. The long running operation is done when the analysis has completed.", "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "parameters": { "parent": { "description": "Required. The parent resource of the analysis.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the analysis to get." } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an analysis." } } }, "segments": { "methods": { "bulkAnalyze": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource to create analyses in.", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/segments:bulkAnalyze", "description": "Analyzes multiple conversations in a single request." } } } }, "methods": { "list": { "description": "Lists conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "parameters": { "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.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "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" ], "type": "string", "location": "query", "description": "The level of details of the conversation. Default is `BASIC`." }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource of the conversation.", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "id": "contactcenterinsights.projects.locations.conversations.list" }, "ingest": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.conversations.ingest", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Imports conversations and processes them according to the user's configuration.", "path": "v1alpha1/{+parent}/conversations:ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.create", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "conversationId": { "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-`", "type": "string" } }, "parameterOrder": [ "parent" ], "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" ] }, "patch": { "description": "Updates a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.patch", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings`", "type": "string" }, "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "location": "query", "description": "Optional. If set to true, the conversation will be updated with auto labeling results.", "type": "boolean" }, "allowMissing": { "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.", "type": "boolean", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}" }, "calculateStats": { "description": "Gets conversation statistics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+location}/conversations:calculateStats", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", "parameters": { "location": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The location of the conversations.", "required": true }, "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string", "location": "query" } }, "parameterOrder": [ "location" ], "id": "contactcenterinsights.projects.locations.conversations.calculateStats" }, "sample": { "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "path": "v1alpha1/{+parent}/conversations:sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.conversations.sample", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of the dataset.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ] }, "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" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "parameters": { "name": { "description": "Required. The name of the conversation to sign.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ] }, "delete": { "description": "Deletes a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "Required. The name of the conversation to delete.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path" }, "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" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.conversations.delete" }, "upload": { "path": "v1alpha1/{+parent}/conversations:upload", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "id": "contactcenterinsights.projects.locations.conversations.upload", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the conversation." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the conversation to get." }, "view": { "description": "The level of details of the conversation. Default is `FULL`.", "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." ], "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "description": "Gets a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkAnalyze": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The parent resource to create analyses in.", "required": true } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:bulkAnalyze", "description": "Analyzes multiple conversations in a single request." }, "bulkDelete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:bulkDelete", "description": "Deletes multiple conversations in a single request.", "parameters": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } } } } }, "methods": { "listAllFeedbackLabels": { "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List all feedback labels by project number.", "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "parameters": { "parent": { "required": true, "description": "Required. The parent resource of all feedback labels per project.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" } }, "testCorrelationConfig": { "description": "Tests correlation config on a conversation.", "path": "v1alpha1/{+location}:testCorrelationConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest" }, "parameters": { "location": { "required": true, "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig" }, "queryPerformanceOverview": { "path": "v1alpha1/{+parent}:queryPerformanceOverview", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "bulkUploadFeedbackLabels": { "parameters": { "parent": { "required": true, "description": "Required. The parent resource for new feedback labels.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations." }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies." }, "getCorrelationConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets correlation config.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "parameters": { "name": { "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" } }, "queryMetrics": { "path": "v1alpha1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Query metrics.", "id": "contactcenterinsights.projects.locations.queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "parameters": { "location": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"" } }, "parameterOrder": [ "location" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "diagnoseConversations": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:diagnoseConversations", "description": "Analyzes conversation data using specialized agentic workflows, such as ReAct, to diagnose issues and provide insights.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:diagnoseConversations", "parameters": { "parent": { "description": "Required. The parent resource where the analysis will be performed.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "contactcenterinsights.projects.locations.diagnoseConversations", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "bulkDeleteFeedbackLabels": { "description": "Delete feedback labels in bulk using a filter.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" } }, "updateSettings": { "description": "Updates project-level settings.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "id": "contactcenterinsights.projects.locations.updateSettings", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string", "location": "path", "required": true, "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings" }, "generativeInsights": { "id": "contactcenterinsights.projects.locations.generativeInsights", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "required": true } }, "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generativeInsights", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1alpha1/{+location}:generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics." }, "getSettings": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "id": "contactcenterinsights.projects.locations.getSettings", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string", "description": "Required. The name of the settings resource to get.", "required": true } }, "parameterOrder": [ "name" ], "description": "Gets project-level settings.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getEncryptionSpec": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "type": "string", "required": true, "description": "Required. The name of the encryption spec resource to get." } }, "parameterOrder": [ "name" ], "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "httpMethod": "GET", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets location-level encryption key specification." }, "updateCorrelationConfig": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "type": "string", "required": true, "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "description": "Updates correlation config.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } } } } }, "batchPath": "batch", "basePath": "", "version_module": true, "rootUrl": "https://contactcenterinsights.googleapis.com/", "servicePath": "", "ownerName": "Google" }