{ "schemas": { "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse": { "description": "The response for listing all feedback labels.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainListAllFeedbackLabelsResponse", "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" }, "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "description": "The feedback labels that match the request." } } }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "description": "Agent Assist Smart Compose suggestion data.", "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData", "properties": { "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "metadata": { "type": "object", "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "additionalProperties": { "type": "string" } }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "description": "The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "double" } }, "type": "object" }, "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.", "id": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel", "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Create time of the label.", "readOnly": true }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Update time of the label.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "description": "The response of testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse", "properties": { "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults" } } }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse", "properties": { "successfulAnalysisCount": { "format": "int32", "type": "integer", "description": "Count of successful analyses." }, "failedAnalysisCount": { "description": "Count of failed analyses.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "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" } }, "type": "object", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard." }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "description": "The request for deleting a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "description": "Metadata used for export issue model.", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "properties": { "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "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" }, "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" }, "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" } }, "type": "object" }, "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.", "id": "GoogleCloudContactcenterinsightsV1mainEntity", "properties": { "metadata": { "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "additionalProperties": { "type": "string" }, "type": "object" }, "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "format": "float", "type": "number" }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "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" ] } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1mainDataset" } } }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation", "properties": { "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time at which this annotation was created." }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination" }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "type": "object", "description": "Request to export an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { "description": "The request to create an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "description": "The data for an issue match annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" }, "type": "array", "description": "The results for each correlation rule." } } }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation", "properties": { "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "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" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time at which this annotation was created." } } }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "properties": { "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "format": "int32", "type": "integer" }, "transcriptIndex": { "format": "int32", "type": "integer", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero." } }, "type": "object", "description": "A point in a conversation that marks the start or the end of an annotation." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } }, "type": "object", "description": "Metadata about the Conversational Agents playbook dimension." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "properties": { "medium": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Required. The medium transcript objects represent." } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination", "properties": { "format": { "type": "string", "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format in which the labels will be exported." }, "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" }, "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": { "type": "string", "format": "int64", "description": "Optional. The number of records per file. Applicable for either format." } }, "type": "object", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "format": "google-duration", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "description": "The data for a hold annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "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).", "format": "float", "type": "number" }, "metadata": { "type": "object", "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" } }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "uri": { "description": "Article URI.", "type": "string" }, "title": { "description": "Article title.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "type": "object", "description": "Agent Assist Article Suggestion data." }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "description": "Metadata for creating an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote": { "description": "A note about a conversation turn.", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote", "properties": { "turnIndex": { "type": "integer", "format": "int32", "description": "The conversation turn index that the note is associated with." } }, "type": "object" }, "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", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage", "properties": { "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "chartSpec": { "type": "object", "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "type": "object", "description": "Optional. User provided chart spec", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "conversation": { "type": "string", "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse", "properties": { "generativeResponses": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" }, "description": "The full list of generative responses. Each response is ordered by time." }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript" } } }, "GoogleCloudContactcenterinsightsV1Issue": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1Issue", "properties": { "sampleUtterances": { "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayDescription": { "description": "Representative description of 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" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated.", "readOnly": true } }, "description": "The issue resource." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "Metadata for deploying an issue model." }, "GoogleCloudCesV1mainBlob": { "type": "object", "id": "GoogleCloudCesV1mainBlob", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "format": "byte", "type": "string", "description": "Required. Raw bytes of the blob." } }, "description": "Represents a blob input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "type": "object", "description": "The response for listing feedback labels." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" }, "type": "array" }, "joinKeyResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" }, "description": "A list of join key correlation results for each conversation tested." } }, "description": "Wrapper for detailed, step-by-step results." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "properties": { "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." }, "transcriptIndex": { "type": "integer", "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero." } }, "description": "A point in a conversation that marks the start or the end of an annotation." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "description": "Request to export an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "properties": { "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination" }, "name": { "description": "Required. The issue model to export.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "type": "object", "description": "Response from import issue model" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions", "properties": { "conversationDataOptions": { "description": "Options for configuring the conversation data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" } }, "description": "Options for configuring the data used to generate the QA question." }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "description": "Google Cloud Storage Object URI to save the issue model to." }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "description": "The request to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation", "properties": { "messages": { "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "description": "The messages in the turn." }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "type": "object", "description": "The CES diagnostic information." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource", "properties": { "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "format": "double", "type": "number" }, "sourceType": { "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" ], "description": "What created the score." }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "type": "array" }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" } }, "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." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "text": { "description": "The text output from the LLM.", "items": { "type": "string" }, "type": "array" }, "textType": { "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "type": "string", "description": "The type of text output." } }, "type": "object", "description": "Wrapper for text output." }, "GoogleCloudCesV1mainMessage": { "type": "object", "id": "GoogleCloudCesV1mainMessage", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "chunks": { "description": "Optional. Content of the message as a series of chunks.", "items": { "$ref": "GoogleCloudCesV1mainChunk" }, "type": "array" }, "eventTime": { "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "format": "google-datetime", "type": "string" } }, "description": "A message within a conversation." }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "description": "The results for each correlation rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" }, "type": "array" } }, "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "description": "An answer to a QaQuestion.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaAnswer", "properties": { "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } }, "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" }, "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" } }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "description": "Statistics for IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "properties": { "processedObjectCount": { "format": "int32", "type": "integer", "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true, "format": "int32", "type": "integer" }, "duplicatesSkippedCount": { "type": "integer", "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "readOnly": true }, "failedIngestCount": { "format": "int32", "type": "integer", "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" }, "type": "array", "description": "The results for each applicable constraint rule." } }, "type": "object", "description": "The result of testing a constraint expression on a pair of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse": { "description": "Response to list assistant sessions.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.", "type": "string" }, "assistantSessions": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "description": "The assistant sessions." } } }, "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse": { "description": "The response of listing phrase matchers.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse", "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" }, "phraseMatchers": { "description": "The phrase matchers that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion", "properties": { "answerChoices": { "description": "A list of valid answers to the question, which the LLM must choose from.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" }, "type": "array" }, "updateTime": { "description": "Output only. The most recent time at which the question was updated.", "readOnly": true, "format": "google-datetime", "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" }, "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" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" }, "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" }, "order": { "format": "int32", "type": "integer", "description": "Defines the order of the question within its parent scorecard revision." }, "answerInstructions": { "description": "Instructions describing how to determine the answer.", "type": "string" }, "predefinedQuestionConfig": { "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question." }, "name": { "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "type": "string" }, "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" ] }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which this question was created.", "readOnly": true } }, "type": "object", "description": "A single question to be scored by the Insights QA feature." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { "description": "The request to initialize a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "description": "The request for updating a QaQuestionTag.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "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", "format": "google-fieldmask", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "labeledConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations attached to the issue at this point in time." }, "displayName": { "description": "Display name of the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData", "properties": { "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "confidenceScore": { "type": "number", "format": "double", "description": "The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "reply": { "description": "The content of the reply.", "type": "string" } }, "description": "Agent Assist Smart Reply data." }, "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse": { "description": "The response from a GenerateConversationSignedAudio request.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse", "properties": { "signedAudioUris": { "description": "The signed uris for the audio.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "type": "object", "description": "The metadata from querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true, "format": "int32", "type": "integer" }, "failedSampleCount": { "format": "int32", "type": "integer", "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.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "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": { "type": "number", "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100]." }, "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" } }, "description": "Message for sampling conversations." }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "properties": { "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "score": { "type": "number", "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." } }, "type": "object", "description": "Information about the issue." }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata", "properties": { "totalRequestedAnalysesCount": { "type": "integer", "format": "int32", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "completedAnalysesCount": { "format": "int32", "type": "integer", "description": "The number of requested analyses that have completed successfully so far." }, "relabel": { "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "format": "int32", "type": "integer" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "readOnly": true } }, "type": "object", "description": "The metadata for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec" } }, "type": "object", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource", "properties": { "sourceType": { "description": "What created the answer.", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "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": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" } }, "type": "object", "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer." }, "GoogleCloudCesV1mainChunk": { "id": "GoogleCloudCesV1mainChunk", "properties": { "payload": { "type": "object", "description": "Optional. Custom payload data.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "defaultVariables": { "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "toolResponse": { "description": "Optional. Tool execution response.", "$ref": "GoogleCloudCesV1mainToolResponse" }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "text": { "description": "Optional. Text data.", "type": "string" }, "blob": { "description": "Optional. Blob data.", "$ref": "GoogleCloudCesV1mainBlob" }, "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.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "type": "object", "description": "A chunk of content within a message." }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange": { "description": "Relative date range configuration.", "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange", "properties": { "unit": { "type": "string", "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "description": "Required. The unit of time." }, "quantity": { "format": "int64", "type": "string", "description": "Required. The quantity of units in the past." } }, "type": "object" }, "GoogleRpcStatus": { "type": "object", "id": "GoogleRpcStatus", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" } }, "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)." }, "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.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage", "properties": { "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "chartSpec": { "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", "properties": {}, "type": "object", "description": "The response to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "description": "Request to import an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest", "properties": { "conversation": { "description": "Required. Conversation data to test rules against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } }, "description": "The request message for testing auto labeling rules." }, "GoogleCloudContactcenterinsightsV1alpha1Chart": { "description": "Configurable dashboard's widget that displays data as a chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Chart", "properties": { "displayName": { "description": "User provided display name of the chart.", "type": "string" }, "width": { "description": "The width of the chart in grid units.", "format": "int32", "type": "integer" }, "action": { "description": "Optional action to be taken when the chart is clicked.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartAction" }, "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "height": { "description": "The height of the chart in grid units.", "format": "int32", "type": "integer" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Chart create time.", "readOnly": true }, "chartVisualizationType": { "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" ], "description": "Chart visualization type." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Chart last update time.", "readOnly": true }, "description": { "description": "Chart description", "type": "string" }, "chartType": { "enumDescriptions": [ "Unspecified chart type.", "Pre-defined chart type.", "Configurable chart type." ], "type": "string", "enum": [ "CHART_TYPE_UNSPECIFIED", "SYSTEM_DEFINED", "USER_DEFINED" ], "description": "Output only. Chart type.", "readOnly": true }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource" }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" } } }, "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1Issue" } }, "type": "object", "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "properties": { "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" }, "runIssueModelAnnotator": { "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA 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" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "phraseMatchers": { "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "items": { "type": "string" }, "type": "array" }, "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" } } }, "type": "object", "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig", "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" }, "customerChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "format": "int32", "type": "integer" }, "agentChannel": { "format": "int32", "type": "integer", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." } } }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } }, "type": "object", "description": "Dialogflow interaction data." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" } }, "description": "The metadata for an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1QaQuestionTag": { "id": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "properties": { "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" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated.", "readOnly": true }, "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "items": { "type": "string" }, "type": "array" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "createTime": { "description": "Output only. The time at which the question tag was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The update time of the conversation.", "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The create time of the conversation.", "readOnly": true }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" }, "description": "Ordered list of messages, including user inputs and system responses." } }, "type": "object", "description": "The conversation transcript for the chart." }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "description": "The response to an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "properties": { "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true, "type": "string" }, "correlationTypes": { "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.", "readOnly": true, "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" ] }, "type": "array" }, "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" } }, "description": "Info for correlating across conversations." }, "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest", "properties": {}, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1SampleRule": { "description": "Message for sampling conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleRule", "properties": { "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "format": "double", "type": "number" }, "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "dimension": { "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", "type": "string" }, "conversationFilter": { "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "properties": { "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "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" }, "uploadConversationAnalysisPercentage": { "format": "double", "type": "number", "description": "Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100]." }, "runtimeIntegrationAnalysisPercentage": { "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "format": "double", "type": "number" } }, "type": "object", "description": "Default configuration when creating Analyses in Insights." }, "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.", "id": "GoogleCloudContactcenterinsightsV1Entity", "properties": { "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "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" ] }, "metadata": { "type": "object", "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "additionalProperties": { "type": "string" } }, "salience": { "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number", "format": "float" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" } }, "type": "object", "description": "The data for an issue match annotation." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "description": "The user message." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "properties": { "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GcsSource" }, "turnLevelAudios": { "description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "type": "array" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } }, "type": "object", "description": "The conversation source, which is a combination of transcript and audio." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "description": "The request to deploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1Note": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Note", "properties": { "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "noteCreator": { "description": "Output only. The user that created the note.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1UserInfo" }, "conversationTurnNote": { "description": "The note is associated with a conversation turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the note was created.", "readOnly": true }, "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote" }, "content": { "description": "The note content.", "type": "string" }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "updateTime": { "description": "Output only. The time at which the note was last updated.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "The conversation assessment note resource." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "properties": { "failedSampleCount": { "type": "integer", "format": "int32", "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "readOnly": true }, "successfulSampleCount": { "format": "int32", "type": "integer", "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true } }, "type": "object", "description": "Statistics for SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule": { "description": "The data for a phrase match rule.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule", "properties": { "negated": { "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", "type": "boolean" }, "config": { "description": "Provides additional information about the rule that specifies how to apply the rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig" }, "query": { "description": "Required. The phrase to be matched.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "format": "int32", "type": "integer" }, "correlatedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations correlated." }, "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.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "type": "array" } }, "type": "object", "description": "Statistics for TestCorrelationConfig operation." }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer", "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer." }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" }, "type": "array" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" } }, "type": "object", "description": "An answer to a QaQuestion." }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest": { "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest", "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "type": "number", "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } }, "description": "Dialogflow interaction data." }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource": { "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource", "properties": { "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "bucketObjectType": { "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "type": "string", "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`." }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "customMetadataKeys": { "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.", "type": "array", "items": { "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "description": "Metadata about the conversation profile dimension." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest", "properties": { "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" } }, "description": "Request to import an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights": { "description": "Request that use natural language query to generate the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "properties": { "sqlQuery": { "description": "SQL query used to generate the chart.", "type": "string" }, "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" }, "chartConversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" }, "description": "Output only. The chart conversations used to generate the chart.", "readOnly": true, "deprecated": true, "type": "array" }, "chartSpec": { "type": "object", "description": "Chart spec for the chart.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } }, "description": "Metadata about the Conversational Agents playbook dimension." }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "description": "A Dialogflow source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "properties": { "dialogflowConversation": { "type": "string", "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "readOnly": true }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "description": "Average QA normalized score for the tag.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } }, "type": "object", "description": "Average QA normalized score for the tag." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "description": "The response for generative insights.", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" }, "type": "array" }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse", "properties": { "conversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "type": "array", "description": "The conversations that match the request." }, "nextPageToken": { "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", "type": "string" } }, "type": "object", "description": "The response of listing conversations." }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", "properties": { "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" }, "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" } }, "description": "Metadata about the Conversational Agents playbook dimension." }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The time at which the analysis ended." }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata" } }, "description": "The result of an analysis." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "description": "The response to an SampleConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "description": "Metadata about the client sentiment category dimension." }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource", "properties": { "sourceType": { "type": "string", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer." }, "answerValue": { "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" } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "properties": { "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true, "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true } }, "description": "The metadata for an `UploadConversation` operation." }, "GoogleCloudCesV1mainEndSession": { "type": "object", "id": "GoogleCloudCesV1mainEndSession", "properties": { "metadata": { "type": "object", "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "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." }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "description": "Agent Assist Smart Compose suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "properties": { "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "format": "double", "type": "number", "description": "The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "metadata": { "type": "object", "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "description": "The metadata for generative insights." }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "description": "Metadata for creating an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata", "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleIamV1Binding": { "id": "GoogleIamV1Binding", "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": { "type": "array", "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`." }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "type": "object", "description": "Associates `members`, or principals, with a `role`." }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource": { "description": "Google Sheets document details to get the feedback label file from.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" }, "type": "array" }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" } } }, "GoogleCloudContactcenterinsightsV1IntentMatchData": { "id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "type": "object", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences." }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource": { "description": "The entity whose performance is being queried is a single agent.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource", "properties": { "agentId": { "description": "Required. Agent id to query performance overview for.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries": { "description": "A time series representing conversations over time.", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "properties": { "intervalDuration": { "type": "string", "format": "google-duration", "description": "The duration of each interval." }, "points": { "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", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult", "properties": { "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "score": { "format": "double", "type": "number", "description": "The overall numerical score of the result, incorporating any manual edits if they exist." }, "normalizedScore": { "format": "double", "type": "number", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist." }, "scoreSources": { "description": "List of all individual score sets.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" }, "type": "array" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" } }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "type": "array" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "readOnly": true, "format": "google-datetime", "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" }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" } }, "type": "object" }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", "properties": { "metadata": { "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "additionalProperties": { "type": "string" }, "type": "object" }, "salience": { "type": "number", "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient." }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "type": { "description": "The entity type.", "enumDescriptions": [ "Unspecified.", "Person.", "Location.", "Organization.", "Event.", "Artwork.", "Consumer product.", "Other types of entities.", "Phone number. The metadata lists the phone number (formatted according to local convention), plus whichever additional elements appear in the text: * `number` - The actual number, broken down into sections according to local convention. * `national_prefix` - Country code, if detected. * `area_code` - Region or area code, if detected. * `extension` - Phone extension (to be dialed after connection), if detected.", "Address. The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - Street number. * `locality` - City or town. * `street_name` - Street/route name, if detected. * `postal_code` - Postal code, if detected. * `country` - Country, if detected. * `broad_region` - Administrative area, such as the state, if detected. * `narrow_region` - Smaller administrative area, such as county, if detected. * `sublocality` - Used in Asian addresses to demark a district within a city, if detected.", "Date. The metadata identifies the components of the date: * `year` - Four digit year, if detected. * `month` - Two digit month number, if detected. * `day` - Two digit day number, if detected.", "Number. The metadata is the number itself.", "Price. The metadata identifies the `value` and `currency`." ], "enum": [ "TYPE_UNSPECIFIED", "PERSON", "LOCATION", "ORGANIZATION", "EVENT", "WORK_OF_ART", "CONSUMER_GOOD", "OTHER", "PHONE_NUMBER", "ADDRESS", "DATE", "NUMBER", "PRICE" ], "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationParticipant", "properties": { "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "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" ], "type": "string", "description": "The role of the participant." }, "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" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" } }, "description": "The call participant speaking for a given utterance." }, "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]", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", "properties": { "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" }, "type": "array" }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse": { "description": "The response of listing issue models.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse", "properties": { "issueModels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "type": "array", "description": "The issue models that match the request." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "The metadata for deleting a QaQuestionTag Resource." }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "description": "Request to upload a conversation.", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "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" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversation" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata", "properties": { "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "description": "A text output message from the system.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "text": { "items": { "type": "string" }, "type": "array", "description": "The parts of the message." }, "textType": { "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message." } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "description": "Metadata about the QA scorecard dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "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" ], "type": "string", "description": "Required. The medium transcript objects represent." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SilenceData": { "description": "The data for a silence annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SilenceData", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { "description": "Message representing a possible answer to the question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice", "properties": { "score": { "type": "number", "format": "double", "description": "Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused." }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "numValue": { "format": "double", "type": "number", "description": "Numerical value." }, "strValue": { "description": "String value.", "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" }, "key": { "description": "A short string used as an identifier.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse", "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" }, "qaQuestions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "type": "array", "description": "The QaQuestions under the parent." } }, "description": "The response from a ListQaQuestions request." }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "type": { "description": "The type of the entity mention.", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "description": "Call-specific metadata.", "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "properties": { "agentChannel": { "description": "The audio channel that contains the agent.", "format": "int32", "type": "integer" }, "customerChannel": { "type": "integer", "format": "int32", "description": "The audio channel that contains the customer." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "properties": { "issueId": { "description": "The issue ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } }, "type": "object", "description": "Metadata about the issue dimension." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse", "properties": {}, "description": "The response to an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult", "properties": { "ruleId": { "description": "The rule ID.", "type": "string" }, "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "description": "Metadata about the conversation medium dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "description": "The request for deleting a QaQuestionTag.", "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "type": "object", "description": "The user message." }, "GoogleCloudContactcenterinsightsV1Dimension": { "id": "GoogleCloudContactcenterinsightsV1Dimension", "properties": { "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata" }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata" }, "dimensionKey": { "type": "string", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "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." }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata" }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata" } }, "type": "object", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses." }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "type": "object", "description": "Response from import issue model" }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "description": "Agent Assist Article Suggestion data.", "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "properties": { "title": { "description": "Article title.", "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" }, "confidenceScore": { "format": "float", "type": "number", "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "metadata": { "type": "object", "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" } }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "properties": { "skipValue": { "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "readOnly": true, "type": "boolean" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "score": { "description": "Output only. Numerical score of the answer.", "readOnly": true, "format": "double", "type": "number" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "normalizedScore": { "type": "number", "format": "double", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "readOnly": true }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "readOnly": true, "type": "number", "format": "double" }, "strValue": { "description": "String value.", "type": "string" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "numValue": { "type": "number", "format": "double", "description": "Numerical value." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "description": "The analysis resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "readOnly": true }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" }, "requestTime": { "description": "Output only. The time at which the analysis was requested.", "readOnly": true, "format": "google-datetime", "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" }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages", "properties": { "systemMessages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" }, "description": "A message from the system in response to the user." } }, "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig": { "description": "Configuration for diagnostic metrics.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "properties": { "metrics": { "description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition" }, "type": "object" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest", "properties": { "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" }, "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" }, "naturalLanguageQuery": { "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored.", "type": "string" }, "userProvidedChartSpec": { "type": "object", "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" }, "chart": { "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "filter": { "description": "Filter for the data that can be specified in addition to the natural language query. Users are encouraged to use this field to populate time-windows.", "type": "string" }, "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" }, "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" } }, "type": "object", "description": "The request for generative insights." }, "GoogleCloudContactcenterinsightsV1alpha1ChartAction": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" }, "conversationFilter": { "description": "The conversation filter string.", "type": "string" } }, "type": "object", "description": "The action to be taken when the chart is clicked." }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "properties": { "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest" }, "failedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed to be exported." }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during export operation that might cause the operation output to be incomplete." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "Metadata for an export insights operation." }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse", "properties": {}, "type": "object", "description": "The response to deploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "properties": {}, "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1mainIntent": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIntent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" }, "id": { "description": "The unique identifier of the intent.", "type": "string" } }, "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE." }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "description": "A segment of a full transcript.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "properties": { "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "text": { "description": "The text of this segment.", "type": "string" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" } }, "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" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "description": "The conversation resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "properties": { "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "labels": { "type": "object", "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "additionalProperties": { "type": "string" } }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript" }, "duration": { "description": "Output only. The duration of the conversation.", "readOnly": true, "format": "google-duration", "type": "string" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo" }, "updateTime": { "description": "Output only. The most recent time at which the conversation was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "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" ] }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "metadataJson": { "description": "Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the conversation was created.", "readOnly": true }, "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" }, "dialogflowIntents": { "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "type": "object" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData" }, "runtimeAnnotations": { "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" } }, "ttl": { "type": "string", "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time." }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "type": "integer", "format": "int32" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig", "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" }, "customerChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "format": "int32", "type": "integer" }, "agentChannel": { "type": "integer", "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." } }, "type": "object", "description": "Configuration that applies to all conversations." }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1InterruptionData", "properties": {}, "description": "The data for an interruption annotation." }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "properties": { "score": { "format": "double", "type": "number", "description": "The score the tag applies to." }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "potentialScore": { "type": "number", "format": "double", "description": "The potential score the tag applies to." } }, "description": "Tags and their corresponding results." }, "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "properties": { "correctnessLevel": { "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer." }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "properties": { "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "type": "array" }, "conversationA": { "description": "The first conversation resource name.", "type": "string" } }, "description": "The result of testing a constraint expression on a pair of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest", "properties": {}, "type": "object", "description": "The message to appeal an assessment." }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "description": "Information about an agent involved in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo", "properties": { "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" }, "location": { "description": "The agent's location.", "type": "string" }, "team": { "deprecated": true, "type": "string", "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field." }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "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" ] }, "teams": { "description": "User-specified strings representing the agent's teams.", "items": { "type": "string" }, "type": "array" }, "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" } } }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "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", "format": "google-fieldmask", "type": "string" } }, "description": "The request for updating a QaQuestionTag." }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "type": "object", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "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" }, "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "properties": { "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" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "textSections": { "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "additionalProperties": { "type": "string" }, "type": "object" }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" } } }, "GoogleCloudCesV1mainAgentTransfer": { "type": "object", "id": "GoogleCloudCesV1mainAgentTransfer", "properties": { "displayName": { "type": "string", "description": "Output only. Display name of the agent.", "readOnly": true }, "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" } }, "description": "Represents an event indicating the transfer of a conversation to a different agent." }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "completedAnalysesCount": { "type": "integer", "format": "int32", "description": "The number of requested analyses that have completed successfully so far." }, "relabel": { "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", "type": "string" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "totalRequestedAnalysesCount": { "type": "integer", "format": "int32", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse", "properties": {}, "type": "object", "description": "The response for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo", "properties": { "agentType": { "description": "The agent type, e.g. HUMAN_AGENT.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "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" }, "teams": { "items": { "type": "string" }, "type": "array", "description": "User-specified strings representing the agent's teams." }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "location": { "description": "The agent's location.", "type": "string" }, "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "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" } }, "type": "object", "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "description": "Metadata for an export insights operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "completedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were exported successfully." }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "format": "int32", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "description": "The request to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "properties": { "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "type": "string", "description": "Required. The medium transcript objects represent." } }, "description": "Configuration for processing transcript objects." }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1Dimension", "properties": { "clientSentimentCategoryDimensionMetadata": { "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata" }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata" }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata" }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata" }, "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" ], "type": "string", "description": "The key of the dimension." }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "The response for listing all feedback labels." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" } }, "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage", "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "readOnly": true, "type": "string", "format": "google-datetime" }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages" } } }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "properties": { "annotations": { "description": "A list of call annotations that apply to this call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" }, "type": "array" }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "type": "object" }, "phraseMatchers": { "type": "object", "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" } }, "intents": { "type": "object", "description": "All the matched intents in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" } }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" }, "sentiments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" }, "type": "array", "description": "Overall conversation-level sentiment for each channel of the call." }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" } } }, "description": "Call-specific metadata created during analysis." }, "GoogleCloudContactcenterinsightsV1alpha1QueryInterval": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. The start time of the time window." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. The end time of the time window." } }, "description": "A time window for querying conversations." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "properties": { "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "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" }, "exportSchemaVersion": { "description": "Optional. Version of the export schema.", "type": "string", "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "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" ] }, "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" ] }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage": { "description": "The user message.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "properties": {}, "description": "Response for an export insights operation." }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "properties": { "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" ] }, "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" }, "teams": { "description": "User-specified strings representing the agent's teams.", "type": "array", "items": { "type": "string" } }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "location": { "description": "The agent's location.", "type": "string" }, "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "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" } }, "type": "object", "description": "Information about an agent involved in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "properties": { "agentChannel": { "description": "The audio channel that contains the agent.", "type": "integer", "format": "int32" }, "customerChannel": { "description": "The audio channel that contains the customer.", "format": "int32", "type": "integer" } }, "description": "Call-specific metadata." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest": { "description": "The request to test correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest", "properties": { "conversations": { "description": "Optional. A list of conversations to test against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "correlationConfig": { "description": "Required. The correlation config to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "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": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of conversations to sample when using the `filter`. If not set, defaults to 1000. Values greater than 1000 are coerced to 1000. This field is ignored if `conversations` is provided." } } }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "description": "The request to deploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule": { "description": "Rule for auto-labeling conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule", "properties": { "conditions": { "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", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition" } }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which this rule was created.", "readOnly": true }, "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" }, "updateTime": { "description": "Output only. The most recent time at which the rule was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "active": { "description": "Whether the rule is active.", "type": "boolean" }, "labelKeyType": { "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ], "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "type": "string", "description": "The type of the label key." }, "displayName": { "description": "The user-provided display name of the rule.", "type": "string" }, "description": { "description": "The description of the rule.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p90": { "description": "The 90th percentile value.", "format": "double", "type": "number" }, "p99": { "format": "double", "type": "number", "description": "The 99th percentile value." }, "p50": { "description": "The 50th percentile value.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse": { "description": "The response to list datasets.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "datasets": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "description": "The datasets that match the request." } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } }, "description": "The data for an issue match annotation." }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "description": "Response for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse": { "description": "The response of listing views.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse", "properties": { "analysisRules": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "The analysis_rule that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest", "properties": { "maxDownloadCount": { "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "format": "int32", "type": "integer" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination" }, "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" }, "feedbackLabelType": { "type": "string", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded." }, "templateQaScorecardId": { "items": { "type": "string" }, "type": "array", "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored." }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination" }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata": { "description": "Metadata about the Conversational Agents tool dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig": { "description": "A list of correlation rules for a given correlation type.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig", "properties": { "correlationRules": { "description": "A list of correlation rules to be evaluated for correlation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "properties": { "exportSchemaVersion": { "description": "Optional. Version of the export schema.", "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "type": "string" }, "writeDisposition": { "description": "Options for what to do if the destination table already exists.", "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "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" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "description": "A point in a conversation that marks the start or the end of an annotation.", "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "properties": { "transcriptIndex": { "format": "int32", "type": "integer", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero." }, "wordIndex": { "type": "integer", "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "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" ] }, "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" } } }, "GoogleProtobufEmpty": { "type": "object", "id": "GoogleProtobufEmpty", "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" }, "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "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" } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "description": "Call-specific metadata created during analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "properties": { "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" } }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" } }, "entities": { "type": "object", "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" } }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "type": "object" }, "intents": { "type": "object", "description": "All the matched intents in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" } }, "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" } } } }, "GoogleCloudContactcenterinsightsV1mainEncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", "type": "string" } }, "type": "object", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata", "properties": { "request": { "description": "Output only. The original request for delete.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest" }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during deletion operation that might cause the operation output to be incomplete." } }, "description": "Metadata for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the correlation config was created.", "readOnly": true }, "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the correlation config was last updated.", "readOnly": true }, "fullConversationConfig": { "description": "The correlation type config for full conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig" } }, "type": "object", "description": "A configuration that defines how to correlate conversations for a given a given project." }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "properties": { "channelTag": { "description": "The channel of the audio that the data applies to.", "format": "int32", "type": "integer" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" } } }, "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", "id": "GoogleTypeExpr", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "location": { "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" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination": { "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse", "properties": { "qaScorecards": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "The QaScorecards under the parent." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "The response from a ListQaScorecards request." }, "GoogleCloudContactcenterinsightsV1alpha1Widget": { "description": "Represents a dashboard element, could be a nested Container or Chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1Widget", "properties": { "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "chartReference": { "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "container": { "description": "A container widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "chart": { "description": "A chart widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule": { "description": "A correlation rule that defines how to join conversations for a given correlation type.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule", "properties": { "ruleId": { "description": "Required. The unique identifier of the rule.", "type": "string" }, "constraintExpression": { "description": "Optional. A cel expression (go/cel) to be evaluated as a boolean value. Two variables conversation_a and conversation_b will be available for evaluation. This expression should evaluate to true if conversation_a and conversation_b should be joined. This is used as an extra constraint on top of the join_key_expression to further refine the group of conversations that are joined together and will be evaluated in both directions. for two conversations c1 and c2 and the result will be OR'd. We will evaluate: f(c1, c2) OR f(c2, c1)", "type": "string" }, "active": { "description": "Optional. Whether the config is active to be evaluated.", "type": "boolean" }, "joinKeyExpression": { "description": "Optional. A cel expression (go/cel) to be evaluated as a string value. This string value will be used as the join key for the correlation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "type": "object", "description": "Metadata from Dialogflow relating to the current transcript segment." }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "properties": { "successfulSampleCount": { "type": "integer", "format": "int32", "description": "Output only. The number of new conversations added during this sample operation.", "readOnly": true }, "failedSampleCount": { "format": "int32", "type": "integer", "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.", "readOnly": true } }, "type": "object", "description": "Statistics for SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." } }, "description": "Metadata used for import issue model." }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "description": "The metadata for a bulk delete conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1alpha1Settings": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Settings", "properties": { "diagnosticMetricConfig": { "description": "Optional. Configuration for diagnostic metrics.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig" }, "pubsubNotificationSettings": { "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"ingest-conversations\": Notify each time an IngestConversations LRO is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO is complete. * \"update-or-analyze-conversation\": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "additionalProperties": { "type": "string" }, "type": "object" }, "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" }, "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" }, "analysisConfig": { "description": "Default analysis settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig" }, "updateTime": { "description": "Output only. The time at which the settings were last updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "createTime": { "description": "Output only. The time at which the settings was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "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" }, "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" }, "conversationTtl": { "description": "The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.", "format": "google-duration", "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" }, "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" } }, "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)." }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "description": "Wrapper for storing the generative response for a chart.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse", "properties": { "textMessage": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "chartSpec": { "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "textOutput": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "deprecated": true, "type": "string" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "completedAnalysesCount": { "format": "int32", "type": "integer", "description": "The number of requested analyses that have completed successfully so far." }, "relabel": { "type": "boolean", "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "The time the operation finished running." }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "totalRequestedAnalysesCount": { "format": "int32", "type": "integer", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request." }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" } }, "description": "The metadata for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1mainConversation": { "description": "The conversation resource.", "id": "GoogleCloudContactcenterinsightsV1mainConversation", "properties": { "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "readOnly": true }, "labels": { "type": "object", "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "additionalProperties": { "type": "string" } }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata" }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" }, "duration": { "description": "Output only. The duration of the conversation.", "readOnly": true, "type": "string", "format": "google-duration" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata" }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "ttl": { "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "format": "google-duration", "type": "string" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis" }, "turnCount": { "type": "integer", "format": "int32", "description": "Output only. The number of turns in the conversation.", "readOnly": true }, "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" ], "type": "string", "description": "Immutable. The conversation medium." }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "metadataJson": { "description": "Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "createTime": { "description": "Output only. The time at which the conversation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "expireTime": { "type": "string", "format": "google-datetime", "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted." }, "dialogflowIntents": { "type": "object", "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" } }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "runtimeAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource", "properties": { "dialogflowConversation": { "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "readOnly": true, "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "description": "A Dialogflow source of conversation data." }, "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote": { "description": "A note about a QA question.", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote", "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation": { "description": "The conversation used to generate the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "The update time of the conversation." }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" }, "description": "Ordered list of messages, including user inputs and system responses." }, "createTime": { "format": "google-datetime", "type": "string", "description": "The create time of the conversation." } } }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", "properties": {}, "type": "object", "description": "The response to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "properties": { "unclassifiedConversationsCount": { "format": "int64", "type": "string", "description": "Number of analyzed conversations for which no issue was applicable at this point in time." }, "issueStats": { "type": "object", "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" } }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true } }, "type": "object", "description": "Metadata for deploying an issue model." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "type": "number", "format": "double", "description": "Average tag normalized score per tag." } }, "description": "Average QA normalized score for the tag." }, "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse": { "description": "The response of listing charts.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse", "properties": { "charts": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "The charts under the parent." }, "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" } } }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "properties": { "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "querySource": { "description": "Query source for the answer.", "type": "string", "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" ] } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint", "properties": { "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse": { "description": "The response of testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponse", "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.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "description": "Metadata about conversation labels." }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage", "properties": { "chunks": { "description": "Required. Content of the message.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk" } }, "eventTime": { "type": "string", "format": "google-datetime", "description": "Required. Timestamp when the message was sent or received." }, "role": { "description": "Required. Role within the conversation.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The user role.", "The model role." ], "enum": [ "ROLE_UNSPECIFIED", "USER", "MODEL" ] } }, "description": "A message in an assistant session." }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "description": "The response for querying performance overview." }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest": { "description": "The request for bulk uploading feedback labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest", "properties": { "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" }, "gcsSource": { "description": "A cloud storage bucket source.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "description": "Metadata about the Conversational Agents tool dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "textType": { "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message." }, "text": { "type": "array", "items": { "type": "string" }, "description": "The parts of the message." } }, "type": "object", "description": "A text output message from the system." }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } }, "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "properties": { "silenceDuration": { "description": "Amount of time calculated to be in silence.", "format": "google-duration", "type": "string" }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "format": "float", "type": "number" } }, "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "properties": { "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "querySource": { "description": "Query source for the answer.", "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "type": "string" } }, "type": "object", "description": "Explicit input used for generating the answer" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource", "properties": { "sourceType": { "description": "What created the answer.", "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "properties": { "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during deletion operation that might cause the operation output to be incomplete." }, "request": { "description": "Output only. The original request for delete.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" } }, "type": "object" }, "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.", "id": "GoogleCloudContactcenterinsightsV1SpeechConfig", "properties": { "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" }, "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback." }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "format": "int32", "type": "integer", "description": "Count of Ai Coach Suggestion that has been used by agents." }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "format": "int32", "type": "integer" }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "format": "int32", "type": "integer" }, "averageSummarizationSuggestionEditDistance": { "format": "double", "type": "number", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion." }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations scanned by the AA human supervisor." }, "averageQaNormalizedScore": { "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, "averageAgentSentimentScore": { "format": "float", "type": "number", "description": "The average agent's sentiment score." }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "type": "number", "format": "double" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "knowledgeAssistUriClickRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "format": "double", "type": "number" }, "knowledgeAssistNegativeFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "format": "int32", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "format": "double", "type": "number" }, "containedConversationCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were contained." }, "dialogflowAverageWebhookLatency": { "type": "number", "format": "double", "description": "Average latency of dialogflow webhook calls." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "type": "number", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion." }, "aiCoachSuggestionMessageTriggerCount": { "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion." }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were escalated to an AA human supervisor for intervention." }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "format": "float", "type": "number" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "type": "number", "description": "Proportion of dialogflow webhook calls that timed out." }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "format": "double", "type": "number" }, "conversationCount": { "type": "integer", "format": "int32", "description": "The conversation count." }, "conversationSuggestedSummaryRatio": { "type": "number", "format": "double", "description": "Proportion of conversations that had a suggested summary." }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "format": "double", "type": "number" }, "conversationTotalAgentMessageCount": { "type": "integer", "format": "int32", "description": "The agent message count." }, "aaSupervisorDroppedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor." }, "aiCoachSuggestionAgentUsageRatio": { "format": "double", "type": "number", "description": "Proportion of Ai Coach Suggestion that has been used by agents." }, "averageQaQuestionNormalizedScore": { "format": "double", "type": "number", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID." }, "summarizationSuggestionEditRatio": { "format": "double", "type": "number", "description": "Proportion of summarization suggestions that were manually edited." }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "description": "Proportion of conversations that has Ai Coach Suggestions.", "format": "double", "type": "number" }, "conversationalAgentsAverageTtsLatency": { "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "format": "double", "type": "number" }, "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" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "averageSilencePercentage": { "type": "number", "format": "float", "description": "The average silence percentage." }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "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" }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "type": "number", "format": "double" }, "conversationalAgentsAverageEndToEndLatency": { "type": "number", "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level." }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "type": "number", "format": "double" }, "averageDuration": { "description": "The average duration.", "format": "google-duration", "type": "string" }, "averageTurnCount": { "description": "The average turn count.", "type": "number", "format": "float" }, "averageSummarizationSuggestionNormalizedEditDistance": { "type": "number", "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length)." }, "dialogflowConversationsEscalationCount": { "type": "number", "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent." }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "format": "double", "type": "number" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "type": "number", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations." } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } }, "type": "object", "description": "Request for the BulkDeleteFeedbackLabels endpoint." }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "description": "The response to an SampleConversations operation.", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "description": "Issue Modeling result on a conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult", "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "description": "All the matched issues.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "description": "The issue model resource.", "id": "GoogleCloudContactcenterinsightsV1mainIssueModel", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "readOnly": true, "type": "string", "format": "int64" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "description": "Output only. State of the model.", "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." ] }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] }, "languageCode": { "description": "Language of the model.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "readOnly": true }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition": { "description": "A definition for a metric to be calculated during analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition", "properties": { "displayName": { "type": "string", "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "readOnly": true }, "sourceId": { "type": "string", "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1RedirectAction": { "description": "The redirect action to be taken when the chart is clicked.", "id": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction", "properties": { "queryParams": { "description": "The query params to be added to the redirect path.", "additionalProperties": { "type": "string" }, "type": "object" }, "relativePath": { "description": "The relative path to redirect to.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination", "properties": { "recordsPerFileCount": { "description": "Optional. The number of records per file. Applicable for either format.", "format": "int64", "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": { "description": "Required. File format in which the labels will be exported.", "type": "string", "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "properties": { "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" }, "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" } }, "description": "Request to import an issue model." }, "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)", "id": "GoogleCloudContactcenterinsightsV1Dataset", "properties": { "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Dataset create time.", "readOnly": true }, "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" ], "type": "string", "description": "Dataset usage type." }, "ttl": { "type": "string", "format": "google-duration", "description": "Optional. Option TTL for the dataset." }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "updateTime": { "description": "Output only. Dataset update time.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "properties": { "processedObjectCount": { "format": "int32", "type": "integer", "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true, "format": "int32", "type": "integer" }, "duplicatesSkippedCount": { "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "readOnly": true, "type": "integer", "format": "int32" }, "failedIngestCount": { "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "readOnly": true, "type": "integer", "format": "int32" } }, "description": "Statistics for IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "properties": { "summarizationModel": { "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "type": "string", "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" }, "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint", "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "dialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations", "properties": { "conversations": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "type": "array", "description": "Optional. The conversations." } }, "type": "object", "description": "Wrapper for a list of conversations." }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment", "properties": { "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" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "format": "float", "type": "number" }, "text": { "description": "The text of this segment.", "type": "string" }, "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" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "words": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" }, "type": "array", "description": "A list of the word-specific information for each word in the segment." }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "messageTime": { "description": "The time that the message occurred, if provided.", "type": "string", "format": "google-datetime" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" } }, "type": "object", "description": "A segment of a full transcript." }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "properties": { "texts": { "items": { "type": "string" }, "type": "array", "description": "The parts of the message." }, "type": { "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "type": "string", "description": "The type of the text message." } }, "type": "object", "description": "A text output message from the system." }, "GoogleCloudCesV1mainToolCall": { "description": "Request for the client or the agent to execute the specified tool.", "type": "object", "id": "GoogleCloudCesV1mainToolCall", "properties": { "displayName": { "description": "Output only. Display name of the tool.", "readOnly": true, "type": "string" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "args": { "type": "object", "description": "Optional. The input parameters and values for the tool in JSON object format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" } } }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "description": "Call-specific metadata created during analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "properties": { "annotations": { "description": "A list of call annotations that apply to this call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" }, "type": "array" }, "sentiments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" }, "type": "array", "description": "Overall conversation-level sentiment for each channel of the call." }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" }, "type": "array" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence" }, "intents": { "description": "All the matched intents in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" }, "type": "object" }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "entities": { "description": "All the entities in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" }, "type": "object" }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "type": "object" } } }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "properties": { "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "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" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "question": { "description": "The corresponding FAQ question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "type": "object", "description": "Response from import issue model" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "description": "Statistics for BulkDownloadFeedbackLabels operation.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "properties": { "successfulDownloadCount": { "format": "int32", "type": "integer", "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error." }, "fileNames": { "description": "Output only. Full name of the files written to Cloud storage.", "readOnly": true, "items": { "type": "string" }, "type": "array" }, "processedObjectCount": { "type": "integer", "format": "int32", "description": "The number of objects processed during the download operation." }, "totalFilesWritten": { "description": "Total number of files written to the provided Cloud Storage bucket.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint": { "description": "The current chart checkpoint state.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint", "properties": { "revisionId": { "description": "The revision id of the chart.", "type": "string" }, "sessionId": { "description": "The session id of the chart.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "properties": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "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" }, "maxDeleteCount": { "format": "int32", "type": "integer", "description": "Maximum number of conversations to delete." } }, "description": "The request to delete conversations in bulk." }, "GoogleCloudContactcenterinsightsV1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1Intent", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "description": "Metadata about the client sentiment category dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "properties": {}, "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse", "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" } }, "description": "Response of querying an issue model's statistics." }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "properties": { "format": { "description": "Required. File format which will be ingested.", "type": "string", "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ] }, "objectUri": { "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`", "type": "string" } }, "type": "object", "description": "Google Cloud Storage Object details to get the feedback label file from." }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "description": "Metadata about the QA scorecard dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } } }, "GoogleIamV1TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "type": "object", "id": "GoogleIamV1TestIamPermissionsResponse", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } } }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "type": "object", "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest", "properties": {}, "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable." }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata", "properties": { "agentInfo": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" }, "description": "Information about agents involved in the call." }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer", "format": "int32" }, "waitDuration": { "format": "google-duration", "type": "string", "description": "The amount of time the customer waited to connect with an agent." }, "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "description": "Input only. The feedback labels associated with the conversation." } }, "type": "object", "description": "Conversation metadata related to quality management." }, "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "items": { "type": "string" }, "type": "array", "description": "List of QaScorecardRevisions." } }, "type": "object", "description": "Container for a list of scorecards." }, "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.", "id": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "description": "Metadata about the agent dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "properties": { "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" }, "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" }, "agentVersionId": { "description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "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" } } }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "description": "A BigQuery Table Reference.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "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" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice", "properties": { "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" }, "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimension" } }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries" } }, "type": "object", "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]" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest", "properties": { "timeGranularity": { "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "type": "string", "enumDescriptions": [ "The time granularity is unspecified and will default to NONE.", "No time granularity. The response won't contain a time series. This is the default value if no time granularity is specified.", "Data points in the time series will aggregate at a daily granularity. 1 day means [midnight to midnight).", "Data points in the time series will aggregate at a daily granularity. 1 HOUR means [01:00 to 02:00).", "Data points in the time series will aggregate at a daily granularity. PER_MINUTE means [01:00 to 01:01).", "Data points in the time series will aggregate at a 1 minute granularity. PER_5_MINUTES means [01:00 to 01:05).", "Data points in the time series will aggregate at a monthly granularity. 1 MONTH means [01st of the month to 1st of the next month)." ], "enum": [ "TIME_GRANULARITY_UNSPECIFIED", "NONE", "DAILY", "HOURLY", "PER_MINUTE", "PER_5_MINUTES", "MONTHLY" ] }, "dimensions": { "type": "array", "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." }, "measureMask": { "format": "google-fieldmask", "type": "string", "description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\"." }, "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" } }, "type": "object", "description": "The request for querying metrics." }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "labeledConversationsCount": { "type": "string", "format": "int64", "description": "Number of conversations attached to the issue at this point in time." }, "displayName": { "description": "Display name of the issue.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "description": "The request to ingest conversations.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "sampleSize": { "type": "integer", "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests." }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "description": "Request to export an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to export.", "type": "string" }, "gcsDestination": { "description": "Google Cloud Storage URI to export the issue model to.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" } } }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "conversation": { "type": "string", "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "properties": { "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" } }, "type": "object", "description": "Request to upload a conversation." }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata", "properties": { "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource", "properties": { "sourceType": { "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" ], "description": "What created the score." }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" }, "type": "array" }, "potentialScore": { "type": "number", "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result." }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "format": "double", "type": "number" } }, "type": "object", "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores." }, "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse": { "description": "Response from streaming chat.", "id": "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse", "properties": { "chunk": { "description": "A chunk of the assistant response message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk" }, "eventTime": { "format": "google-datetime", "type": "string", "description": "The time when the event occurred." }, "statusMessage": { "description": "A status message.", "type": "string" }, "eventId": { "description": "The unique ID of the event.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", "properties": {}, "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "properties": { "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats" }, "request": { "description": "Output only. The original request for ingest.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" }, "sampledConversations": { "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true, "items": { "type": "string" }, "type": "array" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "properties": { "messages": { "description": "The messages in the turn.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" } }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "type": "object", "description": "The CES diagnostic information." }, "GoogleCloudContactcenterinsightsV1GcsSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1GcsSource", "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" } }, "description": "A Cloud Storage source of conversation data." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment", "properties": { "channelTag": { "description": "The channel of the audio that the data applies to.", "type": "integer", "format": "int32" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris": { "id": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris", "properties": { "signedGcsAudioUri": { "description": "The signed URI for the audio from the Cloud Storage conversation source.", "type": "string" }, "signedTurnLevelAudios": { "description": "The signed URI for the audio corresponding to each turn in the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" } }, "signedDialogflowAudioUri": { "description": "The signed URI for the audio from the Dialogflow conversation source.", "type": "string" } }, "type": "object", "description": "Signed audio URIs for a conversation." }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse", "properties": {}, "description": "The response to undeploy an issue model." }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "description": "The conversation source, which is a combination of transcript and audio.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "properties": { "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1GcsSource" }, "turnLevelAudios": { "description": "Cloud Storage URIs that points to files that contain the conversation audio for each turn. Assume the order of the URIs is the same as the order of the transcript turns.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" }, "type": "array" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote", "properties": {}, "description": "A note about the entire parent assessment." }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssue" } }, "type": "object", "description": "The request to create an issue." }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata", "properties": { "request": { "description": "Output only. The original request for sample conversations to dataset.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true } }, "description": "The metadata for an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" }, "description": "The results for each correlation rule." } }, "type": "object", "description": "The result of testing correlation config on a single conversation." }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", "properties": {}, "description": "The metadata for querying performance overview." }, "GoogleIamV1AuditLogConfig": { "id": "GoogleIamV1AuditLogConfig", "properties": { "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" ] }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1alpha1AssistantSession": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession", "properties": { "name": { "description": "Identifier. Resource name of the session. Format: projects/{project}/locations/{location}/assistantSessions/{assistant_session}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the session was last updated.", "readOnly": true }, "messages": { "description": "Optional. History of messages in the session.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantMessage" }, "type": "array" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the session was created.", "readOnly": true }, "displayName": { "description": "Optional. The display name of the session.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "IDLE" ], "description": "Output only. The status of the session.", "readOnly": true, "enumDescriptions": [ "Unspecified state.", "Agent is working.", "Waiting for user input." ] }, "requester": { "type": "string", "description": "Output only. The user who initiated the session.", "readOnly": true } }, "description": "Represents a conversation session with the Assistant Agent." }, "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "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" } }, "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." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "properties": { "dataPoints": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "description": "The data points that make up the time series ." } }, "description": "A time series of metric values." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata", "properties": { "errorMessages": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "The error message when the generative insights request fails." } }, "type": "object", "description": "The metadata for generative insights." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" } }, "type": "object", "description": "Metadata for testing correlation config." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse": { "description": "The response for querying metrics.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "properties": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" }, "slices": { "type": "array", "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." } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "properties": { "transcriptSegments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" }, "type": "array", "description": "A list of sequential transcript segments that comprise the conversation." } }, "description": "A message representing the transcript of a conversation." }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "description": "The result of a single constraint rule on the pair of conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult", "properties": { "ruleId": { "description": "The rule ID.", "type": "string" }, "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "description": "The CES diagnostic information.", "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation", "properties": { "messages": { "items": { "$ref": "GoogleCloudCesV1mainMessage" }, "type": "array", "description": "The messages in the turn." }, "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse": { "description": "The response from a ListAuthorizedViews request.", "id": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata", "properties": { "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "request": { "description": "Output only. The original request for delete.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "description": "The request to create an issue.", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "properties": { "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "parent": { "description": "Required. The parent resource of the issue.", "type": "string" } }, "type": "object" }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "GoogleLongrunningOperation", "properties": { "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "labeledConversationsCount": { "format": "int64", "type": "string", "description": "Number of conversations attached to the issue at this point in time." }, "displayName": { "description": "Display name of the issue.", "type": "string" } }, "description": "Aggregated statistics about an issue." }, "GoogleCloudContactcenterinsightsV1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SentimentData", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, "score": { "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "format": "float", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo", "properties": { "endOffset": { "type": "string", "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation." }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "format": "float", "type": "number" }, "startOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the start of this word relative to the beginning of the total conversation." }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" } }, "type": "object", "description": "Word-level info for words in a transcript." }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "properties": { "magnitude": { "type": "number", "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score." }, "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." } }, "type": "object", "description": "The data for a sentiment annotation." }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "properties": { "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "score": { "type": "number", "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist." }, "normalizedScore": { "type": "number", "format": "double", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist." }, "scoreSources": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" }, "type": "array", "description": "List of all individual score sets." }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "type": "array" }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array", "description": "Collection of tags and their scores." }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "potentialScore": { "format": "double", "type": "number", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse", "properties": { "nextPageToken": { "description": "The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.", "type": "string" }, "dashboards": { "description": "The dashboards under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "type": "array" } }, "description": "The response of listing dashboards." }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse": { "description": "The response message for testing auto labeling rules.", "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse", "properties": { "labelResult": { "description": "The result of the test auto labeling rule.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse", "properties": { "textOutput": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "deprecated": true, "type": "string" }, "generatedSqlQuery": { "description": "The generated SQL query from the LLM. Will be populated during the chart building phase. The generated SQL will be cached in the corresponding chart resource.", "type": "string" }, "chartSpec": { "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" } }, "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "description": "Message for sampling conversations.", "id": "GoogleCloudContactcenterinsightsV1mainSampleRule", "properties": { "sampleRow": { "type": "string", "format": "int64", "description": "Number of the conversations that we should sample based on the dimension." }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { "description": "Agent Assist Smart Reply data.", "id": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "properties": { "confidenceScore": { "description": "The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "double" }, "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "reply": { "description": "The content of the reply.", "type": "string" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "format": "google-duration", "type": "string" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "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" } }, "type": "object", "description": "Word-level info for words in a transcript." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats" }, "request": { "description": "Output only. The original request for download.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" } } }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "description": "Response for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "description": "Metadata used for export issue model." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "description": "An error that occurred during correlation for a specific conversation.", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" } } }, "GoogleCloudCesV1mainSpan": { "description": "A span is a unit of work or a single operation during the request processing.", "id": "GoogleCloudCesV1mainSpan", "properties": { "startTime": { "description": "Output only. The start time of the span.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The end time of the span.", "readOnly": true }, "attributes": { "description": "Output only. Key-value attributes associated with the span.", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "duration": { "type": "string", "format": "google-duration", "description": "Output only. The duration of the span.", "readOnly": true }, "name": { "type": "string", "description": "Output only. The name of the span.", "readOnly": true }, "childSpans": { "description": "Output only. The child spans that are nested under this span.", "readOnly": true, "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "type": "array" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" }, "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" } }, "type": "object", "description": "A data point contains the metric values mapped to an interval." }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "properties": { "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "analysisPercentage": { "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "format": "float", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "properties": { "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "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}", "deprecated": true, "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" ], "type": "string", "description": "The role of the participant." } }, "type": "object", "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo", "properties": { "startTime": { "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created.", "type": "string", "format": "google-datetime" }, "endTime": { "type": "string", "format": "google-datetime", "description": "End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted." }, "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" }, "timeZone": { "description": "The timezone to use for the groc expression. If not specified, defaults to UTC.", "type": "string" } }, "type": "object", "description": "Message for schedule info." }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse": { "description": "The response from a ListAuthorizedViewSet request.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse", "properties": { "authorizedViewSets": { "description": "The AuthorizedViewSets under the parent.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "properties": { "successfulDownloadCount": { "format": "int32", "type": "integer", "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error." }, "fileNames": { "type": "array", "items": { "type": "string" }, "description": "Output only. Full name of the files written to Cloud storage.", "readOnly": true }, "totalFilesWritten": { "format": "int32", "type": "integer", "description": "Total number of files written to the provided Cloud Storage bucket." }, "processedObjectCount": { "format": "int32", "type": "integer", "description": "The number of objects processed during the download operation." } }, "description": "Statistics for BulkDownloadFeedbackLabels operation." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "type": "array", "items": { "type": "string" }, "description": "List of QaScorecardRevisions." } } }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "properties": { "correctnessLevel": { "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer." }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" }, "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", "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" } }, "type": "object", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match." }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", "properties": { "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "confidenceScore": { "type": "number", "format": "float", "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } } }, "GoogleCloudContactcenterinsightsV1alpha1Assessment": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Assessment", "properties": { "name": { "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the assessment was last updated.", "readOnly": true }, "agentInfo": { "description": "Information about the agent the assessment is for.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "createTime": { "description": "Output only. The time at which the assessment was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "state": { "enumDescriptions": [ "The state is unspecified. This value should not be used.", "The default state of all new assessments.", "The assessment has been published.", "The assessment has been appealed.", "The assessment has been finalized." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED", "APPEALED", "FINALIZED" ], "description": "Output only. The state of the assessment.", "readOnly": true } }, "description": "The assessment resource." }, "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.", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule", "properties": { "createTime": { "description": "Output only. The time at which this analysis rule was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "displayName": { "description": "Display Name of the analysis rule.", "type": "string" }, "conversationFilter": { "description": "Filter for the conversations that should apply this analysis rule. An empty filter means this analysis rule applies to all conversations. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "annotatorSelector": { "description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "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.", "format": "double", "type": "number" }, "name": { "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which this analysis rule was updated.", "readOnly": true }, "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "description": "The request for deleting a QaQuestionTag.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval": { "description": "A single interval in a time series.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval", "properties": { "conversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations created in this interval." }, "startTime": { "format": "google-datetime", "type": "string", "description": "The start time of this interval." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "textType": { "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message." }, "text": { "items": { "type": "string" }, "type": "array", "description": "The parts of the message." } }, "description": "A text output message from the system." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "type": "array" } }, "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "conversationCorrelationErrors": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "description": "A list of errors that occurred during correlation, one for each conversation that failed." }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "type": "integer", "format": "int32" }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "properties": { "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" }, "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" } }, "description": "Metadata about the Conversational Agents tool dimension." }, "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "properties": { "textSections": { "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "additionalProperties": { "type": "string" }, "type": "object" }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "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" }, "metadata": { "type": "object", "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } } }, "GoogleCloudCesV1mainImage": { "id": "GoogleCloudCesV1mainImage", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp", "type": "string" }, "data": { "type": "string", "format": "byte", "description": "Required. Raw bytes of the image." } }, "type": "object", "description": "Represents an image input or output in the conversation." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "properties": { "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "customMetadataKeys": { "items": { "type": "string" }, "type": "array", "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation." }, "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "transcriptBucketUri": { "description": "Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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": { "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" ], "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": "object", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "properties": { "score": { "format": "double", "type": "number", "description": "Output only. Numerical score of the answer.", "readOnly": true }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "normalizedScore": { "format": "double", "type": "number", "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "readOnly": true }, "skipValue": { "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "readOnly": true, "type": "boolean" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "numValue": { "description": "Numerical value.", "format": "double", "type": "number" }, "potentialScore": { "format": "double", "type": "number", "description": "Output only. The maximum potential score of the question.", "readOnly": true }, "strValue": { "description": "String value.", "type": "string" }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "properties": { "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true, "type": "string" }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true, "type": "string" }, "correlationTypes": { "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.", "readOnly": true, "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" ] }, "type": "array" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" } }, "type": "object", "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "id": "GoogleCloudContactcenterinsightsV1alpha1Issue", "properties": { "sampleUtterances": { "items": { "type": "string" }, "type": "array", "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "readOnly": true }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayDescription": { "description": "Representative description of 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" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time that this issue was updated.", "readOnly": true } }, "type": "object", "description": "The issue resource." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "properties": { "textMessage": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput" }, "chartSpec": { "type": "object", "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textOutput": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "deprecated": true, "type": "string" }, "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" } }, "type": "object", "description": "Wrapper for storing the generative response for a chart." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData", "properties": {}, "type": "object", "description": "The data for a silence annotation." }, "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { "description": "The metadata from querying metrics.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata", "properties": {}, "type": "object", "description": "The metadata for querying performance overview." }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", "properties": { "successfulAnalysisCount": { "format": "int32", "type": "integer", "description": "Count of successful analyses." }, "failedAnalysisCount": { "format": "int32", "type": "integer", "description": "Count of failed analyses." } }, "description": "The response for a bulk analyze conversations operation." }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "id": "GoogleCloudContactcenterinsightsV1DialogflowSource", "properties": { "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, "dialogflowConversation": { "type": "string", "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModel": { "description": "The issue model resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModel", "properties": { "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "type": "string", "description": "Output only. State of the model.", "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." ] }, "modelType": { "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model." }, "languageCode": { "description": "Language of the model.", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "readOnly": true, "type": "string", "format": "int64" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination", "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" } }, "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult", "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" } }, "type": "object", "description": "The result of a single constraint rule on the pair of conversations." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "joinKeyResults": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" }, "description": "A list of join key correlation results for each conversation tested." }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" } } }, "type": "object", "description": "Wrapper for detailed, step-by-step results." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "description": "The request to ingest conversations.", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest", "properties": { "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" }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "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" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to" } }, "type": "object", "description": "The request for updating a QaQuestionTag." }, "GoogleIamV1AuditConfig": { "id": "GoogleIamV1AuditConfig", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "type": "array", "items": { "$ref": "GoogleIamV1AuditLogConfig" } } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "properties": { "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA 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" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment 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" }, "phraseMatchers": { "type": "array", "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}" }, "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" } }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" } }, "type": "object", "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse", "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" }, "assessments": { "description": "The assessments that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "type": "array" } }, "description": "The response of listing assessments." }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "properties": { "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "description": "The feedback labels that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "The response for listing all feedback labels." }, "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", "id": "GoogleIamV1Policy", "properties": { "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" }, "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" }, "type": "array", "description": "Specifies cloud audit logging configuration for this policy." }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage", "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "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." }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage" }, "systemMessage": { "description": "A message from the system in response to the user.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage" } }, "description": "The message in the conversation." }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "properties": { "metadata": { "type": "object", "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "additionalProperties": { "type": "string" } }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "confidenceScore": { "format": "float", "type": "number", "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)." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "question": { "description": "The corresponding FAQ question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "description": "The response to undeploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest", "properties": { "templateQaScorecardId": { "items": { "type": "string" }, "type": "array", "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored." }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "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" }, "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "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" }, "feedbackLabelType": { "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "type": "string", "description": "Optional. The type of feedback labels that will be downloaded." }, "maxDownloadCount": { "format": "int32", "type": "integer", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded." } }, "type": "object", "description": "Request for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1Container": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Container", "properties": { "height": { "description": "The height of the container in grid units.", "format": "int32", "type": "integer" }, "containerId": { "description": "Output only. Unique ID for the container.", "readOnly": true, "type": "string" }, "width": { "format": "int32", "type": "integer", "description": "The width of the container in grid units." }, "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" }, "widgets": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Widget" }, "description": "Widgets in the Container." }, "description": { "description": "Container description", "type": "string" }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" } }, "description": "Configurable dashboard's container. Container can contain multiple widgets." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" }, "type": "array" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." }, "sampledConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations sampled." }, "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "failedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed correlation." } }, "description": "Statistics for TestCorrelationConfig operation." }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } }, "description": "An error that occurred during correlation for a specific conversation." }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData", "properties": { "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "format": "double", "type": "number", "description": "The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "type": "object", "description": "Agent Assist Smart Compose suggestion data." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "properties": { "sheetsDestination": { "description": "A sheets document destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "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" }, "feedbackLabelType": { "type": "string", "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded." }, "maxDownloadCount": { "type": "integer", "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded." }, "templateQaScorecardId": { "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" } }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "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" } }, "type": "object", "description": "Request for the BulkDownloadFeedbackLabel endpoint." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "description": "The conversation transcript for the chart.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The update time of the conversation.", "readOnly": true }, "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "description": "Ordered list of messages, including user inputs and system responses.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage" } }, "createTime": { "description": "Output only. The create time of the conversation.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule", "properties": { "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which this assessment rule was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sampleRule": { "description": "The sample rule for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule" }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which this assessment rule was created.", "readOnly": true }, "displayName": { "description": "Display Name of the assessment rule.", "type": "string" } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1Conversation" }, "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" } }, "type": "object", "description": "Request to upload a conversation." }, "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk": { "description": "A chunk of data in an assistant message.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AssistantChunk", "properties": { "text": { "description": "Optional. Text data.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "properties": { "agentChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer", "format": "int32" }, "agentId": { "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" }, "customerChannel": { "type": "integer", "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed." } }, "type": "object", "description": "Configuration that applies to all conversations." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "description": "The request to delete an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "properties": { "request": { "description": "Output only. The original request for initialization.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during initializing operation that might cause the operation output to be incomplete." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time the operation was created." }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "type": "object", "description": "Metadata used for import issue model." }, "GoogleCloudContactcenterinsightsV1mainIssueModelResult": { "description": "Issue Modeling result on a conversation.", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "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" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest": { "description": "The request for summarizing performance according to different metrics for conversations over a specified time window.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest", "properties": { "filter": { "description": "Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.", "type": "string" }, "agentPerformanceSource": { "description": "Conversations are from a single agent.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource" }, "queryInterval": { "description": "Required. The time window of the conversations to derive performance stats from.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "comparisonQueryInterval": { "description": "The time window of the conversations to compare the performance to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "description": "The conversation transcript for the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "properties": { "conversationId": { "description": "The conversation id of the chart.", "type": "string" }, "messages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "type": "array", "description": "Ordered list of messages, including user inputs and system responses." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The create time of the conversation.", "readOnly": true }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The update time of the conversation.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", "properties": { "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "readOnly": true }, "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "type": "array", "items": { "type": "string" } }, "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" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time at which the question tag was updated.", "readOnly": true } }, "type": "object", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage", "properties": { "userProvidedChartSpec": { "type": "object", "description": "Optional. User provided chart spec", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "chartSpec": { "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "readOnly": true }, "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats" }, "request": { "description": "Output only. The original request for ingest.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "sampledConversations": { "items": { "type": "string" }, "type": "array", "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true } }, "description": "The metadata for an IngestConversations operation." }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData", "properties": { "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" } }, "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match." }, "GoogleCloudCesV1mainToolResponse": { "description": "The execution result of a specific tool from the client or the agent.", "type": "object", "id": "GoogleCloudCesV1mainToolResponse", "properties": { "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" }, "displayName": { "type": "string", "description": "Output only. Display name of the tool.", "readOnly": true }, "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" }, "response": { "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } } }, "GoogleIamV1TestIamPermissionsRequest": { "type": "object", "id": "GoogleIamV1TestIamPermissionsRequest", "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" } } }, "description": "Request message for `TestIamPermissions` method." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", "properties": { "potentialScore": { "format": "double", "type": "number", "description": "The potential score the tag applies to." }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "score": { "format": "double", "type": "number", "description": "The score the tag applies to." } }, "type": "object" }, "GoogleCloudCesV1mainToolsetTool": { "description": "A tool that is created from a toolset.", "id": "GoogleCloudCesV1mainToolsetTool", "properties": { "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" }, "toolId": { "description": "Optional. The tool ID to filter the tools to retrieve the schema for.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition": { "description": "Condition for auto-labeling conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition", "properties": { "value": { "description": "CEL expression to be evaluated as the value.", "type": "string" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet": { "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet", "properties": { "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Update time.", "readOnly": true }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" }, "createTime": { "description": "Output only. Create time.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources." }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "description": "Metadata used for export issue model.", "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1View": { "description": "The View resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1View", "properties": { "name": { "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the view was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "displayName": { "description": "The human-readable display name of the view.", "type": "string" }, "createTime": { "description": "Output only. The time at which this view was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "properties": { "systemMessages": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "type": "array", "description": "A message from the system in response to the user." } }, "type": "object", "description": "A wrapper for system messages per turn." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata", "properties": { "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "agentInfo": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" }, "type": "array", "description": "Information about agents involved in the call." }, "customerSatisfactionRating": { "format": "int32", "type": "integer", "description": "An arbitrary integer value indicating the customer's satisfaction rating." }, "waitDuration": { "type": "string", "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent." }, "feedbackLabels": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Input only. The feedback labels associated with the conversation." } } }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult", "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" } }, "type": "object", "description": "The result of a single constraint rule on the pair of conversations." }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "description": "Default summarization model to be used.", "enumDeprecated": [ false, true, true ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } }, "type": "object", "description": "Configuration for summarization." }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "description": "Agent Assist Article Suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "properties": { "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "additionalProperties": { "type": "string" }, "type": "object" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, "confidenceScore": { "type": "number", "format": "float", "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "title": { "description": "Article title.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest": { "description": "Request for TuneQaScorecardRevision endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest", "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" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object", "description": "Google Cloud Storage Object URI to get the issue model file from." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "description": "Configs for the input data used to create the issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "properties": { "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "format": "int64", "type": "string", "description": "Output only. Number of conversations used in training. Output only.", "readOnly": true }, "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" ], "deprecated": true, "type": "string", "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`." } }, "type": "object" }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "properties": { "datasetValidationWarnings": { "items": { "type": "string", "enumDescriptions": [ "Unspecified data validation warning.", "A non-trivial percentage of the feedback labels are invalid.", "The quantity of valid feedback labels provided is less than the recommended minimum.", "One or more of the answers have less than the recommended minimum of feedback labels.", "All the labels in the dataset come from a single answer choice." ], "enum": [ "DATASET_VALIDATION_WARNING_UNSPECIFIED", "TOO_MANY_INVALID_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" ] }, "type": "array", "description": "A list of any applicable data validation warnings about the question's feedback labels." }, "totalValidLabelCount": { "format": "int64", "type": "string", "description": "Total number of valid labels provided for the question at the time of tuining." }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "properties": { "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "description": "The request to sample conversations to a dataset." }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "request": { "description": "Output only. The original request for initialization.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "description": "Metadata for initializing a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "description": "Metadata for creating an issue.", "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse", "properties": { "qaScorecardRevisions": { "description": "The QaScorecards under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "The response from a ListQaScorecardRevisions request." }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "properties": { "unclassifiedConversationsCount": { "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "format": "int64", "type": "string" }, "issueStats": { "type": "object", "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" } }, "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string", "format": "int64" } }, "description": "Aggregated statistics about an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "properties": { "fullConversationCorrelationId": { "type": "string", "description": "Output only. The full conversation correlation id this conversation is a segment of.", "readOnly": true }, "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "readOnly": true, "type": "string" }, "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" ] }, "type": "array", "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "readOnly": true } }, "type": "object" }, "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", "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "description": "Metadata from Dialogflow relating to the current transcript segment." }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "createTime": { "description": "Output only. Create time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "updateTime": { "description": "Output only. Update time of the label.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization." }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "description": "The request to ingest conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "sampleSize": { "format": "int32", "type": "integer", "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." }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource" }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" } } }, "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource", "properties": { "generativeInsights": { "description": "Use natural language query to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights" }, "queryMetrics": { "description": "Use the existing QueryMetrics to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics" } }, "type": "object", "description": "The request data for visualizing the dataset in the chart." }, "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData": { "description": "Dialogflow interaction data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "format": "float", "type": "number", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain)." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", "properties": { "channelTag": { "format": "int32", "type": "integer", "description": "The channel of the audio that the data applies to." }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "description": "One channel of conversation-level sentiment data." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse", "properties": { "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" }, "type": "array" }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "updateTime": { "description": "The metrics last update time.", "format": "google-datetime", "type": "string" }, "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" } }, "description": "The response for querying metrics." }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "properties": { "relativeDateRange": { "description": "A relative date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange" }, "absoluteDateRange": { "description": "An absolute date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" } }, "type": "object", "description": "Date range configuration for dashboard charts." }, "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest", "properties": { "message": { "description": "Required. The message to send to the assistant.", "type": "string" } }, "type": "object", "description": "Request to stream chat." }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "properties": { "issueId": { "description": "The issue ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "description": "The response for querying metrics.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse", "properties": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "updateTime": { "description": "The metrics last update time.", "type": "string", "format": "google-datetime" }, "macroAverageSlice": { "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, "slices": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, "type": "array", "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "description": "The data for a sentiment annotation.", "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, "score": { "type": "number", "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive)." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "type": "string", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "description": "Default summarization model to be used.", "enumDeprecated": [ false, true, true ], "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" } }, "type": "object" }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "properties": { "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "type": "array", "description": "A list of operations that matches the specified filter in the request." }, "unreachable": { "items": { "type": "string" }, "type": "array", "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." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object", "description": "The response message for Operations.ListOperations." }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "description": "Metadata for creating an issue." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats" }, "request": { "description": "Output only. The original request for ingest.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" }, "sampledConversations": { "type": "array", "items": { "type": "string" }, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "readOnly": true } } }, "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", "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView", "properties": { "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the authorized view was created.", "readOnly": true }, "name": { "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the authorized view was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "conversationFilter": { "description": "A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "properties": { "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, "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" } }, "type": "object", "description": "A BigQuery Table Reference." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "type": "object", "description": "Metadata about the client sentiment category dimension." }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "type": "object", "description": "The request to delete an issue model." }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "properties": { "metadata": { "type": "object", "description": "A map that contains metadata about the summarization and the document from which it originates.", "additionalProperties": { "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" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "textSections": { "type": "object", "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "additionalProperties": { "type": "string" } }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" } } }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "description": "A Cloud Storage source of conversation data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse", "properties": { "successfulAnalysisCount": { "description": "Count of successful analyses.", "type": "integer", "format": "int32" }, "failedAnalysisCount": { "format": "int32", "type": "integer", "description": "Count of failed analyses." } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "properties": { "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization annotator.", "type": "boolean" }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA 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" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment 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" }, "phraseMatchers": { "items": { "type": "string" }, "type": "array", "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}" }, "issueModels": { "type": "array", "items": { "type": "string" }, "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference." }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" } }, "description": "Selector of all available annotators and phrase matchers to run." }, "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse": { "description": "The response of listing notes.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse", "properties": { "notes": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "type": "array", "description": "The notes that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "properties": { "errorMessages": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "The error message when the generative insights request fails." } }, "description": "The metadata for generative insights." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecard": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard", "properties": { "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the scorecard was updated.", "readOnly": true }, "source": { "description": "Output only. The source of the scorecard.", "readOnly": true, "type": "string", "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "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." ] }, "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" }, "description": { "description": "A text description explaining the intent of the scorecard.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which this scorecard was created.", "readOnly": true } }, "type": "object", "description": "A QaScorecard represents a collection of questions to be scored during analysis." }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", "properties": { "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true, "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true } }, "description": "The metadata for an `UploadConversation` operation." }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "description": "The request to export insights.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "properties": { "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" }, "exportSchemaVersion": { "description": "Optional. Version of the export schema.", "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "type": "string" }, "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" ] }, "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" }, "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions", "properties": { "includeDialogflowInteractionData": { "description": "Whether to include the per turn Dialogflow interaction data in conversation transcript.", "type": "boolean" } }, "type": "object", "description": "Options for configuring what metadata is included in the conversation data used in QAI and Discovery Engine." }, "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.", "id": "GoogleTypeInterval", "properties": { "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "type": "string", "format": "google-duration", "description": "The duration of the audio." } }, "description": "A wrapper for holding the audio for any given turn." }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "description": "The response to an IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "properties": { "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "strValue": { "description": "String value.", "type": "string" }, "potentialScore": { "description": "Output only. The maximum potential score of the question.", "readOnly": true, "format": "double", "type": "number" }, "numValue": { "description": "Numerical value.", "format": "double", "type": "number" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "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.", "readOnly": true, "type": "boolean" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "normalizedScore": { "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "readOnly": true, "format": "double", "type": "number" }, "score": { "description": "Output only. Numerical score of the answer.", "readOnly": true, "format": "double", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" }, "type": "array", "description": "The results for each applicable constraint rule." } } }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "description": "A BigQuery Table Reference.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "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" } } }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "properties": { "qaQuestionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional." }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "readOnly": true }, "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" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time at which the question tag was updated.", "readOnly": true } }, "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc." }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest": { "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced.", "$ref": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec" } }, "type": "object", "description": "The request to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Metadata for undeploying an issue model." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics": { "description": "Request data that use the existing QueryMetrics.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics", "properties": { "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "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" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "description": "The request to delete conversations in bulk.", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "properties": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "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" }, "maxDeleteCount": { "format": "int32", "type": "integer", "description": "Maximum number of conversations to delete." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "properties": {}, "type": "object", "description": "The response to an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainIssue": { "description": "The issue resource.", "id": "GoogleCloudContactcenterinsightsV1mainIssue", "properties": { "displayDescription": { "description": "Representative description of 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" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated.", "readOnly": true }, "sampleUtterances": { "type": "array", "items": { "type": "string" }, "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "readOnly": true }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which this issue was created.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "properties": {}, "description": "The data for an interruption annotation." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "description": "Statistics for IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "properties": { "successfulIngestCount": { "type": "integer", "format": "int32", "description": "Output only. The number of new conversations added during this ingest operation.", "readOnly": true }, "duplicatesSkippedCount": { "type": "integer", "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "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.", "readOnly": true, "format": "int32", "type": "integer" }, "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "readOnly": true, "format": "int32", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "description": "The analysis resource.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "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": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "readOnly": true }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult" }, "requestTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which the analysis was requested.", "readOnly": true } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput", "properties": { "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "querySource": { "enumDescriptions": [ "Unknown query source.", "The query is from agents.", "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." ], "enum": [ "QUERY_SOURCE_UNSPECIFIED", "AGENT_QUERY", "SUGGESTED_QUERY" ], "type": "string", "description": "Query source for the answer." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimension": { "id": "GoogleCloudContactcenterinsightsV1mainDimension", "properties": { "conversationalAgentsPlaybookDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata" }, "issueDimensionMetadata": { "description": "Output only. Metadata about the issue dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata" }, "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata" }, "dimensionKey": { "type": "string", "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "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." }, "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata" }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" }, "conversationalAgentsToolDimensionMetadata": { "description": "Output only. Metadata about the Conversational Agents tool dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata" }, "clientSentimentCategoryDimensionMetadata": { "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata" }, "agentDimensionMetadata": { "description": "Output only. Metadata about the agent dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata" }, "qaScorecardDimensionMetadata": { "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" } }, "type": "object", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses." }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "properties": { "dimensions": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" }, "type": "array", "description": "A unique combination of dimensions that this slice represents." }, "timeSeries": { "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries" }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" } }, "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]" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel" } }, "type": "object", "description": "The request to create an issue model." }, "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource", "properties": { "normalizedScore": { "format": "double", "type": "number", "description": "The normalized score, which is the score divided by the potential score." }, "score": { "format": "double", "type": "number", "description": "The overall numerical score of the result." }, "sourceType": { "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" ], "description": "What created the score." }, "qaTagResults": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" }, "type": "array", "description": "Collection of tags and their scores." }, "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" } }, "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." }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "description": "The response to deploy an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher", "properties": { "roleMatch": { "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" ], "type": "string", "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." }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "activationUpdateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The most recent time at which the activation status was updated.", "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" }, "type": { "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" ], "type": "string", "description": "Required. The type of this phrase matcher." }, "revisionId": { "description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", "readOnly": true, "type": "string" }, "phraseMatchRuleGroups": { "description": "A list of phase match rule groups that are included in this matcher.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" } }, "revisionCreateTime": { "description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", "readOnly": true, "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the phrase matcher was updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" } }, "description": "The phrase matcher resource." }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage", "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "readOnly": true }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages" } }, "type": "object", "description": "The message in the conversation." }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "description": "The result of an analysis.", "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "properties": { "endTime": { "description": "The time at which the analysis ended.", "format": "google-datetime", "type": "string" }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest": { "description": "The request for calculating conversation statistics.", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } }, "textType": { "description": "The type of text output.", "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata", "properties": { "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse", "properties": { "nextPageToken": { "description": "The next page token.", "type": "string" }, "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" }, "type": "array", "description": "The feedback labels that match the request." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", "properties": { "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "potentialScore": { "format": "double", "type": "number", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation." }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "qaTagResults": { "description": "Collection of tags and their scores.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" }, "type": "array" }, "qaAnswers": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" }, "type": "array", "description": "Set of QaAnswers represented in the result." }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "format": "double", "type": "number" }, "scoreSources": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" }, "description": "List of all individual score sets." }, "score": { "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number", "format": "double" }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest": { "description": "The request to deploy a QaScorecardRevision", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p50": { "description": "The 50th percentile value.", "format": "double", "type": "number" }, "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." }, "p99": { "description": "The 99th percentile value.", "format": "double", "type": "number" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata", "properties": { "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest" }, "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" } }, "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "description": "A message representing the transcript of a conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "properties": { "transcriptSegments": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" }, "type": "array", "description": "A list of sequential transcript segments that comprise the conversation." } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata", "properties": { "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true } }, "description": "Metadata for creating an issue." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "type": "object", "description": "The metadata from querying metrics." }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "properties": { "analyzedConversationsCount": { "description": "Number of conversations the issue model has analyzed at this point in time.", "format": "int64", "type": "string" }, "unclassifiedConversationsCount": { "format": "int64", "type": "string", "description": "Number of analyzed conversations for which no issue was applicable at this point in time." }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "type": "object" } }, "type": "object", "description": "Aggregated statistics about an issue model." }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource", "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" }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "customMetadataKeys": { "type": "array", "items": { "type": "string" }, "description": "Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation." }, "bucketObjectType": { "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "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" } }, "type": "object", "description": "Configuration for Cloud Storage bucket sources." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "properties": { "spreadsheetUri": { "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" }, "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" } }, "type": "object", "description": "Google Sheets document details to write the feedback labels to." }, "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig": { "description": "Regex match configuration.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig", "properties": {} }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", "properties": { "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "properties": { "maxDeleteCount": { "type": "integer", "format": "int32", "description": "Maximum number of conversations to delete." }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "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" } }, "type": "object", "description": "The request to delete conversations in bulk." }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", "properties": { "kmsKey": { "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", "type": "string" }, "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "description": "The result of an analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The time at which the analysis ended." }, "callAnalysisMetadata": { "description": "Call-specific metadata created by the analysis.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "properties": { "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "score": { "type": "number", "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" } }, "description": "Information about the issue." }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse", "properties": {}, "type": "object", "description": "Response from export issue model" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "properties": { "potentialScore": { "description": "The potential score the tag applies to.", "type": "number", "format": "double" }, "score": { "type": "number", "format": "double", "description": "The score the tag applies to." }, "tag": { "description": "The tag the score applies to.", "type": "string" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "format": "double", "type": "number" } }, "type": "object", "description": "Tags and their corresponding results." }, "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", "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint." }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "properties": { "silenceDuration": { "format": "google-duration", "type": "string", "description": "Amount of time calculated to be in silence." }, "silencePercentage": { "format": "float", "type": "number", "description": "Percentage of the total conversation spent in silence." } }, "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", "type": "string" } }, "type": "object", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`)." }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "description": "Agent Assist Smart Reply data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "properties": { "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "additionalProperties": { "type": "string" }, "type": "object" }, "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" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "reply": { "description": "The content of the reply.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The time the operation finished running." }, "partialErrors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete." }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "The metadata for a bulk delete conversations operation." }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "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", "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." ] }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "format": "int64", "type": "string", "description": "Output only. Number of conversations used in training. Output only.", "readOnly": true } }, "type": "object", "description": "Configs for the input data used to create the issue model." }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "description": "Information about the issue.", "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment", "properties": { "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "score": { "type": "number", "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1]." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig", "properties": { "type": { "type": "string", "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent." ], "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" ], "description": "The type of the predefined question." } }, "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined." }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse": { "description": "The response for calculating conversation statistics.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse", "properties": { "smartHighlighterMatches": { "type": "object", "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", "additionalProperties": { "type": "integer", "format": "int32" } }, "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/`", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "type": "object" }, "conversationCount": { "description": "The total number of conversations.", "format": "int32", "type": "integer" }, "issueMatches": { "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "additionalProperties": { "type": "integer", "format": "int32" }, "deprecated": true, "type": "object" }, "averageDuration": { "format": "google-duration", "type": "string", "description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration." }, "averageTurnCount": { "type": "integer", "format": "int32", "description": "The average number of turns per conversation." }, "customHighlighterMatches": { "description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "conversationCountTimeSeries": { "description": "A time series representing the count of conversations created over time that match that requested filter criteria.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries" } } }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", "properties": {}, "description": "Response from export issue model" }, "GoogleCloudContactcenterinsightsV1alpha1Dataset": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset", "properties": { "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Dataset create time.", "readOnly": true }, "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" ], "description": "Dataset usage type." }, "ttl": { "type": "string", "format": "google-duration", "description": "Optional. Option TTL for the dataset." }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Dataset update time.", "readOnly": true } }, "type": "object", "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)" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", "properties": { "format": { "type": "string", "enumDescriptions": [ "Unspecified format.", "CSV format. 1,000 labels are stored per CSV file by default.", "JSON format. 1 label stored per JSON file by default." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format in which the labels will be exported." }, "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" }, "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": { "description": "Optional. The number of records per file. Applicable for either format.", "format": "int64", "type": "string" } }, "type": "object", "description": "Google Cloud Storage Object details to write the feedback labels to." }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "GoogleIamV1SetIamPolicyRequest", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" }, "updateMask": { "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" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" }, "type": "array" }, "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" }, "type": "array" } }, "description": "Wrapper for detailed, step-by-step results." }, "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig", "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "type": "object", "description": "Exact match configuration." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UserInfo": { "id": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "properties": { "username": { "description": "The user's username.", "type": "string" } }, "type": "object", "description": "Information about a user." }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse", "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" } }, "description": "The response from a ListQaQuestionTags request." }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Create time of the label.", "readOnly": true }, "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" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Update time of the label.", "readOnly": true } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse": { "description": "The response of listing assessment rules.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse", "properties": { "assessmentRules": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "The assessment rules that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "summarizationSuggestionResultCount": { "description": "Count of summarization suggestions results.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "format": "int32", "type": "integer" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "format": "double", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "containedConversationCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were contained." }, "avgConversationClientTurnSentimentEma": { "format": "double", "type": "number", "description": "The exponential moving average of the sentiment score of client turns in the conversation." }, "knowledgeSearchUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked." }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "knowledgeAssistNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "knowledgeAssistUriClickRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "conversationTotalCustomerMessageCount": { "format": "int32", "type": "integer", "description": "The customer message count." }, "dialogflowWebhookFailureRatio": { "type": "number", "format": "double", "description": "Proportion of dialogflow webhook calls that failed." }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "averageAgentSentimentScore": { "type": "number", "format": "float", "description": "The average agent's sentiment score." }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations scanned by the AA human supervisor." }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "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" }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "type": "integer", "description": "The number of conversations transferred to a human agent." }, "averageSummarizationSuggestionEditDistance": { "format": "double", "type": "number", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion." }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionCount": { "format": "int32", "type": "integer", "description": "Count of conversations that has Ai Coach Suggestions." }, "knowledgeSearchNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback." }, "knowledgeSearchAgentQuerySourceRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "format": "double", "type": "number" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "type": "number", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations." }, "dialogflowConversationsEscalationCount": { "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "averageTurnCount": { "type": "number", "format": "float", "description": "The average turn count." }, "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" }, "averageCustomerSatisfactionRating": { "type": "number", "format": "double", "description": "The average customer satisfaction rating." }, "conversationalAgentsAverageEndToEndLatency": { "type": "number", "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level." }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "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" }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "aiCoachSuggestionMessageTriggerRatio": { "format": "double", "type": "number", "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "conversationalAgentsAverageAudioInAudioOutLatency": { "type": "number", "format": "double", "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations." }, "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" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "format": "double", "type": "number" }, "averageQaQuestionNormalizedScore": { "format": "double", "type": "number", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID." }, "conversationAiCoachSuggestionRatio": { "format": "double", "type": "number", "description": "Proportion of conversations that has Ai Coach Suggestions." }, "aiCoachSuggestionAgentMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion." }, "aiCoachSuggestionAgentUsageRatio": { "type": "number", "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents." }, "knowledgeSearchResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user." }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "format": "int32", "type": "integer" }, "aaSupervisorDroppedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor." }, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, "conversationSuggestedSummaryRatio": { "format": "double", "type": "number", "description": "Proportion of conversations that had a suggested summary." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number", "format": "double" }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "format": "double", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "authorizedViews": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "type": "array", "description": "The AuthorizedViews under the parent." } }, "description": "The response from a ListAuthorizedViews request." }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1CallAnnotation", "properties": { "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1HoldData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "format": "int32", "type": "integer" }, "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" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1SilenceData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } }, "type": "object", "description": "A piece of metadata that applies to a window of a call." }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object", "description": "Google Cloud Storage Object URI to get the issue model file from." }, "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse": { "description": "The response message for listing auto labeling rules.", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse", "properties": { "autoLabelingRules": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "The auto labeling rules." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse", "properties": {}, "type": "object", "description": "Response from export issue model" }, "GoogleCloudContactcenterinsightsV1HoldData": { "id": "GoogleCloudContactcenterinsightsV1HoldData", "properties": {}, "type": "object", "description": "The data for a hold annotation." }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics": { "description": "A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics", "properties": { "accuracy": { "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "readOnly": true, "format": "double", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1EntityMentionData": { "id": "GoogleCloudContactcenterinsightsV1EntityMentionData", "properties": { "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "type": { "type": "string", "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "description": "The type of the entity mention." }, "entityUniqueId": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" } }, "type": "object", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation." }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig", "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." ], "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", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "trainingConversationsCount": { "type": "string", "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "readOnly": true } }, "description": "Configs for the input data used to create the issue model." }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision", "properties": { "state": { "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.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "EDITABLE", "TRAINING", "TRAINING_FAILED", "READY", "DELETING", "TRAINING_CANCELLED" ] }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The timestamp that the revision was created.", "readOnly": true }, "name": { "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, "alternateIds": { "type": "array", "items": { "type": "string" }, "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "readOnly": true }, "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" } }, "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." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "textType": { "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" ], "description": "The type of text output." }, "text": { "type": "array", "items": { "type": "string" }, "description": "The text output from the LLM." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "type": "object", "description": "Metadata about the QA scorecard dimension." }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "description": "The issue model resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "properties": { "state": { "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "description": "Output only. State of the model.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "type": "string" }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] }, "languageCode": { "description": "Language of the model.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "readOnly": true }, "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "readOnly": true, "type": "string", "format": "int64" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "trainingStats": { "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "readOnly": true, "format": "google-datetime", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA question dimension." }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "description": "Metadata about the conversation medium dimension." }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "description": "The request to delete an issue model.", "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "description": "The data for an interruption annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse", "properties": { "issues": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "type": "array", "description": "The issues that match the request." } }, "description": "The response of listing issues." }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "type": "object", "description": "Google Cloud Storage Object URI to get the issue model file from." }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "description": "The conversation source, which is a combination of transcript and audio.", "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "properties": { "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource" }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource" }, "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" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse", "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": { "description": "The views that match the request.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "type": "array" } }, "type": "object", "description": "The response of listing views." }, "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", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "properties": { "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup": { "description": "A message representing a rule in the phrase matcher.", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup", "properties": { "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" ] }, "phraseMatchRules": { "description": "A list of phrase match rules that are included in this group.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" } } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "description": "A Cloud Storage source of conversation data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "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" } } }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "properties": { "clicked": { "description": "Indicates whether an answer or item was clicked by the human agent.", "type": "boolean" }, "correctnessLevel": { "description": "The correctness level of an answer.", "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ] }, "displayed": { "description": "Indicates whether an answer or item was displayed to the human agent in the agent desktop UI.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "properties": { "silenceDuration": { "format": "google-duration", "type": "string", "description": "Amount of time calculated to be in silence." }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "format": "float", "type": "number" } }, "type": "object", "description": "Conversation-level silence data." }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "request": { "description": "Output only. The original request.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata": { "description": "Call-specific metadata.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "properties": { "customerChannel": { "description": "The audio channel that contains the customer.", "type": "integer", "format": "int32" }, "agentChannel": { "description": "The audio channel that contains the agent.", "type": "integer", "format": "int32" } } }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "request": { "description": "Output only. The original request for initialization.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { "endOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the end of this word relative to the beginning of the total conversation." }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "startOffset": { "format": "google-duration", "type": "string", "description": "Time offset of the start of this word relative to the beginning of the total conversation." } }, "description": "Word-level info for words in a transcript." }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "properties": { "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "dialogflowParticipant": { "deprecated": true, "type": "string", "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}" }, "role": { "description": "The role of the participant.", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "type": "string" } }, "type": "object", "description": "The call participant speaking for a given utterance." }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation", "properties": { "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "articleSuggestion": { "description": "Agent Assist Article Suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "createTime": { "description": "The time at which this annotation was created.", "format": "google-datetime", "type": "string" }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" } }, "type": "object", "description": "An annotation that was generated during the customer and agent interaction." }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1RedactionConfig", "properties": { "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" }, "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" } }, "type": "object", "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." }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "properties": { "turnCount": { "description": "Output only. The number of turns in the conversation.", "readOnly": true, "type": "integer", "format": "int32" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "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" }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "latestSummary": { "description": "Output only. Latest summary of the conversation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "runtimeAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "readOnly": true }, "dialogflowIntents": { "type": "object", "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" } }, "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" }, "createTime": { "description": "Output only. The time at which the conversation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "metadataJson": { "description": "Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "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" ] }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time at which the conversation was updated.", "readOnly": true }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "duration": { "description": "Output only. The duration of the conversation.", "readOnly": true, "type": "string", "format": "google-duration" }, "transcript": { "description": "Output only. The conversation transcript.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "labels": { "type": "object", "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "additionalProperties": { "type": "string" } } }, "type": "object", "description": "The conversation resource." }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse", "properties": { "analyses": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "description": "The analyses that match the request." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "The response to list analyses." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "dialogflowInteractionsNoInputRatio": { "format": "double", "type": "number", "description": "Proportion of dialogflow interactions that has empty input." }, "dialogflowWebhookTimeoutRatio": { "description": "Proportion of dialogflow webhook calls that timed out.", "format": "double", "type": "number" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "format": "double", "type": "number" }, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "conversationAiCoachSuggestionRatio": { "format": "double", "type": "number", "description": "Proportion of conversations that has Ai Coach Suggestions." }, "averageQaQuestionNormalizedScore": { "type": "number", "format": "double", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID." }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "format": "int32", "type": "integer", "description": "The agent message count." }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "type": "integer", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor." }, "knowledgeSearchResultCount": { "type": "integer", "format": "int32", "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user." }, "knowledgeAssistPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback." }, "aiCoachSuggestionAgentUsageRatio": { "type": "number", "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents." }, "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" }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "format": "double", "type": "number" }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "format": "double", "type": "number" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "type": "number", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level." }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "conversationalAgentsAverageTtsLatency": { "type": "number", "format": "double", "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations." }, "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" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "format": "double", "type": "number" }, "averageSilencePercentage": { "description": "The average silence percentage.", "format": "float", "type": "number" }, "dialogflowConversationsEscalationCount": { "type": "number", "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent." }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "type": "number", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations." }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made." }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "averageSummarizationSuggestionNormalizedEditDistance": { "type": "number", "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length)." }, "averageDuration": { "type": "string", "format": "google-duration", "description": "The average duration." }, "averageTurnCount": { "type": "number", "format": "float", "description": "The average turn count." }, "knowledgeAssistResultCount": { "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "format": "int32", "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.", "format": "double", "type": "number" }, "aaSupervisorTransferredToHumanAgentConvCount": { "type": "integer", "format": "int32", "description": "The number of conversations transferred to a human agent." }, "averageQaNormalizedScore": { "type": "number", "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." }, "qaTagScores": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "description": "Average QA normalized score for all the tags." }, "aaSupervisorMonitoredConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations scanned by the AA human supervisor." }, "knowledgeSearchNegativeFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "format": "double", "type": "number" }, "conversationAiCoachSuggestionCount": { "format": "int32", "type": "integer", "description": "Count of conversations that has Ai Coach Suggestions." }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "aaSupervisorAssignedConversationsCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor." }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "type": "number", "format": "double" }, "conversationTotalCustomerMessageCount": { "type": "integer", "format": "int32", "description": "The customer message count." }, "knowledgeAssistUriClickRatio": { "format": "double", "type": "number", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked." }, "knowledgeAssistNegativeFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback." }, "averageAgentSentimentScore": { "type": "number", "format": "float", "description": "The average agent's sentiment score." }, "containedConversationCount": { "type": "integer", "format": "int32", "description": "The number of conversations that were contained." }, "knowledgeSearchUriClickRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "knowledgeSearchPositiveFeedbackRatio": { "type": "number", "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback." }, "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" }, "averageClientSentimentScore": { "type": "number", "format": "float", "description": "The average client's sentiment score." }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "aiCoachSuggestionMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion." }, "dialogflowAverageWebhookLatency": { "format": "double", "type": "number", "description": "Average latency of dialogflow webhook calls." }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "format": "int32", "type": "integer" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "type": "integer", "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "description": "Metadata for an export insights operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata", "properties": { "completedExportCount": { "description": "The number of conversations that were exported successfully.", "format": "int32", "type": "integer" }, "request": { "description": "The original request for export.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" }, "failedExportCount": { "type": "integer", "format": "int32", "description": "The number of conversations that failed to be exported." }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during export operation that might cause the operation output to be incomplete." } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "description": "A segment of a full transcript.", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "properties": { "confidence": { "format": "float", "type": "number", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset." }, "text": { "description": "The text of this segment.", "type": "string" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo" } }, "channelTag": { "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", "format": "int32", "type": "integer" }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant" }, "turnLevelAudio": { "description": "Turn level audio for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "messageTime": { "description": "The time that the message occurred, if provided.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "properties": { "issueModel": { "description": "Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "issues": { "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" }, "description": "All the matched issues." } }, "description": "Issue Modeling result on a conversation." }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage", "properties": { "textOutput": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "type": "object", "description": "Chart spec from LLM", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system." }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "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" }, "analysisPercentage": { "format": "float", "type": "number", "description": "Required. Percentage of selected conversation to analyze, between [0, 100]." }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation", "properties": { "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" }, "channelTag": { "type": "integer", "format": "int32", "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated." }, "annotationStartBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse", "properties": { "detailedResults": { "description": "Results for the DETAILED_SYNC execution mode.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete." } }, "type": "object", "description": "The response of testing correlation config." }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "properties": { "p50": { "description": "The 50th percentile value.", "type": "number", "format": "double" }, "p90": { "type": "number", "format": "double", "description": "The 90th percentile value." }, "p99": { "format": "double", "type": "number", "description": "The 99th percentile value." } }, "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th." }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "properties": { "feedbackLabels": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" }, "type": "array", "description": "Input only. The feedback labels associated with the conversation." }, "customerSatisfactionRating": { "type": "integer", "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating." }, "waitDuration": { "format": "google-duration", "type": "string", "description": "The amount of time the customer waited to connect with an agent." }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "agentInfo": { "description": "Information about agents involved in the call.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" }, "type": "array" } }, "description": "Conversation metadata related to quality management." }, "GoogleCloudContactcenterinsightsV1Analysis": { "id": "GoogleCloudContactcenterinsightsV1Analysis", "properties": { "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "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" }, "requestTime": { "description": "Output only. The time at which the analysis was requested.", "readOnly": true, "format": "google-datetime", "type": "string" }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "readOnly": true, "type": "string", "format": "google-datetime" }, "analysisResult": { "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult" } }, "type": "object", "description": "The analysis resource." }, "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest": { "description": "The request to undeploy a QaScorecardRevision", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true } }, "description": "Metadata for creating an issue model." }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "format": "google-datetime", "type": "string" }, "partialErrors": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "readOnly": true }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats" }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest" } }, "type": "object", "description": "The metadata for an SampleConversations operation." }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse", "properties": {}, "description": "The response to initialize a location-level encryption specification." }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig", "properties": { "exactMatchConfig": { "description": "The configuration for the exact match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig" }, "regexMatchConfig": { "description": "The configuration for the regex match rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig" } }, "description": "Configuration information of a phrase match rule." }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileEndToEndLatency": { "description": "The percentile result for end to end chat 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" }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" } }, "type": "object", "description": "The measure related to dialogflow interactions." }, "GoogleCloudContactcenterinsightsV1mainDataset": { "id": "GoogleCloudContactcenterinsightsV1mainDataset", "properties": { "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Dataset update time.", "readOnly": true }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Dataset create time.", "readOnly": true }, "ttl": { "description": "Optional. Option TTL for the dataset.", "format": "google-duration", "type": "string" }, "type": { "description": "Dataset usage type.", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ], "type": "string" } }, "type": "object", "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)" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "properties": { "dataPoints": { "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "type": "array", "description": "The data points that make up the time series ." } }, "type": "object", "description": "A time series of metric values." }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats" }, "request": { "description": "Output only. The original request for download.", "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" } } }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "description": "The data for a silence annotation.", "id": "GoogleCloudContactcenterinsightsV1mainSilenceData", "properties": {}, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "description": "An answer to a QaQuestion.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "properties": { "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "qaQuestion": { "description": "The QaQuestion answered by this 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" }, "answerSources": { "type": "array", "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." }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer." } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Dashboard": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Dashboard", "properties": { "updateTime": { "description": "Output only. Dashboard last update time.", "readOnly": true, "format": "google-datetime", "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" }, "displayName": { "description": "User provided display name of the dashboard.", "type": "string" }, "description": { "description": "Dashboard description", "type": "string" }, "readOnly": { "type": "boolean", "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.", "readOnly": true }, "name": { "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to all charts in the dashboard.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "createTime": { "description": "Output only. Dashboard creation time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "filter": { "description": "Filter applied to all charts in the dashboard. Should support scope later.", "type": "string" } }, "description": "Configurable dashboard" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "properties": { "analysisPercentage": { "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number", "format": "float" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector" }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "properties": { "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1mainInterruptionData" }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "channelTag": { "format": "int32", "type": "integer", "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated." }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1mainHoldData" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData" }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "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" } }, "description": "A piece of metadata that applies to a window of a call." } }, "name": "contactcenterinsights", "basePath": "", "baseUrl": "https://contactcenterinsights.googleapis.com/", "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "parameters": { "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "alt": { "default": "json", "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" ], "type": "string", "enum": [ "json", "media", "proto" ], "description": "Data format for response." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" } }, "protocol": "rest", "canonicalName": "Contactcenterinsights", "fullyEncodeReservedExpansion": true, "version_module": true, "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "servicePath": "", "resources": { "projects": { "resources": { "locations": { "methods": { "getCorrelationConfig": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "description": "Gets correlation config.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "location": "path", "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "updateSettings": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "required": true, "type": "string", "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Required. The list of fields to be updated." } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "description": "Updates project-level settings.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "id": "contactcenterinsights.projects.locations.updateSettings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" } }, "updateCorrelationConfig": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "required": true, "type": "string", "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated." } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates correlation config.", "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig" }, "queryPerformanceOverview": { "path": "v1alpha1/{+parent}:queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"" } }, "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}: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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource for new feedback labels." } } }, "queryMetrics": { "path": "v1alpha1/{+location}:queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "parameters": { "location": { "type": "string", "required": true, "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "id": "contactcenterinsights.projects.locations.queryMetrics", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Query metrics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "listAllFeedbackLabels": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List all feedback labels by project number.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of all feedback labels per project.", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data." }, "filter": { "location": "query", "type": "string", "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" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}:listAllFeedbackLabels" }, "getSettings": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "id": "contactcenterinsights.projects.locations.getSettings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets project-level settings.", "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/settings$", "type": "string", "required": true, "description": "Required. The name of the settings resource to get." } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "bulkDeleteFeedbackLabels": { "description": "Delete feedback labels in bulk using a filter.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource for new feedback labels." } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" } }, "getEncryptionSpec": { "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the encryption spec resource to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "description": "Gets location-level encryption key specification.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "generativeInsights": { "httpMethod": "POST", "parameterOrder": [ "location" ], "parameters": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+location}:generativeInsights", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "description": "Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.generativeInsights", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generativeInsights" }, "testCorrelationConfig": { "parameters": { "location": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}" } }, "httpMethod": "POST", "parameterOrder": [ "location" ], "path": "v1alpha1/{+location}:testCorrelationConfig", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Tests correlation config on a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig", "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "response": { "$ref": "GoogleLongrunningOperation" } }, "bulkUploadFeedbackLabels": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource for new feedback labels.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels" } }, "resources": { "assessmentRules": { "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "id": "contactcenterinsights.projects.locations.assessmentRules.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get an assessment rule.", "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the assessment rule to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an assessment rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "location": "path", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "required": true, "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" } }, "list": { "parameters": { "pageSize": { "description": "Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the assessment rules.", "type": "string", "required": true }, "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/assessmentRules", "description": "Lists assessment rules.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "id": "contactcenterinsights.projects.locations.assessmentRules.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" } }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "id": "contactcenterinsights.projects.locations.assessmentRules.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an assessment rule.", "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the assessment rule to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "create": { "id": "contactcenterinsights.projects.locations.assessmentRules.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an assessment rule.", "path": "v1alpha1/{+parent}/assessmentRules", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`", "required": true, "type": "string" }, "assessmentRuleId": { "location": "query", "type": "string", "description": "Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`." } } } } }, "qaQuestionTags": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the QaQuestionTag to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+name}", "description": "Gets a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}" }, "patch": { "parameters": { "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", "location": "query", "type": "string", "format": "google-fieldmask" }, "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, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "location": "path" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "description": "Updates a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "path": "v1alpha1/{+parent}/qaQuestionTags", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the QaQuestionTags.", "required": true, "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions (ie. AND operators). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_id` - id of the scorecard to list tags for * `revision_id` - id of the scorecard revision to list tags for` * `qa_question_id - id of the question to list tags for`", "location": "query", "type": "string" } }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the question tags." }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "create": { "path": "v1alpha1/{+parent}/qaQuestionTags", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the QaQuestionTag.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "qaQuestionTagId": { "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "location": "query", "type": "string" } }, "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "description": "Creates a QaQuestionTag.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "analysisRules": { "methods": { "get": { "description": "Get a analysis rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.analysisRules.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the AnalysisRule to get." } }, "path": "v1alpha1/{+name}" }, "patch": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "type": "string", "required": true, "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}" }, "updateMask": { "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a analysis rule.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "id": "contactcenterinsights.projects.locations.analysisRules.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "list": { "parameters": { "parent": { "description": "Required. The parent resource of the analysis rules.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "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.", "location": "query", "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/analysisRules", "description": "Lists analysis rules.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "id": "contactcenterinsights.projects.locations.analysisRules.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" } }, "delete": { "id": "contactcenterinsights.projects.locations.analysisRules.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a analysis rule.", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "location": "path", "description": "Required. The name of the analysis rule to delete.", "type": "string", "required": true } } }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "id": "contactcenterinsights.projects.locations.analysisRules.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a analysis rule.", "path": "v1alpha1/{+parent}/analysisRules", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ] } } }, "qaScorecards": { "methods": { "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the QaScorecard to delete." }, "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.", "location": "query", "type": "boolean" } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}" }, "create": { "id": "contactcenterinsights.projects.locations.qaScorecards.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "description": "Create a QaScorecard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaScorecards", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the QaScorecard.", "required": true, "type": "string" }, "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-`.", "location": "query", "type": "string" } } }, "get": { "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the QaScorecard to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "location": "path" } }, "id": "contactcenterinsights.projects.locations.qaScorecards.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a QaScorecard." }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "required": true, "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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`" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Updates a QaScorecard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}" }, "list": { "description": "Lists QaScorecards.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "id": "contactcenterinsights.projects.locations.qaScorecards.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse" }, "parameters": { "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "qaScorecardSources": { "location": "query", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment." ], "type": "string", "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "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 }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the scorecards." }, "pageToken": { "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/qaScorecards" } }, "resources": { "revisions": { "methods": { "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the QaScorecardRevision." }, "qaScorecardRevisionId": { "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+parent}/revisions", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Creates a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions" }, "undeploy": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the QaScorecardRevision to undeploy.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } }, "path": "v1alpha1/{+name}:undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "description": "Undeploy a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy" }, "delete": { "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "location": "path", "description": "Required. The name of the QaScorecardRevision to delete.", "type": "string", "required": true }, "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.", "location": "query", "type": "boolean" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QaScorecardRevision." }, "list": { "path": "v1alpha1/{+parent}/revisions", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "qaScorecardSources": { "location": "query", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment." ], "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.", "repeated": true, "type": "string", "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ] }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "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, "type": "string" }, "pageToken": { "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties." }, "pageSize": { "location": "query", "type": "integer", "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." } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all revisions under the parent QaScorecard." }, "get": { "description": "Gets a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the QaScorecardRevision to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "deploy": { "description": "Deploy a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the QaScorecardRevision to deploy." } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:deploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" } }, "tuneQaScorecardRevision": { "path": "v1alpha1/{+parent}:tuneQaScorecardRevision", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "location": "path", "description": "Required. The parent resource for new fine tuning job instance.", "type": "string", "required": true } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Fine tune one or more QaModels." } }, "resources": { "qaQuestions": { "methods": { "create": { "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the QaQuestion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" }, "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-`.", "location": "query", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/qaQuestions", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Create a QaQuestion.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the QaQuestion to delete." } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}" }, "list": { "path": "v1alpha1/{+parent}/qaQuestions", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the questions." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "description": "Lists QaQuestions.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the QaQuestion to get." } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a QaQuestion." }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "required": true, "type": "string", "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Updates a QaQuestion.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}" } } } } } } }, "dashboards": { "resources": { "charts": { "methods": { "delete": { "description": "Deletes a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the chart to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$" } }, "path": "v1alpha1/{+name}" }, "create": { "path": "v1alpha1/{+parent}/charts", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the chart.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path" }, "chartId": { "description": "Optional. A unique ID for the new Chart. This ID will become the final component of the Chart's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "location": "query", "type": "string" } }, "id": "contactcenterinsights.projects.locations.dashboards.charts.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "description": "Creates a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the chart to get." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "patch": { "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Chart.", "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "location": "path" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Charts.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "id": "contactcenterinsights.projects.locations.dashboards.charts.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the charts." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/charts" } } } }, "methods": { "get": { "description": "Gets a Dashboard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "id": "contactcenterinsights.projects.locations.dashboards.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the dashboard to get." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` * `description`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "required": true, "type": "string", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Dashboards.", "id": "contactcenterinsights.projects.locations.dashboards.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100." }, "orderBy": { "description": "Optional. The order by expression to order dashboards listed in the response.", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the dashboards.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "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." }, "filter": { "location": "query", "type": "string", "description": "Optional. The filter expression to filter dashboards listed in the response." } }, "path": "v1alpha1/{+parent}/dashboards" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Dashboard.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "id": "contactcenterinsights.projects.locations.dashboards.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "location": "path", "description": "Required. The name of the dashboard to delete.", "type": "string", "required": true } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "create": { "description": "Creates a Dashboard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.dashboards.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the dashboard.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "dashboardId": { "description": "Optional. A unique ID for the new Dashboard. This ID will become the final component of the Dashboard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+parent}/dashboards", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } } } }, "views": { "methods": { "get": { "id": "contactcenterinsights.projects.locations.views.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "description": "Gets a view.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the view to get." } } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a view.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "id": "contactcenterinsights.projects.locations.views.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "parameters": { "updateMask": { "description": "The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "required": true, "type": "string", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" } }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." }, "parent": { "description": "Required. The parent resource of the views.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "description": "The value returned by the last `ListViewsResponse`; indicates that this is a continuation of a prior `ListViews` call and the system should return the next page of data.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+parent}/views", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists views.", "id": "contactcenterinsights.projects.locations.views.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views" }, "delete": { "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the view to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "id": "contactcenterinsights.projects.locations.views.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a view." }, "create": { "path": "v1alpha1/{+parent}/views", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "parameters": { "parent": { "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/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "id": "contactcenterinsights.projects.locations.views.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a view." } } }, "authorizedViewSets": { "resources": { "authorizedViews": { "methods": { "list": { "path": "v1alpha1/{+parent}/authorizedViews", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned." }, "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.", "location": "query", "type": "string" }, "filter": { "description": "Optional. The filter expression to filter authorized views listed in the response.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "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." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. The order by expression to order authorized views listed in the response." } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "description": "List AuthorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an AuthorizedView." }, "setIamPolicy": { "parameters": { "resource": { "required": true, "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an AuthorizedView.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "description": "Required. The name of the AuthorizedView to delete.", "required": true, "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "getIamPolicy": { "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "type": "string" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "resource" ], "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.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" } }, "queryPerformanceOverview": { "path": "v1alpha1/{+parent}:queryPerformanceOverview", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}: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." }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the AuthorizedView to get." } }, "path": "v1alpha1/{+name}", "description": "Get AuthorizedView", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}" }, "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.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.generativeInsights", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights", "httpMethod": "POST", "parameterOrder": [ "location" ], "parameters": { "location": { "required": true, "type": "string", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "path": "v1alpha1/{+location}:generativeInsights", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" } }, "create": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "description": "Create AuthorizedView", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViews", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path", "description": "Required. The parent resource of the AuthorizedView.", "required": true, "type": "string" }, "authorizedViewId": { "location": "query", "type": "string", "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments" } } }, "search": { "path": "v1alpha1/{+parent}/authorizedViews:search", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "description": "Optional. The order by expression to order authorized views listed in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" }, "query": { "location": "query", "type": "string", "description": "Optional. The query expression to search authorized views." }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "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.", "location": "query", "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "SearchAuthorizedViewSets" }, "queryMetrics": { "description": "Query metrics.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "location" ], "path": "v1alpha1/{+location}:queryMetrics", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" } }, "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameters": { "resource": { "required": true, "type": "string", "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" } } }, "resources": { "operations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "location": "path" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "path": "v1alpha1/{+name}/operations" }, "get": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource." } } }, "cancel": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "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`.", "path": "v1alpha1/{+name}:cancel", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "name" ] } } }, "conversations": { "resources": { "feedbackLabels": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the feedback label to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "path": "v1alpha1/{+name}" }, "patch": { "description": "Update feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "list": { "path": "v1alpha1/{+parent}/feedbackLabels", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the feedback labels.", "required": true, "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data." } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List feedback labels." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the feedback label to delete." } }, "path": "v1alpha1/{+name}" }, "create": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "description": "Create feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the feedback label.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path" }, "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "location": "query", "type": "string" } } } } }, "assessments": { "methods": { "create": { "path": "v1alpha1/{+parent}/assessments", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the assessment.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Assessment." }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to delete.", "type": "string", "required": true }, "force": { "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "location": "query", "type": "boolean" } }, "path": "v1alpha1/{+name}", "description": "Delete an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}" }, "list": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "description": "List Assessments.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "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/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data." }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "location": "query", "type": "string" }, "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.", "location": "query", "type": "integer", "format": "int32" } } }, "publish": { "description": "Publish an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the assessment to publish.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "path": "v1alpha1/{+name}:publish", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" } }, "get": { "description": "Get Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the assessment to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "appeal": { "description": "Appeal an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to appeal.", "type": "string", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" } }, "finalize": { "description": "Finalize an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to finalize.", "required": true, "type": "string" } }, "path": "v1alpha1/{+name}:finalize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" } } }, "resources": { "notes": { "methods": { "list": { "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the notes.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" }, "pageToken": { "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List Notes.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" } }, "patch": { "parameters": { "updateMask": { "location": "query", "type": "string", "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`" }, "name": { "type": "string", "required": true, "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update Note.", "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.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "create": { "path": "v1alpha1/{+parent}/notes", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the note.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Create Note.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the note to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "description": "Deletes a Note.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a conversation.", "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The name of the conversation to get.", "type": "string", "required": true }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "description": "The level of details of the conversation. Default is `FULL`.", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "location": "query" } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "list": { "path": "v1alpha1/{+parent}/conversations", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "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).", "location": "query", "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the conversation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data." }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "view": { "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "type": "string", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "description": "The level of details of the conversation. Default is `BASIC`." } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "description": "Lists conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "generateSignedAudio": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the conversation to sign." } }, "path": "v1alpha1/{+name}:generateSignedAudio" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The name of the conversation to delete.", "type": "string", "required": true }, "force": { "location": "query", "type": "boolean", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "calculateStats": { "parameters": { "location": { "required": true, "type": "string", "description": "Required. The location of the conversations.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "location" ], "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" } } } } } } }, "methods": { "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "description": "Deletes an AuthorizedViewSet.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the AuthorizedViewSet to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path" }, "force": { "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "location": "query", "type": "boolean" } } }, "create": { "path": "v1alpha1/{+parent}/authorizedViewSets", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "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", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the AuthorizedViewSet.", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "description": "Create AuthorizedViewSet", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get AuthorizedViewSet", "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the AuthorizedViewSet to get.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" } } }, "patch": { "description": "Updates an AuthorizedViewSet.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } }, "list": { "description": "List AuthorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the AuthorizedViewSets.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "location": "query", "type": "string" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. The order by expression to order authorized view sets listed in the response." }, "pageSize": { "description": "Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "format": "int32", "location": "query", "type": "integer" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/authorizedViewSets" } } }, "issueModels": { "methods": { "deploy": { "path": "v1alpha1/{+name}:deploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The issue model to deploy.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "id": "contactcenterinsights.projects.locations.issueModels.deploy", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "import": { "description": "Imports an issue model from a Cloud Storage bucket.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.issueModels.import", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels:import", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the issue model.", "required": true, "type": "string" } }, "path": "v1alpha1/{+parent}/issueModels:import", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" } }, "export": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "id": "contactcenterinsights.projects.locations.issueModels.export", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Exports an issue model to the provided destination.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "parameters": { "name": { "description": "Required. The issue model to export.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "name" ] }, "undeploy": { "path": "v1alpha1/{+name}:undeploy", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The issue model to undeploy.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed." }, "delete": { "description": "Deletes an issue model.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.issueModels.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "description": "Required. The name of the issue model to delete.", "required": true, "type": "string" } }, "path": "v1alpha1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists issue models.", "id": "contactcenterinsights.projects.locations.issueModels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the issue model.", "required": true, "type": "string" } }, "path": "v1alpha1/{+parent}/issueModels" }, "patch": { "description": "Updates an issue model.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "id": "contactcenterinsights.projects.locations.issueModels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "required": true, "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "The list of fields to be updated." } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an issue model.", "id": "contactcenterinsights.projects.locations.issueModels.create", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the issue model.", "required": true, "type": "string" } }, "path": "v1alpha1/{+parent}/issueModels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "calculateIssueModelStats": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an issue model's statistics.", "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "httpMethod": "GET", "parameterOrder": [ "issueModel" ], "parameters": { "issueModel": { "type": "string", "required": true, "description": "Required. The resource name of the issue model to query against.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "path": "v1alpha1/{+issueModel}:calculateIssueModelStats" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "id": "contactcenterinsights.projects.locations.issueModels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "Gets an issue model.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "description": "Required. The name of the issue model to get.", "type": "string", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ] } }, "resources": { "issues": { "methods": { "delete": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the issue to delete." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "description": "Deletes an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "id": "contactcenterinsights.projects.locations.issueModels.issues.delete", "response": { "$ref": "GoogleProtobufEmpty" } }, "create": { "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "description": "Creates an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issues", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "location": "path", "description": "Required. The parent resource of the issue.", "type": "string", "required": true } } }, "get": { "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "description": "Gets an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "location": "path", "description": "Required. The name of the issue to get.", "required": true, "type": "string" } } }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "description": "Updates an issue.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "The list of fields to be updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "location": "path", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "required": true, "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "list": { "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the issue.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/issues", "description": "Lists issues.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "id": "contactcenterinsights.projects.locations.issueModels.issues.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse" } } } } } }, "phraseMatchers": { "methods": { "list": { "path": "v1alpha1/{+parent}/phraseMatchers", "parameters": { "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource of the phrase matcher." }, "pageToken": { "location": "query", "type": "string", "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." }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists phrase matchers." }, "get": { "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the phrase matcher to get.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "location": "path" } }, "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a phrase matcher." }, "patch": { "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "parameters": { "updateMask": { "description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "required": true, "type": "string", "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a phrase matcher." }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`" } }, "path": "v1alpha1/{+parent}/phraseMatchers", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a phrase matcher.", "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a phrase matcher.", "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the phrase matcher to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ] } } }, "autoLabelingRules": { "methods": { "list": { "path": "v1alpha1/{+parent}/autoLabelingRules", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous List request, if any." }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of auto labeling rules to return in a single response. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." } }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "description": "Lists auto labeling rules.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "test": { "path": "v1alpha1/{+parent}/autoLabelingRules:test", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Tests auto labeling rules against a conversation." }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+name}", "description": "Gets an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}" }, "patch": { "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "description": "Updates an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated." }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "location": "path" } } }, "create": { "path": "v1alpha1/{+parent}/autoLabelingRules", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "autoLabelingRuleId": { "description": "Required. The ID to use for the auto labeling rule, which will become the final component of the auto labeling rule's resource name.", "location": "query", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an auto labeling rule." }, "delete": { "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an auto labeling rule." } } }, "conversations": { "resources": { "feedbackLabels": { "methods": { "get": { "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "description": "Get feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path" } } }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string", "required": true }, "updateMask": { "description": "Required. The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the feedback labels.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List feedback labels.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "description": "Required. The name of the feedback label to delete.", "type": "string", "required": true } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}" }, "create": { "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the feedback label.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" }, "feedbackLabelId": { "location": "query", "type": "string", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/feedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } } } }, "assessments": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List Assessments.", "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "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/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data." }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for" }, "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.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1alpha1/{+parent}/assessments" }, "publish": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the assessment to publish." } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:publish", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Publish an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "get": { "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the assessment to get." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Get Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "path": "v1alpha1/{+parent}/assessments", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the assessment.", "type": "string", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "id": "contactcenterinsights.projects.locations.conversations.assessments.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Create Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete an Assessment.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the assessment to delete." }, "force": { "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "location": "query", "type": "boolean" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}" }, "appeal": { "path": "v1alpha1/{+name}:appeal", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The name of the assessment to appeal.", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Appeal an Assessment." }, "finalize": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the assessment to finalize." } }, "path": "v1alpha1/{+name}:finalize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "description": "Finalize an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize" } }, "resources": { "notes": { "methods": { "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "location": "path", "description": "Required. The parent resource of the notes.", "type": "string", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data." }, "pageSize": { "description": "Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List Notes.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" } }, "patch": { "parameters": { "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "location": "path" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create Note.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the note." } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/notes", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the note to delete." } }, "path": "v1alpha1/{+name}", "description": "Deletes a Note.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}" } } } } }, "analyses": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an analysis.", "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the analysis to get." } }, "path": "v1alpha1/{+name}" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available." }, "parent": { "description": "Required. The parent resource of the analyses.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path" }, "pageToken": { "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.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." } }, "path": "v1alpha1/{+parent}/analyses", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists analyses.", "id": "contactcenterinsights.projects.locations.conversations.analyses.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses" }, "delete": { "description": "Deletes an analysis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "location": "path", "description": "Required. The name of the analysis to delete.", "type": "string", "required": true } }, "path": "v1alpha1/{+name}" }, "create": { "description": "Creates an analysis. The long running operation is done when the analysis has completed.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource of the analysis.", "required": true, "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/analyses", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" } } } }, "segments": { "methods": { "bulkAnalyze": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Analyzes multiple conversations in a single request.", "path": "v1alpha1/{+parent}/segments:bulkAnalyze", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The parent resource to create analyses in.", "required": true, "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ] } } } }, "methods": { "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.conversations.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a conversation.", "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "location": "query", "type": "boolean", "description": "Optional. If set to true, the conversation will be updated with auto labeling results." }, "updateMask": { "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings`", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "required": true, "type": "string" }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored." } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "bulkAnalyze": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource to create analyses in.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha1/{+parent}/conversations:bulkAnalyze", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "description": "Analyzes multiple conversations in a single request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze" }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "id": "contactcenterinsights.projects.locations.conversations.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "description": "Lists conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the conversation.", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data." }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "view": { "description": "The level of details of the conversation. Default is `BASIC`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering)." }, "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.", "location": "query", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "generateSignedAudio": { "path": "v1alpha1/{+name}:generateSignedAudio", "parameters": { "name": { "description": "Required. The name of the conversation to sign.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation." }, "delete": { "id": "contactcenterinsights.projects.locations.conversations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the conversation to delete.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path" }, "force": { "location": "query", "type": "boolean", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses." } } }, "sample": { "id": "contactcenterinsights.projects.locations.conversations.sample", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:sample", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource of the dataset.", "type": "string", "required": true } } }, "ingest": { "description": "Imports conversations and processes them according to the user's configuration.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", "id": "contactcenterinsights.projects.locations.conversations.ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource for new conversations.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations:ingest", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" } }, "upload": { "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "id": "contactcenterinsights.projects.locations.conversations.upload", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the conversation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations:upload", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "id": "contactcenterinsights.projects.locations.conversations.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Required. The name of the conversation to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path" }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "description": "The level of details of the conversation. Default is `FULL`.", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "location": "query" } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "create": { "path": "v1alpha1/{+parent}/conversations", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "parameters": { "parent": { "description": "Required. The parent resource of the conversation.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "conversationId": { "description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "location": "query", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "id": "contactcenterinsights.projects.locations.conversations.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkDelete": { "path": "v1alpha1/{+parent}/conversations:bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "description": "Deletes multiple conversations in a single request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "calculateStats": { "httpMethod": "GET", "parameterOrder": [ "location" ], "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The location of the conversations.", "type": "string", "required": true }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties." } }, "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "id": "contactcenterinsights.projects.locations.conversations.calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats" } } }, "datasets": { "resources": { "insightsdata": { "methods": { "export": { "path": "v1alpha1/{+parent}/insightsdata:export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "parameters": { "parent": { "description": "Required. The parent resource to export data from.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Export insights data to a destination defined in the request body." } } }, "conversations": { "methods": { "bulkDelete": { "description": "Deletes multiple conversations in a single request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations:bulkDelete", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" } }, "calculateStats": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets conversation statistics.", "path": "v1alpha1/{+location}/conversations:calculateStats", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "parameters": { "location": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string", "description": "Required. The location of the conversations." } }, "httpMethod": "POST", "parameterOrder": [ "location" ] }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the conversation to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path" }, "view": { "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "type": "string", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "description": "The level of details of the conversation. Default is `FULL`." } }, "path": "v1alpha1/{+name}", "description": "Gets a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource of the conversation." }, "pageToken": { "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties." }, "view": { "description": "The level of details of the conversation. Default is `BASIC`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering)." }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "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." } }, "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists conversations.", "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations" }, "generateSignedAudio": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the signed URI for the audio for the given conversation.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the conversation to sign.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:generateSignedAudio" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the conversation to delete.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path" }, "force": { "location": "query", "type": "boolean", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses." } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a conversation.", "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}" }, "sample": { "id": "contactcenterinsights.projects.locations.datasets.conversations.sample", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/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.", "path": "v1alpha1/{+parent}/conversations:sample", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" } } }, "ingest": { "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports conversations and processes them according to the user's configuration.", "path": "v1alpha1/{+parent}/conversations:ingest", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" } } } }, "resources": { "feedbackLabels": { "methods": { "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "description": "Required. The name of the feedback label to get.", "type": "string", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "description": "Get feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "patch": { "parameters": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path" }, "updateMask": { "description": "Required. The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update feedback label.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "list": { "description": "List feedback labels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size." }, "parent": { "description": "Required. The parent resource of the feedback labels.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data." } }, "path": "v1alpha1/{+parent}/feedbackLabels" }, "delete": { "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "location": "path", "description": "Required. The name of the feedback label to delete.", "type": "string", "required": true } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete feedback label." }, "create": { "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create feedback label.", "path": "v1alpha1/{+parent}/feedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the feedback label.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "location": "path" }, "feedbackLabelId": { "location": "query", "type": "string", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server." } } } } } } } }, "methods": { "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the dataset to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete a dataset.", "id": "contactcenterinsights.projects.locations.datasets.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}" }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "id": "contactcenterinsights.projects.locations.datasets.patch", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a dataset.", "path": "v1alpha1/{+name}", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to update." }, "name": { "type": "string", "required": true, "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "bulkDeleteFeedbackLabels": { "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource for new feedback labels." } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete feedback labels in bulk using a filter.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "contactcenterinsights.projects.locations.datasets.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List datasets matching the input.", "path": "v1alpha1/{+parent}/datasets", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data.", "location": "query", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number`", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "location": "query", "type": "integer", "format": "int32" } } }, "create": { "id": "contactcenterinsights.projects.locations.datasets.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a dataset.", "path": "v1alpha1/{+parent}/datasets", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "datasetId": { "description": "Optional. The ID to use for the dataset.", "location": "query", "type": "string" }, "parent": { "type": "string", "required": true, "description": "Required. The parent resource of the dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "get": { "description": "Gets a dataset.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The name of the dataset to get.", "type": "string", "required": true } }, "path": "v1alpha1/{+name}" }, "bulkDownloadFeedbackLabels": { "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" } } }, "listAllFeedbackLabels": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource of all feedback labels per project.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data." }, "filter": { "location": "query", "type": "string", "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" }, "pageSize": { "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "description": "List all feedback labels by project number.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels" }, "bulkUploadFeedbackLabels": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The parent resource for new feedback labels.", "type": "string", "required": true } }, "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels" } } }, "encryptionSpec": { "methods": { "initialize": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$" } }, "path": "v1alpha1/{+name}:initialize", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize" } } }, "operations": { "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "contactcenterinsights.projects.locations.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "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.", "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource." } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "cancel": { "id": "contactcenterinsights.projects.locations.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string" } } }, "list": { "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "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`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "id": "contactcenterinsights.projects.locations.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } }, "assistantSessions": { "methods": { "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions", "id": "contactcenterinsights.projects.locations.assistantSessions.create", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an assistant session.", "path": "v1alpha1/{+parent}/assistantSessions", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource where this assistant session will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "assistantSessionId": { "description": "Optional. The ID to use for the assistant session, which will become the final component of the assistant session's resource name. If not provided, a random UUID will be generated by the server. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`.", "location": "query", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "get": { "description": "Gets an assistant session.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.assistantSessions.get", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssistantSession" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the assistant session to retrieve. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`" } }, "path": "v1alpha1/{+name}" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource, which owns this collection of assistant sessions. Format: `projects/{project}/locations/{location}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListAssistantSessions` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of assistant sessions to return in a single response. If unspecified, at most 100 assistant sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" } }, "path": "v1alpha1/{+parent}/assistantSessions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists assistant sessions.", "id": "contactcenterinsights.projects.locations.assistantSessions.list", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssistantSessionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions" }, "streamChat": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Streams chat messages from the assistant.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assistantSessions/{assistantSessionsId}:streamChat", "id": "contactcenterinsights.projects.locations.assistantSessions.streamChat", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1StreamChatResponse" }, "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the assistant session to stream chat. Format: `projects/{project}/locations/{location}/assistantSessions/{assistant_session}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/assistantSessions/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:streamChat", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1StreamChatRequest" } } } }, "insightsdata": { "methods": { "export": { "path": "v1alpha1/{+parent}/insightsdata:export", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource to export data from.", "type": "string", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "id": "contactcenterinsights.projects.locations.insightsdata.export", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Export insights data to a destination defined in the request body." } } } } } } } }, "id": "contactcenterinsights:v1alpha1", "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." } } } }, "ownerDomain": "google.com", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "revision": "20260727", "batchPath": "batch", "discoveryVersion": "v1", "title": "Contact Center AI Insights API", "description": "", "ownerName": "Google", "kind": "discovery#restDescription", "version": "v1alpha1", "rootUrl": "https://contactcenterinsights.googleapis.com/" }