{ "id": "contactcenterinsights:v1alpha1", "protocol": "rest", "schemas": { "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", "properties": { "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "format": "float", "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" } }, "description": "Agent Assist frequently-asked-question answer data.", "type": "object" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { "description": "Response from import issue model", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput", "properties": { "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } }, "textType": { "description": "The type of text output.", "type": "string", "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput": { "properties": { "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } }, "textType": { "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of text output.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "Wrapper for text output.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSmartReplyData": { "description": "Agent Assist Smart Reply data.", "type": "object", "properties": { "confidenceScore": { "format": "double", "description": "The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" }, "metadata": { "description": "Map that contains metadata about the Smart Reply and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage": { "properties": { "textOutput": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "description": "A direct natural language response to the user message." }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec from LLM", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage", "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData": { "description": "The data for an issue match annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment": { "description": "A segment of a full transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment", "properties": { "dialogflowSegmentMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "CCAI metadata relating to the current transcript segment." }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "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" }, "text": { "description": "The text of this segment.", "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" } }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "segmentParticipant": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "description": "The participant of this segment." }, "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsResponse", "description": "The response to an SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse": { "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "datasets": { "description": "The datasets that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse", "description": "The response to list datasets.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote": { "description": "A note about a QA question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote", "properties": { "qaQuestion": { "description": "The question resource that the note is associated with.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "type": "object", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData", "properties": { "dialogflowIntentId": { "description": "The Dialogflow intent resource path. Format: projects/{project}/agent/{agent}/intents/{intent}", "type": "string" }, "confidence": { "format": "float", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } }, "description": "Dialogflow interaction data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "description": "Output only. The original request for sample conversations to dataset.", "readOnly": true }, "sampleConversationsStats": { "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1mainRedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "type": "object", "properties": { "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" }, "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "properties": { "displayName": { "description": "The representative name for the entity.", "type": "string" }, "metadata": { "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object", "additionalProperties": { "type": "string" } }, "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" }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "The aggregate sentiment expressed for this entity in the conversation." }, "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" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "type": "object" }, "GoogleCloudCesV1mainBlob": { "id": "GoogleCloudCesV1mainBlob", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "data": { "description": "Required. Raw bytes of the blob.", "type": "string", "format": "byte" } }, "description": "Represents a blob input or output in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse": { "description": "The response of listing assessments.", "type": "object", "properties": { "assessments": { "description": "The assessments that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ChartAction": { "description": "The action to be taken when the chart is clicked.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "properties": { "redirectAction": { "description": "Redirect action.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest": { "description": "Request to import an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest", "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage source message." }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition": { "description": "Condition for auto-labeling conversations.", "type": "object", "properties": { "condition": { "description": "A optional CEL expression to be evaluated as a boolean value. Once evaluated as true, then we will proceed with the value evaluation. An empty condition will be auto evaluated as true.", "type": "string" }, "value": { "description": "CEL expression to be evaluated as the value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRuleLabelingCondition" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { "properties": { "successfulSampleCount": { "format": "int32", "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "readOnly": true }, "failedSampleCount": { "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "description": "Statistics for SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse", "description": "The response to an SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig", "properties": { "medium": { "description": "Required. The medium transcript objects represent.", "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": "Configuration for processing transcript objects.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest": { "properties": { "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage URI to export the issue model to." }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest", "description": "Request to export an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment": { "description": "A segment of a full transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment", "properties": { "channelTag": { "description": "For conversations derived from multi-channel audio, this is the channel number corresponding to the audio from that channel. For audioChannelCount = N, its output values can range from '1' to 'N'. A channel tag of 0 indicates that the audio is mono.", "type": "integer", "format": "int32" }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "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" }, "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo" } }, "sentiment": { "description": "The sentiment for this transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "text": { "description": "The text of this segment.", "type": "string" }, "segmentParticipant": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "description": "The participant of this segment." }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse": { "properties": { "successfulAnalysisCount": { "description": "Count of successful analyses.", "type": "integer", "format": "int32" }, "failedAnalysisCount": { "format": "int32", "description": "Count of failed analyses.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData": { "properties": { "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "properties": { "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" } }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" }, "timeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse", "properties": { "smartHighlighterMatches": { "additionalProperties": { "type": "integer", "format": "int32" }, "description": "A map associating each smart highlighter display name with its respective number of matches in the set of conversations.", "type": "object" }, "averageTurnCount": { "description": "The average number of turns per conversation.", "type": "integer", "format": "int32" }, "conversationCount": { "format": "int32", "description": "The total number of conversations.", "type": "integer" }, "customHighlighterMatches": { "additionalProperties": { "format": "int32", "type": "integer" }, "description": "A map associating each custom highlighter resource name with its respective number of matches in the set of conversations.", "type": "object" }, "conversationCountTimeSeries": { "description": "A time series representing the count of conversations created over time that match that requested filter criteria.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries" }, "issueMatchesStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/`", "type": "object" }, "averageDuration": { "format": "google-duration", "description": "The average duration of all conversations. The average is calculated using only conversations that have a time duration.", "type": "string" }, "issueMatches": { "description": "A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: `projects//locations//issueModels//issues/` Deprecated, use `issue_matches_stats` field instead.", "deprecated": true, "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } }, "description": "The response for calculating conversation statistics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse": { "description": "The response from a ListQaQuestions request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse", "properties": { "qaQuestions": { "description": "The QaQuestions under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata": { "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "description": "Output only. The original request." } }, "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata": { "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults": { "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult" } } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata": { "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1Issue": { "properties": { "updateTime": { "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue was created.", "type": "string", "readOnly": true }, "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "sampleUtterances": { "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "The representative name for the issue.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Issue", "description": "The issue resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote", "description": "A note about the entire parent assessment.", "type": "object" }, "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" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the join key expression failed to evaluate." } } }, "GoogleCloudCesV1mainImage": { "description": "Represents an image input or output in the conversation.", "type": "object", "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": { "format": "byte", "description": "Required. Raw bytes of the image.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation", "properties": { "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1mainSmartReplyData" }, "endBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "dialogflowInteraction": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowInteractionData", "description": "Dialogflow interaction data." }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary" }, "userInput": { "description": "Explicit input used for generating the answer", "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "articleSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1mainArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData" }, "createTime": { "format": "google-datetime", "description": "The time at which this annotation was created.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } }, "description": "Container for a list of scorecards.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest": { "description": "The request to deploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination": { "properties": { "table": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" }, "dataset": { "description": "Required. The name of the BigQuery dataset that the snapshot result should be exported to. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference.", "type": "object" }, "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" } }, "description": "The response for listing all feedback labels.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig": { "properties": { "medium": { "description": "Required. The medium transcript objects represent.", "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" ] } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for processing transcript objects.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest": { "properties": { "qaQuestionTag": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "description": "Required. The QaQuestionTag to update." }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IntentMatchData": { "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest", "description": "The message to appeal an assessment.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig": { "description": "Regex match configuration.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1RegexMatchConfig", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponse": { "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice" } }, "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "type": "string" }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice", "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." } }, "description": "The response for querying metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest", "properties": { "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The original request for deletion." } }, "description": "Metadata for deleting an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse": { "description": "The response of testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponse", "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": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults" } } }, "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata": { "properties": { "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "description": "Metadata about the issue dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages": { "description": "A wrapper for system messages per turn.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage" } } } }, "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest": { "description": "Request to upload a conversation.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" }, "speechConfig": { "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig" }, "conversation": { "description": "Required. The conversation resource to create.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversation" }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings." } }, "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest" }, "GoogleCloudContactcenterinsightsV1alpha1Container": { "description": "Configurable dashboard's container. Container can contain multiple widgets.", "type": "object", "properties": { "width": { "description": "The width of the container in grid units.", "type": "integer", "format": "int32" }, "containerId": { "description": "Output only. Unique ID for the container.", "type": "string", "readOnly": true }, "displayName": { "description": "User provided display name of the Container.", "type": "string" }, "description": { "description": "Container description", "type": "string" }, "dateRangeConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range config applied to all charts in the container." }, "widgets": { "description": "Widgets in the Container.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Widget" } }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "height": { "format": "int32", "description": "The height of the container in grid units.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse": { "description": "The response for querying performance overview.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewResponse", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", "description": "Metadata about the conversation medium dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig": { "description": "Configuration for processing transcript objects.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "properties": { "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Required. The medium transcript objects represent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" } } }, "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig": { "properties": { "trainingConversationsCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "deprecated": true, "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`." } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "description": "Configs for the input data used to create the issue model.", "type": "object" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata": { "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "description": "Output only. The original request.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagMetadata", "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource": { "properties": { "normalizedScore": { "format": "double", "description": "The normalized score, which is the score divided by the potential score.", "type": "number" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } }, "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "type": "string" }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource", "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "properties": { "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" ], "description": "Query source for the answer.", "type": "string" }, "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest": { "properties": { "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "templateQaScorecardId": { "description": "Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.", "type": "array", "items": { "type": "string" } }, "feedbackLabelType": { "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string" }, "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination", "description": "A cloud storage bucket destination." }, "maxDownloadCount": { "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer" }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "sheetsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "A sheets document destination." } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object" }, "GoogleCloudCesV1mainAgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "type": "object", "properties": { "displayName": { "description": "Output only. Display name of the agent.", "type": "string", "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" } }, "id": "GoogleCloudCesV1mainAgentTransfer" }, "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris": { "description": "Signed audio URIs for a conversation.", "type": "object", "properties": { "signedDialogflowAudioUri": { "description": "The signed URI for the audio from the Dialogflow conversation source.", "type": "string" }, "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" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris" }, "GoogleCloudContactcenterinsightsV1mainIssue": { "description": "The issue resource.", "type": "object", "properties": { "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time that this issue was updated.", "type": "string", "format": "google-datetime" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this issue was created.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "sampleUtterances": { "readOnly": true, "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1mainIssue" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource": { "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "properties": { "bucketUri": { "description": "Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.", "type": "string" }, "bucketObjectType": { "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "type": "string", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ] }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "GoogleCloudContactcenterinsightsV1mainDialogflowIntent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest": { "description": "The request to analyze conversations in bulk.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "analysisPercentage": { "format": "float", "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number" }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." } }, "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment" } } }, "description": "A message representing the transcript of a conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest": { "properties": { "qaQuestionTag": { "description": "Required. The QaQuestionTag to update.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource", "properties": { "sourceType": { "description": "What created the answer.", "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" ] }, "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" } }, "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" }, "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest": { "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Conversation": { "description": "The conversation resource.", "type": "object", "properties": { "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "description": "The source of the audio and transcription for the conversation." }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "expireTime": { "format": "google-datetime", "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string" }, "qualityMetadata": { "description": "Conversation metadata related to quality management.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata" }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "correlationInfo": { "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "readOnly": true }, "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" }, "transcript": { "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript", "readOnly": true }, "callMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata", "description": "Call-specific metadata." }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the conversation was updated.", "type": "string", "format": "google-datetime" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "runtimeAnnotations": { "readOnly": true, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" } }, "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}", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent" }, "readOnly": true }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Immutable. The conversation medium.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object" }, "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" }, "latestSummary": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Output only. Latest summary of the conversation." }, "duration": { "format": "google-duration", "description": "Output only. The duration of the conversation.", "type": "string", "readOnly": true }, "turnCount": { "readOnly": true, "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32" }, "startTime": { "format": "google-datetime", "description": "The time at which the conversation started.", "type": "string" }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "readOnly": true }, "createTime": { "description": "Output only. The time at which the conversation was created.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "GoogleCloudContactcenterinsightsV1mainConversationDataSource": { "properties": { "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" } }, "gcsSource": { "description": "A Cloud Storage location specification for the audio and transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainGcsSource" }, "dialogflowSource": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "The source when the conversation comes from Dialogflow." }, "metadataUri": { "description": "Cloud Storage URI that points to a file that contains the conversation metadata.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSource", "description": "The conversation source, which is a combination of transcript and audio.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExactMatchConfig", "properties": { "caseSensitive": { "description": "Whether to consider case sensitivity when performing an exact match.", "type": "boolean" } }, "description": "Exact match configuration.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange": { "properties": { "unit": { "description": "Required. The unit of time.", "type": "string", "enumDescriptions": [ "Unspecified.", "Day.", "Week.", "Month.", "Quarter.", "Year." ], "enum": [ "TIME_UNIT_UNSPECIFIED", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "quantity": { "description": "Required. The quantity of units in the past.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange", "description": "Relative date range configuration.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponse": { "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": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "description": "Results for the DETAILED_SYNC execution mode." } }, "description": "The response of testing correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage": { "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "type": "object", "properties": { "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. User provided chart spec", "type": "object" }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A direct natural language response to the user message." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" }, "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource": { "description": "Configuration for Cloud Storage bucket sources.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "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" }, "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" } }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" }, "bucketObjectType": { "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ], "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "failedConversationsCount": { "format": "int32", "description": "The number of conversations that failed correlation.", "type": "integer" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "sampledConversationsCount": { "description": "The number of conversations sampled.", "type": "integer", "format": "int32" }, "correlatedConversationsCount": { "format": "int32", "description": "The number of conversations correlated.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo", "properties": { "mergedFullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "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.", "type": "array", "items": { "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "type": "string" }, "readOnly": true }, "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1SmartReplyData", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "description": "Agent Assist Smart Reply data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "type": "object", "properties": { "percentileEndToEndLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." }, "percentileToolUseLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileLlmCallLatency": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsResponse", "properties": {}, "description": "The response to an IngestConversations operation.", "type": "object" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse", "description": "The response from a ListQaScorecardRevisions request.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "startOffset": { "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse": { "description": "The response to undeploy an issue model.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata", "properties": { "customerSatisfactionRating": { "format": "int32", "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer" }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "agentInfo": { "description": "Information about agents involved in the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo" } }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Output only. The original request for download.", "readOnly": true }, "downloadStats": { "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", "properties": { "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "description": "Output only. The original request for delete." }, "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "properties": { "processedObjectCount": { "format": "int32", "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "readOnly": true }, "successfulIngestCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer" }, "failedIngestCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer" }, "duplicatesSkippedCount": { "format": "int32", "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer", "readOnly": true } }, "description": "Statistics for IngestConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SentimentData", "properties": { "magnitude": { "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number" }, "score": { "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata": { "description": "Metadata for creating an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest", "description": "The original request for creation." }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1ConversationDataSource": { "description": "The conversation source, which is a combination of transcript and audio.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1GcsSource", "description": "A Cloud Storage location specification for the audio and transcript." }, "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" }, "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": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" } } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", "description": "The request to initialize a location-level encryption specification.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata": { "properties": { "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest": { "properties": { "qaQuestionTag": { "$ref": "GoogleCloudContactcenterinsightsV1QaQuestionTag", "description": "Required. The QaQuestionTag to update." }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `qa_question_tag_name` - the name of the tag * `qa_question_ids` - the list of questions the tag applies to", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "description": "The request for updating a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult": { "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" } } }, "description": "Issue Modeling result on a conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "description": "The request to deploy an issue model.", "type": "object" }, "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": { "readOnly": true, "description": "Output only. Accuracy of the model. Measures the percentage of correct answers the model gave on the test set.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest": { "properties": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "force": { "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean" }, "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "description": "A text output message from the system.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "text": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } }, "textType": { "description": "The type of the text message.", "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "annotatorSelector": { "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "readOnly": true }, "conversation": { "readOnly": true, "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "aiCoachSuggestionMessageTriggerCount": { "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "dialogflowWebhookFailureRatio": { "description": "Proportion of dialogflow webhook calls that failed.", "type": "number", "format": "double" }, "dialogflowConversationsEscalationRatio": { "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "dialogflowAverageWebhookLatency": { "format": "double", "description": "Average latency of dialogflow webhook calls.", "type": "number" }, "conversationTotalCustomerMessageCount": { "description": "The customer message count.", "type": "integer", "format": "int32" }, "aaSupervisorAssignedConversationsCount": { "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "averageQaQuestionNormalizedScore": { "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", "type": "number", "format": "double" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "knowledgeAssistPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "averageCustomerSatisfactionRating": { "format": "double", "description": "The average customer satisfaction rating.", "type": "number" }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "dialogflowInteractionsNoInputRatio": { "description": "Proportion of dialogflow interactions that has empty input.", "type": "number", "format": "double" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "averageSummarizationSuggestionNormalizedEditDistance": { "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", "type": "number" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "description": "The agent message count.", "type": "integer", "format": "int32" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number" }, "avgConversationClientTurnSentimentEma": { "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number", "format": "double" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "summarizationSuggestionResultCount": { "format": "int32", "description": "Count of summarization suggestions results.", "type": "integer" }, "aiCoachSuggestionAgentUsageRatio": { "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentUsageCount": { "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer" }, "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "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.", "type": "number", "format": "double" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number" }, "conversationAiCoachSuggestionRatio": { "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number" }, "knowledgeAssistResultCount": { "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "averageQaNormalizedScore": { "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number", "format": "double" }, "conversationSuggestedSummaryRatio": { "description": "Proportion of conversations that had a suggested summary.", "type": "number", "format": "double" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "format": "double", "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number" }, "averageTurnCount": { "format": "float", "description": "The average turn count.", "type": "number" }, "knowledgeSearchSuggestedQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number" }, "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "averageSummarizationSuggestionEditDistance": { "format": "double", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "type": "number" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "averageClientSentimentScore": { "format": "float", "description": "The average client's sentiment score.", "type": "number" }, "aaSupervisorTransferredToHumanAgentConvCount": { "format": "int32", "description": "The number of conversations transferred to a human agent.", "type": "integer" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } } } }, "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule": { "description": "The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule", "properties": { "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive.", "type": "boolean" }, "sampleRule": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "description": "The sample rule for the assessment rule." }, "scheduleInfo": { "description": "Schedule info for the assessment rule.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "name": { "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "type": "string" }, "displayName": { "description": "Display Name of the assessment rule.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this assessment rule was created.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which this assessment rule was updated.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata": { "description": "Conversation metadata related to quality management.", "type": "object", "properties": { "customerSatisfactionRating": { "description": "An arbitrary integer value indicating the customer's satisfaction rating.", "type": "integer", "format": "int32" }, "agentInfo": { "description": "Information about agents involved in the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo" } }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "menuPath": { "description": "An arbitrary string value specifying the menu path the customer took.", "type": "string" }, "waitDuration": { "description": "The amount of time the customer waited to connect with an agent.", "type": "string", "format": "google-duration" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest", "properties": { "parent": { "description": "Required. The parent resource of the conversation.", "type": "string" }, "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation", "description": "Required. The conversation resource to create." }, "conversationId": { "description": "Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string" }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "description": "Optional. Speech-to-Text configuration. Will default to the config specified in Settings." }, "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" } }, "description": "Request to upload a conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats": { "properties": { "processedObjectCount": { "readOnly": true, "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "format": "int32" }, "successfulIngestCount": { "description": "Output only. The number of new conversations added during this ingest operation.", "type": "integer", "format": "int32", "readOnly": true }, "failedIngestCount": { "description": "Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true }, "duplicatesSkippedCount": { "readOnly": true, "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "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}", "type": "string", "readOnly": true }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { "description": "Metadata about the Conversational Agents tool dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "properties": { "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" }, "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest": { "properties": { "sheetsSource": { "description": "A sheets document source.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "description": "A cloud storage bucket source." }, "validateOnly": { "description": "Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest", "description": "The request for bulk uploading feedback labels.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest", "properties": { "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "parent": { "description": "Required. The parent resource to create analyses in.", "type": "string" }, "relabel": { "description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "analysisPercentage": { "description": "Required. Percentage of selected conversation to analyze, between [0, 100].", "type": "number", "format": "float" } }, "description": "The request to analyze conversations in bulk.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults": { "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" } } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigResponseDetailedCorrelationResults", "description": "Wrapper for detailed, step-by-step results.", "type": "object" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse": { "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA scorecard dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse": { "description": "The response of listing notes.", "type": "object", "properties": { "notes": { "description": "The notes that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource": { "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", "type": "object", "properties": { "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Answer was system-generated; created during an Insights analysis.", "Answer was created by a human via manual edit." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED", "MANUAL_EDIT" ], "description": "What created the answer.", "type": "string" }, "answerValue": { "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" }, "GoogleCloudContactcenterinsightsV1InterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1InterruptionData", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant": { "description": "The call participant speaking for a given utterance.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant", "properties": { "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "role": { "description": "The role of the participant.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] } } }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "type": "object", "properties": { "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource": { "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse", "properties": { "charts": { "description": "The charts under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" } }, "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" } }, "description": "The response of listing charts.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", "description": "The response to an SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataResponse", "description": "Response for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaQuestionTag": { "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" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "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" } }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The most recent time at which the question tag was updated.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1mainQaQuestionTag", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainAnalysisResult": { "description": "The result of an analysis.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "The time at which the analysis ended.", "type": "string" }, "callAnalysisMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created by the analysis." } }, "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResult" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestSheetsDestination", "properties": { "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" }, "spreadsheetUri": { "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" } }, "description": "Google Sheets document details to write the feedback labels to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult": { "description": "The result of a single correlation rule.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult", "properties": { "error": { "description": "The error status if the join key expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse": { "description": "Wrapper for storing the generative response for a chart.", "type": "object", "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": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "type": "object" }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response." } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecRequest", "description": "Output only. The original request for initialization.", "readOnly": true }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "partialErrors": { "description": "Partial errors during initializing operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecMetadata", "description": "Metadata for initializing a location-level encryption specification.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource", "properties": { "generativeInsights": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "description": "Use natural language query to generate the chart." }, "queryMetrics": { "description": "Use the existing QueryMetrics to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics" } }, "description": "The request data for visualizing the dataset in the chart.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest": { "properties": { "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage URI to export the issue model to." }, "name": { "description": "Required. The issue model to export.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "description": "Request to export an issue model.", "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", "properties": { "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation": { "description": "An annotation that was generated during the customer and agent interaction.", "type": "object", "properties": { "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "smartReply": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "description": "Agent Assist Smart Reply data." }, "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData" }, "cesEndSessionAnnotation": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesEndSessionAnnotation", "description": "The CES end session annotation." }, "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": "GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "articleSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData" }, "answerFeedback": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "description": "The feedback that the customer has about the answer in `data`." }, "conversationSummarizationSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "description": "Conversation summarization suggestion data." }, "userInput": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule" } } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" }, "issueDisplayName": { "description": "The issue display name.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence", "properties": { "silenceDuration": { "format": "google-duration", "description": "Amount of time calculated to be in silence.", "type": "string" }, "silencePercentage": { "format": "float", "description": "Percentage of the total conversation spent in silence.", "type": "number" } }, "description": "Conversation-level silence data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationParticipant": { "description": "The call participant speaking for a given utterance.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationParticipant", "properties": { "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "role": { "description": "The role of the participant.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "description": "The user message.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Metadata about the client sentiment category dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUploadConversationMetadata", "properties": { "appliedRedactionConfig": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig", "description": "Output only. The redaction config applied to the uploaded conversation." }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainUploadConversationRequest", "description": "Output only. The original request." }, "analysisOperation": { "readOnly": true, "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string" }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1View": { "id": "GoogleCloudContactcenterinsightsV1alpha1View", "properties": { "updateTime": { "description": "Output only. The most recent time at which the view was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "description": "Output only. The time at which this view was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "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" }, "name": { "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "type": "string" }, "displayName": { "description": "The human-readable display name of the view.", "type": "string" } }, "description": "The View resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata": { "description": "The metadata for querying performance overview.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQueryPerformanceOverviewMetadata", "properties": {} }, "GoogleIamV1AuditLogConfig": { "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object", "properties": { "logType": { "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" ], "description": "The log type that this config enables.", "type": "string" }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleIamV1AuditLogConfig" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscript": { "description": "A message representing the transcript of a conversation.", "type": "object", "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscript" }, "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation": { "description": "The CES diagnostic information.", "type": "object", "properties": { "messages": { "description": "The messages in the turn.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" } }, "rootSpan": { "$ref": "GoogleCloudCesV1mainSpan", "description": "The root span of the action processing." } }, "id": "GoogleCloudContactcenterinsightsV1mainCesTurnAnnotation" }, "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", "properties": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1Dataset" }, "sampleRule": { "description": "Optional. The sample rule used for sampling conversations.", "$ref": "GoogleCloudContactcenterinsightsV1SampleRule" } }, "description": "The request to sample conversations to a dataset.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "properties": { "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "description": "The original request for export." }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "completedExportCount": { "format": "int32", "description": "The number of conversations that were exported successfully.", "type": "integer" } }, "description": "Metadata for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse": { "description": "The response for a bulk analyze conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse", "properties": { "failedAnalysisCount": { "format": "int32", "description": "Count of failed analyses.", "type": "integer" }, "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" } } }, "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata": { "description": "Metadata about conversation labels.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "properties": { "labelKey": { "description": "Optional. The label key.", "type": "string" }, "labelValue": { "description": "Optional. The label value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ArticleSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "properties": { "confidenceScore": { "format": "float", "description": "The system's confidence score that this article is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" }, "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" } }, "description": "Agent Assist Article Suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult" } } } }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult", "properties": { "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource" } }, "score": { "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "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" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswer" } }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" } } } }, "GoogleCloudContactcenterinsightsV1IssueAssignment": { "properties": { "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "score": { "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "description": "Information about the issue.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "analyzedConversationsCount": { "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string" }, "issueStats": { "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats" } }, "unclassifiedConversationsCount": { "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse": { "description": "The response of listing phrase matchers.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse", "properties": { "phraseMatchers": { "description": "The phrase matchers that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1Widget": { "description": "Represents a dashboard element, could be a nested Container or Chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Widget", "properties": { "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "container": { "description": "A container widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container" }, "chart": { "description": "A chart widget.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "chartReference": { "description": "A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult": { "description": "The result of a single constraint rule on the pair of conversations.", "type": "object", "properties": { "error": { "description": "The error status if the constraint expression failed to evaluate.", "$ref": "GoogleRpcStatus" }, "ruleId": { "description": "The rule ID.", "type": "string" }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" }, "GoogleCloudContactcenterinsightsV1alpha1QueryInterval": { "description": "A time window for querying conversations.", "type": "object", "properties": { "startTime": { "description": "Required. The start time of the time window.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "Required. The end time of the time window.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" } } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "description": "Average QA normalized score for the tag.", "type": "object", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata": { "description": "The metadata for an `UploadConversation` operation.", "type": "object", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "appliedRedactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Output only. The redaction config applied to the uploaded conversation.", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata" }, "GoogleCloudContactcenterinsightsV1Intent": { "id": "GoogleCloudContactcenterinsightsV1Intent", "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscript": { "properties": { "transcriptSegments": { "description": "A list of sequential transcript segments that comprise the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment" } } }, "id": "GoogleCloudContactcenterinsightsV1ConversationTranscript", "description": "A message representing the transcript of a conversation.", "type": "object" }, "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" }, "comparisonQueryInterval": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "The time window of the conversations to compare the performance to." }, "agentPerformanceSource": { "description": "Conversations are from a single agent.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource" }, "queryInterval": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval", "description": "Required. The time window of the conversations to derive performance stats from." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest", "description": "The request for summarizing performance according to different metrics for conversations over a specified time window.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest": { "properties": { "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "force": { "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "description": "The request to delete conversations in bulk.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata", "description": "Metadata used for import issue model.", "type": "object" }, "GoogleCloudCesV1mainSpan": { "properties": { "endTime": { "description": "Output only. The end time of the span.", "type": "string", "format": "google-datetime", "readOnly": true }, "attributes": { "readOnly": true, "description": "Output only. Key-value attributes associated with the span.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "name": { "description": "Output only. The name of the span.", "type": "string", "readOnly": true }, "duration": { "readOnly": true, "description": "Output only. The duration of the span.", "type": "string", "format": "google-duration" }, "startTime": { "description": "Output only. The start time of the span.", "type": "string", "format": "google-datetime", "readOnly": true }, "childSpans": { "description": "Output only. The child spans that are nested under this span.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainSpan" }, "readOnly": true } }, "id": "GoogleCloudCesV1mainSpan", "description": "A span is a unit of work or a single operation during the request processing.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment": { "description": "A segment of a full transcript.", "type": "object", "properties": { "dialogflowSegmentMetadata": { "description": "CCAI metadata relating to the current transcript segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata" }, "confidence": { "format": "float", "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this segment. A default value of 0.0 indicates that the value is unset.", "type": "number" }, "languageCode": { "description": "The language code of this segment as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "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" }, "text": { "description": "The text of this segment.", "type": "string" }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "The sentiment for this transcript segment." }, "words": { "description": "A list of the word-specific information for each word in the segment.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" } }, "turnLevelAudio": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio", "description": "Turn level audio for this transcript segment." }, "segmentParticipant": { "description": "The participant of this segment.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationParticipant" }, "messageTime": { "format": "google-datetime", "description": "The time that the message occurred, if provided.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegment" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. Create time of the label.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries": { "description": "A time series representing conversations over time.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeries", "properties": { "intervalDuration": { "format": "google-duration", "description": "The duration of each interval.", "type": "string" }, "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" } } } }, "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse": { "description": "The response from a ListQaScorecards request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse", "properties": { "qaScorecards": { "description": "The QaScorecards under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet": { "properties": { "createTime": { "description": "Output only. Create time.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. Update time.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet", "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "properties": { "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "failedAnalysesCount": { "description": "The number of requested analyses that have failed so far.", "type": "integer", "format": "int32" }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "completedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have completed successfully so far.", "type": "integer" }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest" }, "totalRequestedAnalysesCount": { "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse": { "description": "Response for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData", "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.", "type": "object", "additionalProperties": { "type": "string" } }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidence": { "format": "float", "description": "The confidence score of the summarization.", "type": "number" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object" } }, "description": "Conversation summarization suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest": { "properties": { "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource", "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication." }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig" }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "sampleSize": { "format": "int32", "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.", "type": "integer" }, "speechConfig": { "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "description": "The request to ingest conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse", "properties": {}, "description": "The response to an IngestConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions": { "description": "Options for configuring what metadata is included in the conversation data used in QAI and Discovery Engine.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions", "properties": { "includeDialogflowInteractionData": { "description": "Whether to include the per turn Dialogflow interaction data in conversation transcript.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1Analysis": { "description": "The analysis resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Analysis", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string" }, "annotatorSelector": { "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "requestTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was requested.", "type": "string" }, "analysisResult": { "readOnly": true, "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult" }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest": { "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object", "properties": { "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" } }, "sheetsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination", "description": "A sheets document destination." }, "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" }, "conversationFilter": { "description": "Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.", "type": "string" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "maxDownloadCount": { "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer" }, "feedbackLabelType": { "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "type": "object", "properties": { "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" }, "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript": { "description": "The conversation transcript for the chart.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The create time of the conversation.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The update time of the conversation.", "type": "string", "format": "google-datetime" }, "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": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "type": "object", "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "GoogleCloudContactcenterinsightsV1alpha1SilenceData": { "description": "The data for a silence annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "properties": { "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "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" ] }, "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" } }, "description": "Explicit input used for generating the answer", "type": "object" }, "GoogleCloudContactcenterinsightsV1QaQuestionTag": { "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "type": "object", "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" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" }, "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" } }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the question tag was created.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the question tag was updated.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswer": { "properties": { "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "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" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "description": "An answer to a QaQuestion.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "type": "object", "properties": { "labeledConversationsCount": { "format": "int64", "description": "Number of conversations attached to the issue at this point in time.", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput": { "description": "Wrapper for text output.", "type": "object", "properties": { "text": { "description": "The text output from the LLM.", "type": "array", "items": { "type": "string" } }, "textType": { "description": "The type of text output.", "type": "string", "enumDescriptions": [ "The type is unspecified.", "The text is part of LLM reasoning.", "The text is the final answer from LLM.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponseTextOutput" }, "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { "description": "Statistics for SampleConversations operation.", "type": "object", "properties": { "successfulSampleCount": { "readOnly": true, "format": "int32", "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer" }, "failedSampleCount": { "format": "int32", "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats" }, "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest": { "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue": { "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "properties": { "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "skipValue": { "readOnly": true, "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "normalizedScore": { "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double", "readOnly": true }, "potentialScore": { "format": "double", "description": "Output only. The maximum potential score of the question.", "type": "number", "readOnly": true }, "key": { "description": "A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.", "type": "string" }, "score": { "format": "double", "description": "Output only. Numerical score of the answer.", "type": "number", "readOnly": true }, "strValue": { "description": "String value.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse": { "properties": { "issues": { "description": "The issues that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse", "description": "The response of listing issues.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelRequest", "description": "The request to undeploy an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage": { "description": "The message in the conversation.", "type": "object", "properties": { "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "description": "For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "format": "google-datetime" }, "userMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageUserMessage", "description": "A message from the user that is interacting with the system." }, "systemMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessage", "description": "A message from the system in response to the user." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig": { "description": "A configuration that defines how to correlate conversations for a given a given project.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig", "properties": { "updateTime": { "description": "Output only. The time at which the correlation config was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "fullConversationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationTypeConfig", "description": "The correlation type config for full conversations." }, "createTime": { "readOnly": true, "description": "Output only. The time at which the correlation config was created.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "type": "string" } } }, "GoogleRpcStatus": { "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the join key expression failed to evaluate." }, "correlationId": { "description": "The correlation ID generated by the join key expression.", "type": "string" }, "ruleId": { "description": "The rule ID.", "type": "string" } }, "description": "The result of a single correlation rule.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure": { "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "aiCoachSuggestionCustomerMessageTriggerCount": { "format": "int32", "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "conversationalAgentsAverageEndToEndLatency": { "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number", "format": "double" }, "avgConversationClientTurnSentimentEma": { "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number" }, "aiCoachSuggestionAgentUsageCount": { "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer", "format": "int32" }, "knowledgeAssistNegativeFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number", "format": "double" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number" }, "summarizationSuggestionResultCount": { "format": "int32", "description": "Count of summarization suggestions results.", "type": "integer" }, "aiCoachSuggestionAgentUsageRatio": { "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number" }, "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "conversationalAgentsAverageTtsLatency": { "format": "double", "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number" }, "knowledgeAssistResultCount": { "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "conversationAiCoachSuggestionRatio": { "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number" }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "knowledgeSearchPositiveFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number" }, "aaSupervisorMonitoredConversationsCount": { "format": "int32", "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer" }, "averageQaNormalizedScore": { "format": "double", "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number" }, "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" }, "conversationCount": { "format": "int32", "description": "The conversation count.", "type": "integer" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number", "format": "double" }, "averageTurnCount": { "format": "float", "description": "The average turn count.", "type": "number" }, "aaSupervisorDroppedConversationsCount": { "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "averageSummarizationSuggestionEditDistance": { "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "type": "number", "format": "double" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } }, "containedConversationRatio": { "format": "double", "description": "The percentage of conversations that were contained.", "type": "number" }, "averageClientSentimentScore": { "format": "float", "description": "The average client's sentiment score.", "type": "number" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "aiCoachSuggestionMessageTriggerCount": { "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number" }, "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "dialogflowWebhookFailureRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that failed.", "type": "number" }, "summarizationSuggestionEditRatio": { "description": "Proportion of summarization suggestions that were manually edited.", "type": "number", "format": "double" }, "dialogflowConversationsEscalationRatio": { "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number", "format": "double" }, "dialogflowAverageWebhookLatency": { "description": "Average latency of dialogflow webhook calls.", "type": "number", "format": "double" }, "conversationTotalCustomerMessageCount": { "format": "int32", "description": "The customer message count.", "type": "integer" }, "aaSupervisorAssignedConversationsCount": { "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer", "format": "int32" }, "averageQaQuestionNormalizedScore": { "format": "double", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", "type": "number" }, "aaSupervisorEscalatedConversationsCount": { "format": "int32", "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "averageCustomerSatisfactionRating": { "description": "The average customer satisfaction rating.", "type": "number", "format": "double" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "knowledgeAssistUriClickRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number", "format": "double" }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "averageSummarizationSuggestionNormalizedEditDistance": { "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", "type": "number" }, "dialogflowInteractionsNoMatchRatio": { "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number", "format": "double" }, "averageSilencePercentage": { "description": "The average silence percentage.", "type": "number", "format": "float" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "conversationTotalAgentMessageCount": { "format": "int32", "description": "The agent message count.", "type": "integer" } }, "description": "The measure related to conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversation": { "description": "The conversation resource.", "type": "object", "properties": { "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" ] }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled 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" }, "labels": { "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object", "additionalProperties": { "type": "string" } }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "runtimeAnnotations": { "readOnly": true, "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotation" } }, "dialogflowIntents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainDialogflowIntent" }, "description": "Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}", "type": "object", "readOnly": true }, "latestAnalysis": { "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysis", "readOnly": true }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the conversation was created.", "type": "string" }, "duration": { "description": "Output only. The duration of the conversation.", "type": "string", "format": "google-duration", "readOnly": true }, "latestSummary": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData", "description": "Output only. Latest summary of the conversation." }, "turnCount": { "readOnly": true, "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32" }, "dataSource": { "description": "The source of the audio and transcription for the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationDataSource" }, "expireTime": { "format": "google-datetime", "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "transcript": { "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationTranscript", "readOnly": true }, "ttl": { "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string" }, "correlationInfo": { "readOnly": true, "description": "Output only. Info for correlating across conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationInfo" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the conversation was updated.", "type": "string", "readOnly": true }, "callMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "description": "Call-specific metadata." }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "qualityMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata", "description": "Conversation metadata related to quality management." } }, "id": "GoogleCloudContactcenterinsightsV1mainConversation" }, "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata": { "id": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "properties": { "entities": { "description": "All the entities in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Entity" } }, "annotations": { "description": "A list of call annotations that apply to this call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1CallAnnotation" } }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment" } }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModelResult" }, "intents": { "description": "All the matched intents in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1Intent" } }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResult" } }, "silence": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence", "description": "Overall conversation-level silence during the call." }, "phraseMatchers": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "description": "All the matched phrase matchers in the call.", "type": "object" } }, "description": "Call-specific metadata created during analysis.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "properties": { "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1CesTurnAnnotation": { "description": "The CES diagnostic information.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation", "properties": { "rootSpan": { "description": "The root span of the action processing.", "$ref": "GoogleCloudCesV1mainSpan" }, "messages": { "description": "The messages in the turn.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" } } } }, "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse": { "description": "The response for listing feedback labels.", "type": "object", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "nextPageToken": { "description": "The next page token.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" }, "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" }, "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" }, "agentDeploymentId": { "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentDisplayName": { "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentVersionDisplayName": { "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse": { "properties": { "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModel", "description": "The issue model that was imported." } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelResponse", "description": "Response from import issue model", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { "properties": { "toolDisplayName": { "description": "Optional. The dialogflow tool display name.", "type": "string" }, "toolId": { "description": "Optional. The dialogflow tool ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Metadata about the Conversational Agents tool dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", "properties": { "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" }, "correctnessLevel": { "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "type": "string" } }, "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "ingestConversationsStats": { "description": "Output only. Statistics for IngestConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats", "readOnly": true }, "sampledConversations": { "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest", "readOnly": true }, "partialErrors": { "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource", "properties": { "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": "GoogleCloudContactcenterinsightsV1alpha1GcsSource" }, "dialogflowSource": { "description": "The source when the conversation comes from Dialogflow.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DialogflowSource" }, "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": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio" } } }, "description": "The conversation source, which is a combination of transcript and audio.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Note": { "description": "The conversation assessment note resource.", "type": "object", "properties": { "conversationTurnNote": { "description": "The note is associated with a conversation turn.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote" }, "name": { "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "type": "string" }, "assessmentNote": { "description": "The note is associated to the entire parent assessment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteAssessmentNote" }, "noteCreator": { "description": "Output only. The user that created the note.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the note was last updated.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the note was created.", "type": "string" }, "qaQuestionNote": { "description": "The note is associated with a QA question in one of the conversation's scorecard results.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1NoteQaQuestionNote" }, "content": { "description": "The note content.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats": { "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats", "properties": { "successfulSampleCount": { "description": "Output only. The number of new conversations added during this sample operation.", "type": "integer", "format": "int32", "readOnly": true }, "failedSampleCount": { "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", "type": "integer", "format": "int32", "readOnly": true } }, "description": "Statistics for SampleConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata": { "description": "The metadata for deleting a QaQuestionTag Resource.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "description": "Output only. The original request." }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig": { "description": "Configuration that applies to all conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig", "properties": { "customerChannel": { "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer", "format": "int32" }, "agentId": { "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" }, "agentChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" } } }, "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": { "name": { "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string" }, "displayName": { "description": "Display Name. Limit 64 characters.", "type": "string" }, "conversationFilter": { "description": "A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the authorized view was updated.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time at which the authorized view was created.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest": { "properties": { "name": { "description": "Required. The name of the QaQuestionTag to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest", "description": "The request for deleting a QaQuestionTag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig": { "description": "Configuration for summarization.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig", "properties": { "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, "summarizationModel": { "enumDeprecated": [ false, true, true ], "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" } } }, "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource": { "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval": { "properties": { "conversationCount": { "format": "int32", "description": "The number of conversations created in this interval.", "type": "integer" }, "startTime": { "format": "google-datetime", "description": "The start time of this interval.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponseTimeSeriesInterval", "description": "A single interval in a time series.", "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.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel", "properties": { "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. Create time of the label.", "type": "string", "format": "google-datetime", "readOnly": true }, "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage" }, "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "readOnly": true }, "systemMessageWrapper": { "description": "A wrapper for system messages per turn.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" }, "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult": { "description": "The result of testing correlation config on a single conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResultRuleCorrelationResult" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCorrelationResult" }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse", "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" } }, "description": "The response from a ListAuthorizedViews request.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "description": "The original request for bulk delete." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "The metadata for a bulk delete conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList": { "description": "Container for a list of scorecards.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure": { "description": "The measure related to conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { "conversationAiCoachSuggestionRatio": { "format": "double", "description": "Proportion of conversations that has Ai Coach Suggestions.", "type": "number" }, "knowledgeAssistResultCount": { "format": "int32", "description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", "type": "integer" }, "knowledgeSearchUriClickRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "knowledgeSearchNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "conversationalAgentsAverageTtsLatency": { "format": "double", "description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", "type": "number" }, "dialogflowWebhookTimeoutRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that timed out.", "type": "number" }, "summarizationSuggestionResultCount": { "format": "int32", "description": "Count of summarization suggestions results.", "type": "integer" }, "knowledgeAssistNegativeFeedbackRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", "type": "number" }, "aiCoachSuggestionCustomerMessageTriggerRatio": { "format": "double", "description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", "type": "number" }, "aiCoachSuggestionAgentUsageRatio": { "format": "double", "description": "Proportion of Ai Coach Suggestion that has been used by agents.", "type": "number" }, "aiCoachSuggestionAgentUsageCount": { "format": "int32", "description": "Count of Ai Coach Suggestion that has been used by agents.", "type": "integer" }, "aiCoachSuggestionCustomerMessageTriggerCount": { "description": "Count of customer messages that triggered an Ai Coach Suggestion.", "type": "integer", "format": "int32" }, "avgConversationClientTurnSentimentEma": { "format": "double", "description": "The exponential moving average of the sentiment score of client turns in the conversation.", "type": "number" }, "conversationalAgentsAverageEndToEndLatency": { "format": "double", "description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", "type": "number" }, "averageClientSentimentScore": { "description": "The average client's sentiment score.", "type": "number", "format": "float" }, "containedConversationRatio": { "description": "The percentage of conversations that were contained.", "type": "number", "format": "double" }, "aaSupervisorTransferredToHumanAgentConvCount": { "description": "The number of conversations transferred to a human agent.", "type": "integer", "format": "int32" }, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" } }, "averageSummarizationSuggestionEditDistance": { "format": "double", "description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", "type": "number" }, "conversationalAgentsAverageLlmCallLatency": { "format": "double", "description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", "type": "number" }, "aaSupervisorDroppedConversationsCount": { "format": "int32", "description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", "type": "integer" }, "conversationAiCoachSuggestionCount": { "description": "Count of conversations that has Ai Coach Suggestions.", "type": "integer", "format": "int32" }, "averageTurnCount": { "format": "float", "description": "The average turn count.", "type": "number" }, "conversationalAgentsAverageAudioInAudioOutLatency": { "format": "double", "description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", "type": "number" }, "knowledgeSearchSuggestedQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", "type": "number" }, "conversationCount": { "description": "The conversation count.", "type": "integer", "format": "int32" }, "averageQaNormalizedScore": { "description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "type": "number", "format": "double" }, "aaSupervisorMonitoredConversationsCount": { "description": "The number of conversations scanned by the AA human supervisor.", "type": "integer", "format": "int32" }, "averageDuration": { "description": "The average duration.", "type": "string", "format": "google-duration" }, "knowledgeSearchPositiveFeedbackRatio": { "description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "conversationSuggestedSummaryRatio": { "format": "double", "description": "Proportion of conversations that had a suggested summary.", "type": "number" }, "averageQaQuestionNormalizedScore": { "format": "double", "description": "Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.", "type": "number" }, "aaSupervisorEscalatedConversationsCount": { "description": "The number of conversations that were escalated to an AA human supervisor for intervention.", "type": "integer", "format": "int32" }, "dialogflowConversationsEscalationRatio": { "format": "double", "description": "Proportion of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "dialogflowAverageWebhookLatency": { "format": "double", "description": "Average latency of dialogflow webhook calls.", "type": "number" }, "conversationTotalCustomerMessageCount": { "format": "int32", "description": "The customer message count.", "type": "integer" }, "aaSupervisorAssignedConversationsCount": { "format": "int32", "description": "The number of conversations that were assigned to an AA human supervisor.", "type": "integer" }, "summarizationSuggestionEditRatio": { "format": "double", "description": "Proportion of summarization suggestions that were manually edited.", "type": "number" }, "knowledgeSearchResultCount": { "description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", "type": "integer", "format": "int32" }, "dialogflowWebhookFailureRatio": { "format": "double", "description": "Proportion of dialogflow webhook calls that failed.", "type": "number" }, "dialogflowConversationsEscalationCount": { "format": "double", "description": "count of conversations that was handed off from virtual agent to human agent.", "type": "number" }, "containedConversationCount": { "format": "int32", "description": "The number of conversations that were contained.", "type": "integer" }, "aiCoachSuggestionMessageTriggerCount": { "format": "int32", "description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "knowledgeSearchAgentQuerySourceRatio": { "format": "double", "description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", "type": "number" }, "dialogflowInteractionsNoMatchRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has no intent match for the input.", "type": "number" }, "conversationTotalAgentMessageCount": { "format": "int32", "description": "The agent message count.", "type": "integer" }, "averageSilencePercentage": { "format": "float", "description": "The average silence percentage.", "type": "number" }, "aiCoachSuggestionMessageTriggerRatio": { "description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", "type": "number", "format": "double" }, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "type": "number", "format": "float" }, "averageSummarizationSuggestionNormalizedEditDistance": { "format": "double", "description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", "type": "number" }, "knowledgeAssistUriClickRatio": { "format": "double", "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", "type": "number" }, "aiCoachSuggestionAgentMessageTriggerCount": { "format": "int32", "description": "Count of agent messages that triggered an Ai Coach Suggestion.", "type": "integer" }, "dialogflowInteractionsNoInputRatio": { "format": "double", "description": "Proportion of dialogflow interactions that has empty input.", "type": "number" }, "knowledgeAssistPositiveFeedbackRatio": { "description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", "type": "number", "format": "double" }, "averageCustomerSatisfactionRating": { "format": "double", "description": "The average customer satisfaction rating.", "type": "number" } } }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", "description": "Request for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DialogflowInteractionData": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData", "description": "Dialogflow interaction data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "description": "The original request for undeployment.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", "description": "Metadata for undeploying an issue model.", "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": { "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" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "$ref": "GoogleRpcStatus", "description": "The error result of the operation in case of failure or cancellation." } } }, "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagMetadata", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "Output only. The original request.", "$ref": "GoogleCloudContactcenterinsightsV1mainUpdateQaQuestionTagRequest", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" } }, "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult": { "id": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResult", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConstraintEvaluationResultRuleConstraintResult" } } }, "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "properties": { "sampleRule": { "$ref": "GoogleCloudContactcenterinsightsV1mainSampleRule", "description": "Optional. The sample rule used for sampling conversations." }, "destinationDataset": { "$ref": "GoogleCloudContactcenterinsightsV1mainDataset", "description": "The dataset resource to copy the sampled conversations to." }, "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse", "properties": { "chartSpec": { "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textMessage": { "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponseTextOutput" }, "textOutput": { "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" } }, "description": "Wrapper for storing the generative response for a chart.", "type": "object" }, "GoogleTypeInterval": { "properties": { "endTime": { "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": "string" }, "startTime": { "format": "google-datetime", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string" } }, "id": "GoogleTypeInterval", "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSentimentData": { "id": "GoogleCloudContactcenterinsightsV1mainSentimentData", "properties": { "magnitude": { "format": "float", "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number" }, "score": { "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number" } }, "description": "The data for a sentiment annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1UploadConversationMetadata": { "properties": { "analysisOperation": { "description": "Output only. The operation name for a successfully created analysis operation, if any.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "appliedRedactionConfig": { "description": "Output only. The redaction config applied to the uploaded conversation.", "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UploadConversationRequest", "description": "Output only. The original request.", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1UploadConversationMetadata", "description": "The metadata for an `UploadConversation` operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCallMetadata": { "id": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata", "properties": { "customerChannel": { "format": "int32", "description": "The audio channel that contains the customer.", "type": "integer" }, "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" } }, "description": "Call-specific metadata.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata", "properties": { "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original export request.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" } }, "description": "Metadata used for export issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback", "properties": { "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" }, "correctnessLevel": { "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination": { "description": "Google Cloud Storage Object URI to save the issue model to.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequestGcsDestination" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "description": "An error that occurred during correlation for a specific conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "properties": { "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" }, "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDimension": { "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimension", "properties": { "dimensionKey": { "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "description": "The key of the dimension.", "type": "string" }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata" }, "qaScorecardDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA scorecard dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" }, "qaQuestionAnswerDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension.", "readOnly": true }, "conversationProfileDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "description": "Output only. Metadata about the conversation profile dimension." }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension." }, "clientSentimentCategoryDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionClientSentimentCategoryDimensionMetadata", "description": "Output only. Metadata about the client sentiment category dimension." }, "issueDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, "labelDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionLabelDimensionMetadata" }, "agentDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the agent dimension.", "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionAgentDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "readOnly": true }, "mediumDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainDimensionMediumDimensionMetadata", "description": "Output only. Metadata about the conversation medium dimension." } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions", "properties": { "conversationDataOptions": { "description": "Options for configuring the conversation data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataOptions" } } }, "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData": { "properties": { "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" }, "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainSmartComposeSuggestionData", "description": "Agent Assist Smart Compose suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata": { "description": "The metadata for querying performance overview.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata", "properties": {} }, "GoogleCloudContactcenterinsightsV1IngestConversationsResponse": { "description": "The response to an IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary": { "properties": { "wordIndex": { "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer", "format": "int32" }, "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object" }, "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": { "answerValue": { "description": "Optional. The full body of the question.", "type": "string" }, "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1QaScorecardResult": { "id": "GoogleCloudContactcenterinsightsV1QaScorecardResult", "properties": { "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" } }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswer" } }, "createTime": { "description": "Output only. The timestamp that the revision was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "normalizedScore": { "format": "double", "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number" }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource" } }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" } }, "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SmartReplyData", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" } }, "description": "Agent Assist Smart Reply data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest", "properties": {}, "description": "The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint" } } }, "description": "A time series of metric values.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDialogflowSource": { "properties": { "dialogflowConversation": { "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string", "readOnly": true }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDialogflowSource", "description": "A Dialogflow source of conversation data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { "description": "The request to sample conversations to a dataset.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "properties": { "parent": { "description": "Required. The parent resource of the dataset.", "type": "string" }, "destinationDataset": { "description": "The dataset resource to copy the sampled conversations to.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "sampleRule": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "description": "Optional. The sample rule used for sampling conversations." } } }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse": { "properties": { "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The chart spec for the data. This will be specified in the vega-lite or vega format.", "type": "object" }, "textMessage": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponseTextOutput", "description": "The text output from the LLM. Will be populated during the chart building phase. For a reloaded chart, this will NOT be populated. May contain THOUGHT or a FINAL response or some in-progress response." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse", "description": "Wrapper for storing the generative response for a chart.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig": { "description": "Configs for the input data used to create the issue model.", "type": "object", "properties": { "medium": { "deprecated": true, "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ] }, "trainingConversationsCount": { "description": "Output only. Number of conversations used in training. Output only.", "type": "string", "format": "int64", "readOnly": true }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata": { "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Metadata about the QA question dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainFaqAnswerData": { "id": "GoogleCloudContactcenterinsightsV1mainFaqAnswerData", "properties": { "question": { "description": "The corresponding FAQ question.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the FAQ answer and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidenceScore": { "description": "The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } }, "description": "Agent Assist frequently-asked-question answer data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "properties": { "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "completedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have completed successfully so far.", "type": "integer" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "totalRequestedAnalysesCount": { "format": "int32", "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "type": "integer" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original request for bulk analyze.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata", "description": "The metadata for a bulk analyze conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence": { "properties": { "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" }, "silencePercentage": { "description": "Percentage of the total conversation spent in silence.", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence", "description": "Conversation-level silence data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1SampleRule": { "id": "GoogleCloudContactcenterinsightsV1SampleRule", "properties": { "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number", "format": "double" }, "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" } }, "description": "Message for sampling conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "properties": { "sentimentCategory": { "description": "Optional. The client sentiment category.", "type": "string" } }, "description": "Metadata about the client sentiment category dimension.", "type": "object" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainEncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "type": "object", "properties": { "startOffset": { "format": "google-duration", "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string" }, "endOffset": { "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string", "format": "google-duration" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationTranscriptTranscriptSegmentWordInfo" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult": { "properties": { "conversation": { "description": "The conversation resource name.", "type": "string" }, "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResultRuleCorrelationResult" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult", "description": "The result of testing correlation config on a single conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "properties": { "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" }, "kmsKey": { "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { "description": "Metadata about the conversation medium dimension.", "type": "object", "properties": { "medium": { "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript": { "description": "The conversation transcript for the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript", "properties": { "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" } }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The update time of the conversation.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The create time of the conversation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse", "properties": { "labelResult": { "description": "The result of the test auto labeling rule.", "type": "string" } }, "description": "The response message for testing auto labeling rules.", "type": "object" }, "GoogleProtobufEmpty": { "properties": {}, "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { "description": "Metadata about the conversation profile dimension.", "type": "object", "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainIntentMatchData": { "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { "description": "The response for a bulk delete conversations operation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig", "properties": { "summarizationModel": { "type": "string", "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used.", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ] }, "generator": { "description": "The resource name of the existing created generator. Format: projects//locations//generators/", "type": "string" }, "conversationProfile": { "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" } }, "description": "Configuration for summarization.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecard": { "properties": { "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, "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" }, "source": { "description": "Output only. The source of the scorecard.", "readOnly": true, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "type": "string", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment." ] }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The most recent time at which the scorecard was updated.", "type": "string" }, "isDefault": { "description": "Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.", "type": "boolean" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this scorecard was created.", "type": "string", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard", "description": "A QaScorecard represents a collection of questions to be scored during analysis.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata": { "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsRequest", "description": "The original request for bulk delete." }, "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "description": "The original request for deletion." } }, "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1mainIntent": { "properties": { "id": { "description": "The unique identifier of the intent.", "type": "string" }, "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIntent", "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest": { "description": "The request for querying metrics.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest", "properties": { "measureMask": { "description": "Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is \"conversation_measure.count\".", "type": "string", "format": "google-fieldmask" }, "timeGranularity": { "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" ], "description": "The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.", "type": "string" }, "filter": { "description": "Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). ", "type": "string" }, "dimensions": { "description": "The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dimension" } } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "description": "Average tag normalized score per tag.", "type": "number", "format": "double" } }, "description": "Average QA normalized score for the tag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "properties": { "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" }, "disableWordTimeOffsets": { "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" } } }, "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": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } } } }, "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata": { "description": "Metadata about the QA question dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaQuestionDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation": { "description": "The CES diagnostic information.", "type": "object", "properties": { "rootSpan": { "$ref": "GoogleCloudCesV1mainSpan", "description": "The root span of the action processing." }, "messages": { "description": "The messages in the turn.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CesTurnAnnotation" }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats": { "description": "Aggregated statistics about an issue.", "type": "object", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "GoogleCloudContactcenterinsightsV1mainSilenceData": { "description": "The data for a silence annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainSilenceData" }, "GoogleCloudContactcenterinsightsV1mainAnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnswerFeedback", "properties": { "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" }, "correctnessLevel": { "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ], "description": "The correctness level of an answer.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig": { "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" }, "customerChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "agentId": { "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1UploadConversationRequest": { "description": "Request to upload a conversation.", "type": "object", "properties": { "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": "GoogleCloudContactcenterinsightsV1RedactionConfig" }, "conversation": { "$ref": "GoogleCloudContactcenterinsightsV1Conversation", "description": "Required. The conversation resource to create." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1UploadConversationRequest" }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "properties": { "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueMatchData" }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1HoldData" }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData" }, "phraseMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", "description": "Data specifying a phrase match." }, "silenceData": { "description": "Data specifying silence.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SilenceData" }, "annotationStartBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "annotationEndBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "Data specifying sentiment." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest": { "description": "The request to undeploy a QaScorecardRevision", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", "properties": {}, "description": "Response from export issue model", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscript", "description": "The transcript of the generative insights conversation." } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsResponse" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint": { "description": "A data point contains the metric values mapped to an interval.", "type": "object", "properties": { "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." }, "interval": { "$ref": "GoogleTypeInterval", "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." }, "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" }, "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata": { "description": "Call-specific metadata created during analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnalysisResultCallAnalysisMetadata", "properties": { "annotations": { "description": "A list of call annotations that apply to this call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainCallAnnotation" } }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment" } }, "issueModelResult": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "description": "Overall conversation-level issue modeling result." }, "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainEntity" }, "description": "All the entities in the call.", "type": "object" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1mainConversationLevelSilence" }, "phraseMatchers": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "description": "All the matched phrase matchers in the call.", "type": "object" }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResult" } }, "intents": { "description": "All the matched intents in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntent" } } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsMetadata", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage": { "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "type": "object" }, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "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" } }, "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "gcsSource": { "description": "Google Cloud Storage source message.", "$ref": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequest", "description": "Request to import an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse", "description": "Response for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } } }, "GoogleCloudContactcenterinsightsV1mainEntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainEntityMentionData", "properties": { "entityUniqueId": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" }, "type": { "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "description": "The type of the entity mention.", "type": "string" }, "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "Sentiment expressed for this mention of the entity." } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse", "description": "Response from export issue model", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "sampleConversationsStats": { "readOnly": true, "description": "Output only. Statistics for SampleConversations operation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadataSampleConversationsStats" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainSampleConversationsRequest", "description": "Output only. The original request for sample conversations to dataset." }, "partialErrors": { "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainSampleConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint", "properties": { "sessionId": { "description": "The session id of the chart.", "type": "string" }, "revisionId": { "description": "The revision id of the chart.", "type": "string" } }, "description": "The current chart checkpoint state.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult": { "description": "The result of testing a constraint expression on a pair of conversations.", "type": "object", "properties": { "conversationA": { "description": "The first conversation resource name.", "type": "string" }, "conversationB": { "description": "The second conversation resource name.", "type": "string" }, "ruleConstraintResults": { "description": "The results for each applicable constraint rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult" } } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResult" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestSheetsSource", "description": "Google Sheets document details to get the feedback label file from.", "type": "object" }, "GoogleCloudContactcenterinsightsV1PhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1PhraseMatchData" }, "GoogleCloudCesV1mainEndSession": { "description": "Indicates the session has terminated, due to either successful completion (e.g. user says \"Good bye!\" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.", "type": "object", "properties": { "metadata": { "description": "Optional. Provides additional information about the end session signal, such as the reason for ending the session.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "GoogleCloudCesV1mainEndSession" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "The original request for deletion.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelMetadata", "description": "Metadata for deleting an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "properties": { "channelTag": { "format": "int32", "description": "The channel of the audio that the data applies to.", "type": "integer" }, "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1SentimentData", "description": "Data specifying sentiment." } }, "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination": { "properties": { "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" ] }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "description": "Optional. The number of records per file. Applicable for either format.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination", "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest": { "description": "The request to ingest conversations.", "type": "object", "properties": { "redactionConfig": { "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.", "$ref": "GoogleCloudContactcenterinsightsV1mainRedactionConfig" }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "transcriptObjectConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestTranscriptObjectConfig", "description": "Configuration for when `source` contains conversation transcripts." }, "sampleSize": { "description": "Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.", "type": "integer", "format": "int32" }, "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestGcsSource" }, "conversationConfig": { "description": "Configuration that applies to all conversations.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequestConversationConfig" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse": { "description": "The response from a ListAuthorizedViewSet request.", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "authorizedViewSets": { "description": "The AuthorizedViewSets under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest": { "properties": { "feedbackLabelType": { "enumDescriptions": [ "Unspecified format", "Downloaded file will contain all Quality AI labels from the latest scorecard revision.", "Downloaded file will contain only Topic Modeling labels.", "Agent Assist Summarization labels." ], "enum": [ "FEEDBACK_LABEL_TYPE_UNSPECIFIED", "QUALITY_AI", "TOPIC_MODELING", "AGENT_ASSIST_SUMMARY" ], "description": "Optional. The type of feedback labels that will be downloaded.", "type": "string" }, "gcsDestination": { "description": "A cloud storage bucket destination.", "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination" }, "maxDownloadCount": { "format": "int32", "description": "Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.", "type": "integer" }, "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": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "parent": { "description": "Required. The parent resource for new feedback labels.", "type": "string" }, "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" } } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest", "description": "Request for the BulkDownloadFeedbackLabel endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { "description": "Message for sampling conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", "properties": { "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "samplePercentage": { "format": "double", "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice": { "description": "Message representing a possible answer to the question.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice", "properties": { "boolValue": { "description": "Boolean value.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "key": { "description": "A short string used as an identifier.", "type": "string" }, "score": { "format": "double", "description": "Numerical score of the answer, used for generating the overall score of a QaScorecardResult. If the answer uses na_value, this field is unused.", "type": "number" }, "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" } } }, "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" }, "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" } }, "audioBucketUri": { "description": "Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.", "type": "string" }, "metadataBucketUri": { "description": "Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.", "type": "string" }, "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" }, "bucketObjectType": { "description": "Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.", "type": "string", "enumDescriptions": [ "The object type is unspecified and will default to `TRANSCRIPT`.", "The object is a transcript.", "The object is an audio file." ], "enum": [ "BUCKET_OBJECT_TYPE_UNSPECIFIED", "TRANSCRIPT", "AUDIO" ] } } }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata": { "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest", "description": "The original request for creation." }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest", "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "description": "The request to delete an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest": { "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest", "description": "The request to delete an issue model.", "type": "object" }, "GoogleCloudCesV1mainChunk": { "description": "A chunk of content within a message.", "type": "object", "id": "GoogleCloudCesV1mainChunk", "properties": { "blob": { "$ref": "GoogleCloudCesV1mainBlob", "description": "Optional. Blob data." }, "transcript": { "description": "Optional. Transcript associated with the audio.", "type": "string" }, "agentTransfer": { "description": "Optional. Agent transfer event.", "$ref": "GoogleCloudCesV1mainAgentTransfer" }, "payload": { "description": "Optional. Custom payload data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "updatedVariables": { "description": "A struct represents variables that were updated in the conversation, keyed by variable names.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "defaultVariables": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct represents default variables at the start of the conversation, keyed by variable names.", "type": "object" }, "text": { "description": "Optional. Text data.", "type": "string" }, "image": { "description": "Optional. Image data.", "$ref": "GoogleCloudCesV1mainImage" }, "toolResponse": { "$ref": "GoogleCloudCesV1mainToolResponse", "description": "Optional. Tool execution response." }, "toolCall": { "description": "Optional. Tool execution request.", "$ref": "GoogleCloudCesV1mainToolCall" } } }, "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "createNewModel": { "description": "Optional. If set to true, will create an issue model from the imported file with randomly generated IDs for the issue model and corresponding issues. Otherwise, replaces an existing model with the same ID as the file.", "type": "boolean" }, "gcsSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource", "description": "Google Cloud Storage source message." } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest", "description": "Request to import an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination": { "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestGcsDestination", "properties": { "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" ] }, "objectUri": { "description": "Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`", "type": "string" }, "addWhitespace": { "description": "Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.", "type": "boolean" }, "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "type": "string" } }, "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModel": { "description": "The issue model resource.", "type": "object", "properties": { "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelInputDataConfig" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "languageCode": { "description": "Language of the model.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "issueCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of issues in this issue model.", "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "description": "Output only. State of the model.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ] }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "trainingStats": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStats", "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true }, "modelType": { "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ], "description": "Type of the model.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModel" }, "GoogleCloudContactcenterinsightsV1mainGcsSource": { "description": "A Cloud Storage source of conversation data.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "properties": { "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessage" } } }, "description": "A wrapper for system messages per turn.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage": { "description": "The user message.", "type": "object", "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" }, "GoogleCloudContactcenterinsightsV1alpha1Dataset": { "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. Dataset update time.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string" }, "type": { "description": "Dataset usage type.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse": { "description": "The response of listing views.", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "views": { "description": "The views that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment", "description": "One channel of conversation-level sentiment data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetrics", "properties": { "request": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "description": "Request data that use the existing QueryMetrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata": { "description": "Metadata for an export insights operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataMetadata", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "completedExportCount": { "format": "int32", "description": "The number of conversations that were exported successfully.", "type": "integer" }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "failedExportCount": { "format": "int32", "description": "The number of conversations that failed to be exported.", "type": "integer" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest", "description": "The original request for export." } } }, "GoogleCloudContactcenterinsightsV1RedactionConfig": { "id": "GoogleCloudContactcenterinsightsV1RedactionConfig", "properties": { "inspectTemplate": { "description": "The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`", "type": "string" }, "deidentifyTemplate": { "description": "The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`", "type": "string" } }, "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponse": { "description": "The response for querying metrics.", "type": "object", "properties": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "The metrics last update time.", "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": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice" } } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponse" }, "GoogleCloudContactcenterinsightsV1SilenceData": { "description": "The data for a silence annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1SilenceData", "properties": {} }, "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { "properties": { "issueModel": { "description": "The issue model that was imported.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", "description": "Response from import issue model", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCallAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCallAnnotation", "properties": { "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "issueMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "description": "Data specifying an issue match." }, "entityMentionData": { "description": "Data specifying an entity mention.", "$ref": "GoogleCloudContactcenterinsightsV1mainEntityMentionData" }, "holdData": { "description": "Data specifying a hold.", "$ref": "GoogleCloudContactcenterinsightsV1mainHoldData" }, "intentMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1mainIntentMatchData", "description": "Data specifying an intent match." }, "phraseMatchData": { "description": "Data specifying a phrase match.", "$ref": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "annotationStartBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation starts, inclusive." }, "annotationEndBoundary": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotationBoundary", "description": "The boundary in the conversation where the annotation ends, inclusive." }, "silenceData": { "$ref": "GoogleCloudContactcenterinsightsV1mainSilenceData", "description": "Data specifying silence." }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1mainInterruptionData" } }, "description": "A piece of metadata that applies to a window of a call.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata": { "description": "Metadata used for import issue model.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "description": "The original import request.", "$ref": "GoogleCloudContactcenterinsightsV1ImportIssueModelRequest" }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig": { "properties": { "customerChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" }, "agentId": { "description": "Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this will be overridden if per-conversation metadata is provided through the `metadata_bucket_uri`.", "type": "string" }, "agentChannel": { "format": "int32", "description": "Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "description": "The transcript of the generative insights conversation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscript" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1Issue": { "properties": { "displayDescription": { "description": "Representative description of the issue.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time that this issue was updated.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. The time at which this issue was created.", "type": "string", "format": "google-datetime" }, "name": { "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "The representative name for the issue.", "type": "string" }, "sampleUtterances": { "description": "Output only. Resource names of the sample representative utterances that match to this issue.", "type": "array", "items": { "type": "string" }, "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Issue", "description": "The issue resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult": { "id": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResultRuleConstraintResult", "properties": { "ruleId": { "description": "The rule ID.", "type": "string" }, "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" } }, "description": "The result of a single constraint rule on the pair of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest": { "description": "The request to export insights.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest", "properties": { "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "writeDisposition": { "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "description": "Options for what to do if the destination table already exists.", "type": "string" }, "exportSchemaVersion": { "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "description": "Optional. Version of the export schema.", "type": "string" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata": { "properties": { "ingestConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "description": "Output only. Statistics for IngestConversations operation." }, "sampledConversations": { "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" } }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "readOnly": true, "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1mainIngestConversationsRequest" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadata", "description": "The metadata for an IngestConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue": { "id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "properties": { "skipValue": { "readOnly": true, "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "type": "boolean" }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "normalizedScore": { "readOnly": true, "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double" }, "potentialScore": { "format": "double", "description": "Output only. The maximum potential score of the question.", "type": "number", "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" }, "score": { "format": "double", "description": "Output only. Numerical score of the answer.", "type": "number", "readOnly": true } }, "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object" }, "GoogleIamV1TestIamPermissionsResponse": { "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleIamV1TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { "id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "description": "Metadata about the QA scorecard dimension.", "type": "object" }, "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" } } }, "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).", "type": "number", "format": "float" }, "uri": { "description": "Article URI.", "type": "string" }, "metadata": { "description": "Map that contains metadata about the Article Suggestion and the document that it originates from.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "title": { "description": "Article title.", "type": "string" }, "source": { "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" } }, "description": "Agent Assist Article Suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", "properties": { "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "issueModels": { "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", "type": "array", "items": { "type": "string" } }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig" }, "phraseMatchers": { "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array", "items": { "type": "string" } }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runAutoLabelingAnnotator": { "description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", "type": "boolean" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "runSummarizationAnnotator": { "description": "Whether to run the summarization 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" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { "properties": { "p90": { "description": "The 90th percentile value.", "type": "number", "format": "double" }, "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList": { "properties": { "qaScorecardRevisions": { "description": "List of QaScorecardRevisions.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList", "description": "Container for a list of scorecards.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "properties": { "text": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } }, "textType": { "description": "The type of the text message.", "type": "string", "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ] } }, "description": "A text output message from the system.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment": { "description": "Information about the issue.", "type": "object", "properties": { "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "score": { "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment" }, "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment": { "id": "GoogleCloudContactcenterinsightsV1mainConversationLevelSentiment", "properties": { "channelTag": { "format": "int32", "description": "The channel of the audio that the data applies to.", "type": "integer" }, "sentimentData": { "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData", "description": "Data specifying sentiment." } }, "description": "One channel of conversation-level sentiment data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights": { "description": "Request that use natural language query to generate the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsights", "properties": { "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec for the chart.", "type": "object" }, "chartConversations": { "deprecated": true, "type": "array", "readOnly": true, "description": "Output only. The chart conversations used to generate the chart.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" } }, "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" }, "chartCheckpoint": { "description": "The chart checkpoint used to generate the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartCheckpoint" }, "sqlQuery": { "description": "SQL query used to generate the chart.", "type": "string" } } }, "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.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "type": "object", "properties": { "issueDisplayName": { "description": "The issue display name.", "type": "string" }, "issueId": { "description": "The issue ID.", "type": "string" }, "issueModelId": { "description": "The parent issue model ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainEntity": { "id": "GoogleCloudContactcenterinsightsV1mainEntity", "properties": { "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" ] }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1mainSentimentData" }, "salience": { "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object" } }, "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" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1IssueMatchData": { "description": "The data for an issue match annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueMatchData", "properties": { "issueAssignment": { "description": "Information about the issue's assignment.", "$ref": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages": { "description": "A wrapper for system messages per turn.", "type": "object", "properties": { "systemMessages": { "description": "A message from the system in response to the user.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessages" }, "GoogleCloudContactcenterinsightsV1alpha1Settings": { "properties": { "analysisConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "description": "Default analysis settings." }, "diagnosticMetricConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "description": "Optional. Configuration for diagnostic metrics." }, "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" }, "conversationTtl": { "description": "The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.", "type": "string", "format": "google-duration" }, "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}", "type": "object", "additionalProperties": { "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" }, "speechConfig": { "description": "Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig" }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which the settings was created.", "type": "string", "readOnly": true }, "redactionConfig": { "description": "Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the settings were last updated.", "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" }, "name": { "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Settings", "description": "The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) and change the settings with [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p90": { "description": "The 90th percentile value.", "type": "number", "format": "double" }, "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p50": { "description": "The 50th percentile value.", "type": "number", "format": "double" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher", "properties": { "revisionCreateTime": { "description": "Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.", "type": "string", "format": "google-datetime", "readOnly": true }, "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" ], "description": "Required. The type of this phrase matcher.", "type": "string" }, "activationUpdateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the activation status was updated.", "type": "string", "readOnly": true }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" }, "phraseMatchRuleGroups": { "description": "A list of phase match rule groups that are included in this matcher.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup" } }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the phrase matcher was updated.", "type": "string", "readOnly": true }, "revisionId": { "description": "Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567", "type": "string", "readOnly": true }, "versionTag": { "description": "The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.", "type": "string" }, "active": { "description": "Applies the phrase matcher only when it is active.", "type": "boolean" }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "string" }, "roleMatch": { "description": "The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.", "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" ] } }, "description": "The phrase matcher resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest": { "description": "The request for calculating conversation statistics.", "type": "object", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata": { "description": "Metadata for a create analysis operation.", "type": "object", "properties": { "conversation": { "readOnly": true, "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "annotatorSelector": { "readOnly": true, "description": "Output only. The annotator selector used for the analysis (if any).", "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector" } }, "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata" }, "GoogleCloudContactcenterinsightsV1mainPhraseMatchData": { "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object", "properties": { "phraseMatcher": { "description": "The unique identifier (the resource name) of the phrase matcher.", "type": "string" }, "displayName": { "description": "The human-readable name of the phrase matcher.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainPhraseMatchData" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadata", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "partialErrors": { "description": "Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request for download.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequest" }, "downloadStats": { "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Output only. Statistics for BulkDownloadFeedbackLabels operation.", "readOnly": true } }, "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse", "properties": {}, "description": "The response to undeploy an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse": { "description": "The response from a ListAuthorizedViews request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "authorizedViews": { "description": "The AuthorizedViews under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" } } } }, "GoogleCloudContactcenterinsightsV1RuntimeAnnotation": { "id": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation", "properties": { "smartComposeSuggestion": { "description": "Agent Assist Smart Compose suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData" }, "smartReply": { "description": "Agent Assist Smart Reply data.", "$ref": "GoogleCloudContactcenterinsightsV1SmartReplyData" }, "endBoundary": { "description": "The boundary in the conversation where the annotation ends, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "cesTurnAnnotation": { "description": "The CES turn annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesTurnAnnotation" }, "dialogflowInteraction": { "description": "Dialogflow interaction data.", "$ref": "GoogleCloudContactcenterinsightsV1DialogflowInteractionData" }, "annotationId": { "description": "The unique identifier of the annotation. Format: projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation}", "type": "string" }, "cesEndSessionAnnotation": { "description": "The CES end session annotation.", "$ref": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation" }, "startBoundary": { "description": "The boundary in the conversation where the annotation starts, inclusive.", "$ref": "GoogleCloudContactcenterinsightsV1AnnotationBoundary" }, "userInput": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput", "description": "Explicit input used for generating the answer" }, "conversationSummarizationSuggestion": { "description": "Conversation summarization suggestion data.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData" }, "answerFeedback": { "description": "The feedback that the customer has about the answer in `data`.", "$ref": "GoogleCloudContactcenterinsightsV1AnswerFeedback" }, "faqAnswer": { "description": "Agent Assist FAQ answer data.", "$ref": "GoogleCloudContactcenterinsightsV1FaqAnswerData" }, "articleSuggestion": { "$ref": "GoogleCloudContactcenterinsightsV1ArticleSuggestionData", "description": "Agent Assist Article Suggestion data." }, "createTime": { "description": "The time at which this annotation was created.", "type": "string", "format": "google-datetime" } }, "description": "An annotation that was generated during the customer and agent interaction.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition": { "id": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition", "properties": { "displayName": { "readOnly": true, "description": "Output only. The user-visible name of the metric (e.g., \"Containment Rate\").", "type": "string" }, "sourceId": { "readOnly": true, "description": "Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.", "type": "string" } }, "description": "A definition for a metric to be calculated during analysis.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest", "properties": { "filter": { "description": "Optional. Filter to select conversations to test correlation against. Conversations matching this filter will be sampled based on start time. The most recent `max_sample_count` conversations will be selected. If no conversations match the filter, the request will fail with an `INVALID_ARGUMENT` error.", "type": "string" }, "correlationConfig": { "description": "Required. The correlation config to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "conversations": { "description": "Optional. A list of conversations to test against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations" }, "maxSampleCount": { "format": "int32", "description": "Optional. The maximum number of conversations to sample when using the `filter`. If not set, defaults to 1000. Values greater than 1000 are coerced to 1000. This field is ignored if `conversations` is provided.", "type": "integer" } }, "description": "The request to test correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult": { "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResult", "properties": { "ruleResults": { "description": "The results for each correlation rule.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationResultRuleCorrelationResult" } }, "conversation": { "description": "The conversation resource name.", "type": "string" } }, "description": "The result of testing correlation config on a single conversation.", "type": "object" }, "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" } }, "description": "The request to initialize a location-level encryption specification.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata": { "properties": { "conversationProfileId": { "description": "Optional. The conversation profile ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationProfileDimensionMetadata", "description": "Metadata about the conversation profile dimension.", "type": "object" }, "GoogleIamV1TestIamPermissionsRequest": { "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.", "type": "object" }, "GoogleCloudCesV1mainMessage": { "description": "A message within a conversation.", "type": "object", "id": "GoogleCloudCesV1mainMessage", "properties": { "role": { "description": "Optional. The role within the conversation, e.g., user, agent.", "type": "string" }, "eventTime": { "description": "Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.", "type": "string", "format": "google-datetime" }, "chunks": { "description": "Optional. Content of the message as a series of chunks.", "type": "array", "items": { "$ref": "GoogleCloudCesV1mainChunk" } } } }, "GoogleCloudContactcenterinsightsV1CallAnnotation": { "properties": { "entityMentionData": { "$ref": "GoogleCloudContactcenterinsightsV1EntityMentionData", "description": "Data specifying an entity mention." }, "channelTag": { "description": "The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated.", "type": "integer", "format": "int32" }, "issueMatchData": { "description": "Data specifying an issue match.", "$ref": "GoogleCloudContactcenterinsightsV1IssueMatchData" }, "sentimentData": { "description": "Data specifying sentiment.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "interruptionData": { "description": "Data specifying an interruption.", "$ref": "GoogleCloudContactcenterinsightsV1InterruptionData" }, "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": { "$ref": "GoogleCloudContactcenterinsightsV1SilenceData", "description": "Data specifying silence." }, "holdData": { "$ref": "GoogleCloudContactcenterinsightsV1HoldData", "description": "Data specifying a hold." }, "intentMatchData": { "description": "Data specifying an intent match.", "$ref": "GoogleCloudContactcenterinsightsV1IntentMatchData" }, "phraseMatchData": { "$ref": "GoogleCloudContactcenterinsightsV1PhraseMatchData", "description": "Data specifying a phrase match." } }, "id": "GoogleCloudContactcenterinsightsV1CallAnnotation", "description": "A piece of metadata that applies to a window of a call.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint", "properties": { "conversationMeasure": { "description": "The measure related to conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure" }, "interval": { "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request).", "$ref": "GoogleTypeInterval" }, "dialogflowInteractionMeasure": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions." } }, "description": "A data point contains the metric values mapped to an interval.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSlice": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "type": "object", "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": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "properties": { "trainingConversationsCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of conversations used in training. Output only.", "type": "string" }, "filter": { "description": "A filter to reduce the conversations used for training the model to a specific subset. Refer to https://cloud.google.com/contact-center/insights/docs/filtering for details.", "type": "string" }, "medium": { "description": "Medium of conversations used in training data. This field is being deprecated. To specify the medium to be used in training a new issue model, set the `medium` field on `filter`.", "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "deprecated": true, "type": "string", "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ] } }, "description": "Configs for the input data used to create the issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata", "properties": { "totalRequestedAnalysesCount": { "description": "Total number of analyses requested. Computed by the number of conversations returned by `filter` multiplied by `analysis_percentage` in the request.", "type": "integer", "format": "int32" }, "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest", "description": "The original request for bulk analyze." }, "completedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have completed successfully so far.", "type": "integer" }, "partialErrors": { "description": "Output only. Partial errors during bulk analyze operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "failedAnalysesCount": { "format": "int32", "description": "The number of requested analyses that have failed so far.", "type": "integer" }, "relabel": { "readOnly": true, "description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "The original request for deployment.", "$ref": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelRequest" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData", "properties": { "metadata": { "additionalProperties": { "type": "string" }, "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object" }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "suggestion": { "description": "The content of the suggestion.", "type": "string" }, "confidenceScore": { "format": "double", "description": "The system's confidence score that this suggestion is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } }, "description": "Agent Assist Smart Compose suggestion data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult": { "description": "The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult", "properties": { "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult" } }, "conversation": { "description": "The conversation scored by this result.", "type": "string" }, "agentId": { "description": "ID of the agent that handled the conversation.", "type": "string" }, "qaAnswers": { "description": "Set of QaAnswers represented in the result.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer" } }, "createTime": { "readOnly": true, "description": "Output only. The timestamp that the revision was created.", "type": "string", "format": "google-datetime" }, "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist.", "type": "number", "format": "double" }, "score": { "format": "double", "description": "The overall numerical score of the result, incorporating any manual edits if they exist.", "type": "number" }, "qaScorecardRevision": { "description": "The QaScorecardRevision scored by this result.", "type": "string" }, "scoreSources": { "description": "List of all individual score sets.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource" } }, "name": { "description": "Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result}", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainDeployIssueModelResponse", "description": "The response to deploy an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Chart": { "description": "Configurable dashboard's widget that displays data as a chart.", "type": "object", "properties": { "description": { "description": "Chart description", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Chart create time.", "type": "string" }, "width": { "description": "The width of the chart in grid units.", "type": "integer", "format": "int32" }, "displayName": { "description": "User provided display name of the chart.", "type": "string" }, "chartVisualizationType": { "enumDescriptions": [ "Unspecified chart visualization type.", "Bar chart.", "Line chart.", "Area chart.", "Pie chart.", "Scatter chart.", "Table chart.", "Score card chart.", "Sunburst chart.", "Gauge chart.", "Sankey chart." ], "enum": [ "CHART_VISUALIZATION_TYPE_UNSPECIFIED", "BAR", "LINE", "AREA", "PIE", "SCATTER", "TABLE", "SCORE_CARD", "SUNBURST", "GAUGE", "SANKEY" ], "description": "Chart visualization type.", "type": "string" }, "dateRangeConfig": { "description": "Date range config applied to the chart.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig" }, "action": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartAction", "description": "Optional action to be taken when the chart is clicked." }, "chartType": { "enum": [ "CHART_TYPE_UNSPECIFIED", "SYSTEM_DEFINED", "USER_DEFINED" ], "readOnly": true, "description": "Output only. Chart type.", "enumDescriptions": [ "Unspecified chart type.", "Pre-defined chart type.", "Configurable chart type." ], "type": "string" }, "filter": { "description": "Filter applied to all charts in the container. Should support scope later.", "type": "string" }, "height": { "format": "int32", "description": "The height of the chart in grid units.", "type": "integer" }, "name": { "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Chart last update time.", "type": "string", "format": "google-datetime" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ChartDataSource" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { "description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", "type": "object", "properties": { "p99": { "description": "The 99th percentile value.", "type": "number", "format": "double" }, "p50": { "format": "double", "description": "The 50th percentile value.", "type": "number" }, "p90": { "format": "double", "description": "The 90th percentile value.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult" }, "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse": { "description": "The response of listing assessment rules.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse", "properties": { "assessmentRules": { "description": "The assessment rules that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" } }, "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" } } }, "GoogleCloudContactcenterinsightsV1AnalysisResult": { "description": "The result of an analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1AnalysisResult", "properties": { "callAnalysisMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created by the analysis." }, "endTime": { "description": "The time at which the analysis ended.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource": { "description": "A scorecard result may have multiple sets of scores from varying sources, one of which becomes the \"main\" answer above. A ScoreSource represents each individual set of scores.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource", "properties": { "potentialScore": { "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number", "format": "double" }, "normalizedScore": { "description": "The normalized score, which is the score divided by the potential score.", "type": "number", "format": "double" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult" } }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "type": "string" }, "score": { "description": "The overall numerical score of the result.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1SpeechConfig": { "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "type": "object", "properties": { "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" } }, "id": "GoogleCloudContactcenterinsightsV1SpeechConfig" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1mainExportIssueModelRequest", "description": "The original export request." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "description": "Metadata used for export issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage": { "properties": { "chartSpec": { "description": "Chart spec from LLM", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "description": "Optional. User provided chart spec", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessageSystemMessage", "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "type": "object" }, "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" } } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript": { "description": "The conversation transcript for the chart.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. The update time of the conversation.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The create time of the conversation.", "type": "string", "format": "google-datetime", "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": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscriptMessage" } } } }, "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest": { "description": "Request for TuneQaScorecardRevision endpoint.", "type": "object", "properties": { "filter": { "description": "Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc.", "type": "string" }, "validateOnly": { "description": "Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo": { "properties": { "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "type": "string" }, "location": { "description": "The agent's location.", "type": "string" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "deploymentDisplayName": { "description": "The agent's deployment display name. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "entrySubagentId": { "description": "The entry subagent's ID.", "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" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "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" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo", "description": "Information about an agent involved in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata": { "properties": { "annotations": { "description": "A list of call annotations that apply to this call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation" } }, "sentiments": { "description": "Overall conversation-level sentiment for each channel of the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment" } }, "issueModelResult": { "description": "Overall conversation-level issue modeling result.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelResult" }, "entities": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Entity" }, "description": "All the entities in the call.", "type": "object" }, "intents": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Intent" }, "description": "All the matched intents in the call.", "type": "object" }, "silence": { "description": "Overall conversation-level silence during the call.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence" }, "phraseMatchers": { "description": "All the matched phrase matchers in the call.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData" } }, "qaScorecardResults": { "description": "Results of scoring QaScorecards.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created during analysis.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata": { "description": "The metadata for generative insights.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightsMetadata", "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "properties": { "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "completedExportCount": { "format": "int32", "description": "The number of conversations that were exported successfully.", "type": "integer" }, "failedExportCount": { "description": "The number of conversations that failed to be exported.", "type": "integer", "format": "int32" }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "description": "The original request for export." }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "Metadata for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1InterruptionData" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue": { "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "properties": { "skipValue": { "description": "Output only. A value of \"Skip\". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.", "type": "boolean", "readOnly": true }, "naValue": { "description": "A value of \"Not Applicable (N/A)\". Should only ever be `true`.", "type": "boolean" }, "boolValue": { "description": "Boolean value.", "type": "boolean" }, "numValue": { "format": "double", "description": "Numerical value.", "type": "number" }, "potentialScore": { "format": "double", "description": "Output only. The maximum potential score of the question.", "type": "number", "readOnly": true }, "normalizedScore": { "description": "Output only. Normalized score of the questions. Calculated as score / potential_score.", "type": "number", "format": "double", "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" }, "score": { "format": "double", "description": "Output only. Numerical score of the answer.", "type": "number", "readOnly": true } }, "description": "Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDataset": { "id": "GoogleCloudContactcenterinsightsV1mainDataset", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. Dataset update time.", "type": "string", "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" ], "description": "Dataset usage type.", "type": "string" }, "ttl": { "format": "google-duration", "description": "Optional. Option TTL for the dataset.", "type": "string" }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" } }, "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse": { "description": "The response from a GenerateConversationSignedAudio request.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse", "properties": { "signedAudioUris": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SignedAudioUris", "description": "The signed uris for the audio." } } }, "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote": { "properties": { "turnIndex": { "format": "int32", "description": "The conversation turn index that the note is associated with.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1NoteConversationTurnNote", "description": "A note about a conversation turn.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse": { "description": "The response from a ListQaQuestionTags request.", "type": "object", "properties": { "qaQuestionTags": { "description": "The parent resource of the questions.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse" }, "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult": { "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "The error status if the constraint expression failed to evaluate." }, "ruleId": { "description": "The rule ID.", "type": "string" }, "constraintMet": { "description": "Whether the constraint expression evaluated to true for (A, B) or (B, A).", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainConstraintEvaluationResultRuleConstraintResult", "description": "The result of a single constraint rule on the pair of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse": { "description": "The response for generative insights.", "type": "object", "properties": { "generativeResponses": { "description": "The full list of generative responses. Each response is ordered by time.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponseGenerativeResponse" } }, "transcript": { "$ref": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightConversationTranscript", "description": "The transcript of the generative insights conversation." } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsResponse" }, "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse": { "description": "The response to undeploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainUndeployIssueModelResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1mainAnalysis": { "id": "GoogleCloudContactcenterinsightsV1mainAnalysis", "properties": { "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "analysisResult": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnalysisResult", "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true }, "requestTime": { "description": "Output only. The time at which the analysis was requested.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string" }, "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." } }, "description": "The analysis resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1HoldData": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1HoldData", "description": "The data for a hold annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1HoldData": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1HoldData", "description": "The data for a hold annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource": { "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultScoreSource", "properties": { "potentialScore": { "format": "double", "description": "The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation.", "type": "number" }, "normalizedScore": { "format": "double", "description": "The normalized score, which is the score divided by the potential score.", "type": "number" }, "qaTagResults": { "description": "Collection of tags and their scores.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult" } }, "sourceType": { "enumDescriptions": [ "Source type is unspecified.", "Score is derived only from system-generated answers.", "Score is derived from both system-generated answers, and includes any manual edits if they exist." ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SYSTEM_GENERATED_ONLY", "INCLUDES_MANUAL_EDITS" ], "description": "What created the score.", "type": "string" }, "score": { "description": "The overall numerical score of the result.", "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "properties": { "dataPoints": { "description": "The data points that make up the time series .", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint" } } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values.", "type": "object" }, "GoogleCloudContactcenterinsightsV1CreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "properties": { "parent": { "description": "Required. The parent resource of the issue.", "type": "string" }, "issue": { "description": "Required. The values for the new issue.", "$ref": "GoogleCloudContactcenterinsightsV1Issue" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueRequest" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata": { "description": "Metadata for testing correlation config.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadata", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats" } } }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "properties": { "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" }, "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" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } }, "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" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "normalizedScore": { "format": "double", "description": "The normalized score the tag applies to.", "type": "number" }, "potentialScore": { "description": "The potential score the tag applies to.", "type": "number", "format": "double" } } }, "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats": { "properties": { "processedObjectCount": { "description": "Output only. The number of objects processed during the ingest operation.", "type": "integer", "format": "int32", "readOnly": true }, "successfulIngestCount": { "readOnly": true, "description": "Output only. The number of new conversations added during this ingest operation.", "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.", "type": "integer", "format": "int32", "readOnly": true }, "duplicatesSkippedCount": { "readOnly": true, "description": "Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudContactcenterinsightsV1mainIngestConversationsMetadataIngestConversationsStats", "description": "Statistics for IngestConversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Dashboard": { "description": "Configurable dashboard", "type": "object", "properties": { "filter": { "description": "Filter applied to all charts in the dashboard. Should support scope later.", "type": "string" }, "rootContainer": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Container", "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." }, "readOnly": { "readOnly": true, "description": "Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.", "type": "boolean" }, "displayName": { "description": "User provided display name of the dashboard.", "type": "string" }, "dateRangeConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range config applied to all charts in the dashboard." }, "updateTime": { "format": "google-datetime", "description": "Output only. Dashboard last update time.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. Dashboard creation time.", "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}", "type": "string" }, "description": { "description": "Dashboard description", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults": { "description": "Wrapper for detailed, step-by-step results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigResponseDetailedCorrelationResults", "properties": { "joinKeyResults": { "description": "A list of join key correlation results for each conversation tested.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationResult" } }, "constraintResults": { "description": "A list of constraint evaluation results for each pair of conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConstraintEvaluationResult" } } } }, "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" } }, "id": "GoogleCloudCesV1mainToolsetTool", "description": "A tool that is created from a toolset.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo": { "description": "Message for schedule info.", "type": "object", "properties": { "endTime": { "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.", "type": "string" }, "timeZone": { "description": "The timezone to use for the groc expression. If not specified, defaults to UTC.", "type": "string" }, "startTime": { "description": "Start time of the schedule. If not specified, will start as soon as the schedule is created.", "type": "string", "format": "google-datetime" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ScheduleInfo" }, "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { "description": "The request to initialize a location-level encryption specification.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", "properties": { "encryptionSpec": { "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec", "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." } } }, "GoogleCloudContactcenterinsightsV1ConversationLevelSilence": { "description": "Conversation-level silence data.", "type": "object", "properties": { "silenceDuration": { "description": "Amount of time calculated to be in silence.", "type": "string", "format": "google-duration" }, "silencePercentage": { "format": "float", "description": "Percentage of the total conversation spent in silence.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSilence" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest", "description": "The original export request." }, "endTime": { "description": "The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata", "description": "Metadata used for export issue model.", "type": "object" }, "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": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", "description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse", "description": "The response for querying metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaAnswer": { "properties": { "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" } }, "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": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue" }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer", "description": "An answer to a QaQuestion.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata": { "properties": { "errorMessages": { "description": "The error message when the generative insights request fails.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainGenerativeInsightsMetadata", "description": "The metadata for generative insights.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "properties": { "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "runAutoLabelingAnnotator": { "description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", "type": "boolean" }, "phraseMatchers": { "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array", "items": { "type": "string" } }, "runSummarizationAnnotator": { "description": "Whether to run the summarization 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" }, "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" } }, "qaConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig", "description": "Configuration for the QA annotator." }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "summarizationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "description": "Configuration for the summarization annotator." }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector" }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" }, "updateMask": { "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "type": "string" } }, "id": "GoogleIamV1SetIamPolicyRequest" }, "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata": { "description": "The metadata from querying metrics.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsMetadata", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination": { "description": "Google Cloud Storage Object details to write the feedback labels to.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsRequestGcsDestination", "properties": { "alwaysPrintEmptyFields": { "description": "Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.", "type": "boolean" }, "recordsPerFileCount": { "format": "int64", "description": "Optional. The number of records per file. Applicable for either format.", "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" ] }, "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" } } }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage": { "description": "A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessage", "properties": { "textMessage": { "description": "A direct natural language response to the user message.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput" }, "chartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Chart spec from LLM", "type": "object" }, "generatedSqlQuery": { "description": "Raw SQL from LLM, before templatization", "type": "string" }, "userProvidedSqlQuery": { "description": "Optional. User provided SQL query", "type": "string" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. User provided chart spec", "type": "object" } } }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices: * Slice 1 -\u003e dimensions=[Issue 1] * Slice 2 -\u003e dimensions=[Issue 2]", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", "properties": { "timeSeries": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", "description": "A time series of metric values. This is only populated if the request specifies a time granularity other than NONE." }, "total": { "description": "The total metric value. The interval of this data point is [starting create time, ending create time) from the request.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint" }, "dimensions": { "description": "A unique combination of dimensions that this slice represents.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1Dimension" } } } }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule": { "description": "The data for a phrase match rule.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule", "properties": { "query": { "description": "Required. The phrase to be matched.", "type": "string" }, "negated": { "description": "Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.", "type": "boolean" }, "config": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig", "description": "Provides additional information about the rule that specifies how to apply the rule." } } }, "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata": { "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "description": "The original request for creation." } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata", "description": "Metadata for creating an issue model.", "type": "object" }, "GoogleIamV1Binding": { "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "GoogleTypeExpr" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "id": "GoogleIamV1Binding" }, "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio": { "description": "A wrapper for holding the audio for any given turn.", "type": "object", "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "format": "google-duration", "description": "The duration of the audio.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationDataSourceTurnLevelAudio" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput": { "properties": { "text": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } }, "textType": { "enumDescriptions": [ "The default text type.", "The text is a thinking plan generated by the thinking tool.", "The text is a final response to the user question.", "The text is an informational message about the agent's progress, such as a tool being invoked. This is distinct from the agent's internal thought process (`THOUGHT`) and the final answer to the user (`FINAL_RESPONSE`). These messages provide insight into the agent's actions." ], "enum": [ "TYPE_UNSPECIFIED", "THOUGHT", "FINAL_RESPONSE", "PROGRESS" ], "description": "The type of the text message.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessageTextOutput", "description": "A text output message from the system.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { "description": "The metadata for an SampleConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", "properties": { "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "Output only. The original request for sample conversations to dataset.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", "readOnly": true }, "sampleConversationsStats": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", "description": "Output only. Statistics for SampleConversations operation.", "readOnly": true }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1IssueModelLabelStats": { "description": "Aggregated statistics about an issue model.", "type": "object", "properties": { "analyzedConversationsCount": { "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string" }, "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object" }, "unclassifiedConversationsCount": { "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats" }, "GoogleCloudContactcenterinsightsV1mainSpeechConfig": { "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.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata": { "description": "Call-specific metadata.", "type": "object", "properties": { "customerChannel": { "format": "int32", "description": "The audio channel that contains the customer.", "type": "integer" }, "agentChannel": { "format": "int32", "description": "The audio channel that contains the agent.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata" }, "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData": { "id": "GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData", "properties": { "metadata": { "description": "Map that contains metadata about the Smart Compose suggestion and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "queryRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "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" } }, "description": "Agent Assist Smart Compose suggestion data.", "type": "object" }, "GoogleCloudCesV1mainToolCall": { "id": "GoogleCloudCesV1mainToolCall", "properties": { "toolsetTool": { "$ref": "GoogleCloudCesV1mainToolsetTool", "description": "Optional. The toolset tool to execute." }, "displayName": { "description": "Output only. Display name of the tool.", "type": "string", "readOnly": true }, "id": { "description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.", "type": "string" }, "args": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The input parameters and values for the tool in JSON object format.", "type": "object" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" } }, "description": "Request for the client or the agent to execute the specified tool.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata": { "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "stats": { "description": "The statistics for the operation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadataFullConversationCorrelationStats" }, "dataset": { "description": "The dataset used for sampling conversations.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigMetadata", "description": "Metadata for testing correlation config.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult": { "description": "The result of an analysis.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResult", "properties": { "callAnalysisMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata", "description": "Call-specific metadata created by the analysis." }, "endTime": { "description": "The time at which the analysis ended.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModel": { "properties": { "inputDataConfig": { "description": "Configs for the input data that used to create the issue model.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "languageCode": { "description": "Language of the model.", "type": "string" }, "createTime": { "description": "Output only. The time at which this issue model was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the issue model was updated.", "type": "string", "readOnly": true }, "issueCount": { "description": "Output only. Number of issues in this issue model.", "type": "string", "format": "int64", "readOnly": true }, "state": { "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "description": "Output only. State of the model." }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "trainingStats": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "description": "Output only. Immutable. The issue model's label statistics on its training data.", "readOnly": true }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "description": "The issue model resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo": { "description": "Word-level info for words in a transcript.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo", "properties": { "startOffset": { "format": "google-duration", "description": "Time offset of the start of this word relative to the beginning of the total conversation.", "type": "string" }, "word": { "description": "The word itself. Includes punctuation marks that surround the word.", "type": "string" }, "confidence": { "description": "A confidence estimate between 0.0 and 1.0 of the fidelity of this word. A default value of 0.0 indicates that the value is unset.", "type": "number", "format": "float" }, "endOffset": { "format": "google-duration", "description": "Time offset of the end of this word relative to the beginning of the total conversation.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata": { "description": "The metadata from querying metrics.", "type": "object", "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule": { "description": "Rule for auto-labeling conversations.", "type": "object", "properties": { "displayName": { "description": "The user-provided display name of the rule.", "type": "string" }, "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" } }, "labelKeyType": { "enumDescriptions": [ "Unspecified label key type.", "The label key is custom defined by the user." ], "enum": [ "LABEL_KEY_TYPE_UNSPECIFIED", "LABEL_KEY_TYPE_CUSTOM" ], "description": "The type of the label key.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the rule was updated.", "type": "string", "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" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this rule was created.", "type": "string" }, "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "type": "string" }, "description": { "description": "The description of the rule.", "type": "string" }, "active": { "description": "Whether the rule is active.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "GoogleCloudContactcenterinsightsV1mainIssueAssignment": { "description": "Information about the issue.", "type": "object", "properties": { "issue": { "description": "Resource name of the assigned issue.", "type": "string" }, "score": { "format": "double", "description": "Score indicating the likelihood of the issue assignment. currently bounded on [0,1].", "type": "number" }, "displayName": { "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueAssignment" }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector": { "description": "Selector of all available annotators and phrase matchers to run.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "properties": { "runAutoLabelingAnnotator": { "description": "Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.", "type": "boolean" }, "runIntentAnnotator": { "description": "Whether to run the intent annotator.", "type": "boolean" }, "phraseMatchers": { "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "type": "array", "items": { "type": "string" } }, "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" }, "runSentimentAnnotator": { "description": "Whether to run the sentiment annotator.", "type": "boolean" }, "qaConfig": { "description": "Configuration for the QA annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "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" } }, "runSilenceAnnotator": { "description": "Whether to run the silence annotator.", "type": "boolean" }, "runPhraseMatcherAnnotator": { "description": "Whether to run the active phrase matcher annotator(s).", "type": "boolean" }, "summarizationConfig": { "description": "Configuration for the summarization annotator.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorSummarizationConfig" }, "runQaAnnotator": { "description": "Whether to run the QA annotator.", "type": "boolean" }, "runInterruptionAnnotator": { "description": "Whether to run the interruption annotator.", "type": "boolean" }, "runEntityAnnotator": { "description": "Whether to run the entity annotator.", "type": "boolean" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata": { "properties": { "smartReplyAllowlistCovered": { "description": "Whether the transcript segment was covered under the configured smart reply allowlist in Agent Assist.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata", "description": "Metadata from Dialogflow relating to the current transcript segment.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats": { "id": "GoogleCloudContactcenterinsightsV1mainIssueModelLabelStatsIssueStats", "properties": { "issue": { "description": "Issue resource. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "type": "string" }, "displayName": { "description": "Display name of the issue.", "type": "string" }, "labeledConversationsCount": { "description": "Number of conversations attached to the issue at this point in time.", "type": "string", "format": "int64" } }, "description": "Aggregated statistics about an issue.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "description": "The measure related to dialogflow interactions.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "properties": { "percentileAudioInAudioOutLatency": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level." }, "percentileLlmCallLatency": { "description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileTtsLatency": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." }, "percentileToolUseLatency": { "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult" }, "percentileEndToEndLatency": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessageSystemMessageTextOutput", "properties": { "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" ], "description": "The type of the text message.", "type": "string" }, "texts": { "description": "The parts of the message.", "type": "array", "items": { "type": "string" } } }, "description": "A text output message from the system.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse": { "description": "The response to deploy an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1RedirectAction": { "description": "The redirect action to be taken when the chart is clicked.", "type": "object", "properties": { "relativePath": { "description": "The relative path to redirect to.", "type": "string" }, "queryParams": { "description": "The query params to be added to the redirect path.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1RedirectAction" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest": { "description": "The request to export insights.", "type": "object", "properties": { "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "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" }, "bigQueryDestination": { "description": "Specified if sink is a BigQuery table.", "$ref": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination" }, "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "writeDisposition": { "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ], "description": "Options for what to do if the destination table already exists.", "type": "string" }, "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" ] } }, "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequest" }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "description": "The data for a sentiment annotation.", "type": "object", "properties": { "magnitude": { "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "type": "number", "format": "float" }, "score": { "format": "float", "description": "The sentiment score between -1.0 (negative) and 1.0 (positive).", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata": { "description": "Metadata for creating an issue.", "type": "object", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig": { "description": "DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1UserInfo": { "properties": { "username": { "description": "The user's username.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UserInfo", "description": "Information about a user.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata": { "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" }, "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" }, "agentDeploymentId": { "description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentDisplayName": { "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentVersionDisplayName": { "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension.", "type": "object" }, "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" } } }, "id": "GoogleCloudContactcenterinsightsV1mainIssueModelResult", "description": "Issue Modeling result on a conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig": { "properties": { "relativeDateRange": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfigRelativeDateRange", "description": "A relative date range." }, "absoluteDateRange": { "description": "An absolute date range.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryInterval" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1DateRangeConfig", "description": "Date range configuration for dashboard charts.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest": { "description": "Request to export an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to export.", "type": "string" }, "gcsDestination": { "$ref": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination", "description": "Google Cloud Storage URI to export the issue model to." } }, "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1Analysis": { "id": "GoogleCloudContactcenterinsightsV1Analysis", "properties": { "requestTime": { "description": "Output only. The time at which the analysis was requested.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "type": "string", "format": "google-datetime", "readOnly": true }, "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" }, "name": { "description": "Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}", "type": "string" }, "analysisResult": { "$ref": "GoogleCloudContactcenterinsightsV1AnalysisResult", "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true } }, "description": "The analysis resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainQaScorecardResultQaTagResult", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" }, "score": { "description": "The score the tag applies to.", "type": "number", "format": "double" }, "normalizedScore": { "format": "double", "description": "The normalized score the tag applies to.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1Conversation": { "id": "GoogleCloudContactcenterinsightsV1Conversation", "properties": { "createTime": { "description": "Output only. The time at which the conversation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "latestAnalysis": { "readOnly": true, "description": "Output only. The conversation's latest analysis, if one exists.", "$ref": "GoogleCloudContactcenterinsightsV1Analysis" }, "startTime": { "description": "The time at which the conversation started.", "type": "string", "format": "google-datetime" }, "turnCount": { "description": "Output only. The number of turns in the conversation.", "type": "integer", "format": "int32", "readOnly": true }, "duration": { "readOnly": true, "format": "google-duration", "description": "Output only. The duration of the conversation.", "type": "string" }, "latestSummary": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData", "description": "Output only. Latest summary of the conversation." }, "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" }, "labels": { "description": "A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.", "type": "object", "additionalProperties": { "type": "string" } }, "medium": { "enumDescriptions": [ "Default value for unspecified.", "The format for conversations that took place over the phone.", "The format for conversations that took place over chat." ], "enum": [ "MEDIUM_UNSPECIFIED", "PHONE_CALL", "CHAT" ], "description": "Immutable. The conversation medium.", "type": "string" }, "agentId": { "description": "An opaque, user-specified string representing the human agent who handled the conversation.", "type": "string" }, "languageCode": { "description": "A user-specified language code for the conversation.", "type": "string" }, "runtimeAnnotations": { "description": "Output only. The annotations that were generated during the customer and agent interaction.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1RuntimeAnnotation" }, "readOnly": true }, "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}", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1DialogflowIntent" }, "readOnly": true }, "callMetadata": { "description": "Call-specific metadata.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationCallMetadata" }, "updateTime": { "description": "Output only. The most recent time at which the conversation was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "ttl": { "format": "google-duration", "description": "Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.", "type": "string" }, "transcript": { "readOnly": true, "description": "Output only. The conversation transcript.", "$ref": "GoogleCloudContactcenterinsightsV1ConversationTranscript" }, "correlationInfo": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "description": "Output only. Info for correlating across conversations.", "readOnly": true }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "qualityMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadata", "description": "Conversation metadata related to quality management." }, "expireTime": { "format": "google-datetime", "description": "The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.", "type": "string" }, "obfuscatedUserId": { "description": "Obfuscated user ID which the customer sent to us.", "type": "string" }, "dataSource": { "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSource", "description": "The source of the audio and transcription for the conversation." } }, "description": "The conversation resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true }, "sampledConversations": { "readOnly": true, "description": "Output only. Stores the conversation resources produced by ingest sampling operations.", "type": "array", "items": { "type": "string" } }, "ingestConversationsStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats", "description": "Output only. Statistics for IngestConversations operation." }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request for ingest.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest" }, "partialErrors": { "readOnly": true, "description": "Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { "properties": { "percentileEndToEndLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." }, "percentileAudioInAudioOutLatency": { "description": "The percentile result for audio in audio out 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" }, "percentileTtsLatency": { "description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level.", "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult" }, "percentileToolUseLatency": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", "description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", "description": "The measure related to dialogflow interactions.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig", "properties": { "type": { "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent." ], "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" ], "description": "The type of the predefined question.", "type": "string" } }, "description": "Configuration for a predefined question. This field will only be set if the Question Type is predefined.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleConfig": { "description": "Configuration information of a phrase match rule.", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule": { "id": "GoogleCloudContactcenterinsightsV1alpha1CorrelationRule", "properties": { "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" }, "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" }, "ruleId": { "description": "Required. The unique identifier of the rule.", "type": "string" }, "active": { "description": "Optional. Whether the config is active to be evaluated.", "type": "boolean" } }, "description": "A correlation rule that defines how to join conversations for a given correlation type.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IssueModelResult": { "description": "Issue Modeling result on a conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModelResult", "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": "GoogleCloudContactcenterinsightsV1IssueAssignment" } } } }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsMetadata", "properties": { "request": { "readOnly": true, "description": "Output only. The original request for delete.", "$ref": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsRequest" }, "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainExportIssueModelResponse", "description": "Response from export issue model", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse", "properties": { "summaryText": { "description": "The summary text of the performance.", "type": "string" } }, "description": "The response for querying performance overview.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest": { "description": "The request to delete conversations in bulk.", "type": "object", "properties": { "filter": { "description": "Filter used to select the subset of conversations to delete.", "type": "string" }, "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" }, "maxDeleteCount": { "description": "Maximum number of conversations to delete.", "type": "integer", "format": "int32" }, "force": { "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata": { "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadata", "properties": { "waitDuration": { "format": "google-duration", "description": "The amount of time the customer waited to connect with an agent.", "type": "string" }, "agentInfo": { "description": "Information about agents involved in the call.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo" } }, "feedbackLabels": { "description": "Input only. The feedback labels associated with the conversation.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } }, "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" } }, "description": "Conversation metadata related to quality management.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsDiagnosticMetricConfig", "properties": { "metrics": { "description": "Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., \"containment\").", "type": "object", "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1MetricDefinition" } } }, "description": "Configuration for diagnostic metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup": { "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRuleGroup", "properties": { "phraseMatchRules": { "description": "A list of phrase match rules that are included in this group.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchRule" } }, "type": { "enumDescriptions": [ "Unspecified.", "Must meet all phrase match rules or there is no match.", "If any of the phrase match rules are met, there is a match." ], "enum": [ "PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED", "ALL_OF", "ANY_OF" ], "description": "Required. The type of this phrase match rule group.", "type": "string" } }, "description": "A message representing a rule in the phrase matcher.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult": { "description": "Tags and their corresponding results.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult", "properties": { "tag": { "description": "The tag the score applies to.", "type": "string" }, "score": { "format": "double", "description": "The score the tag applies to.", "type": "number" }, "normalizedScore": { "description": "The normalized score the tag applies to.", "type": "number", "format": "double" }, "potentialScore": { "format": "double", "description": "The potential score the tag applies to.", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata": { "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "annotatorSelector": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelector", "description": "Output only. The annotator selector used for the analysis (if any)." }, "conversation": { "readOnly": true, "description": "Output only. The Conversation that this Analysis Operation belongs to.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateAnalysisOperationMetadata", "description": "Metadata for a create analysis operation.", "type": "object" }, "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).", "type": "integer", "format": "int32" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "GoogleIamV1AuditConfig" } }, "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string" }, "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" } } } }, "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse": { "description": "The response to initialize a location-level encryption specification.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainInitializeEncryptionSpecResponse" }, "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule": { "description": "The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that match the filter defined in the rule. For a conversation matches the filter, the annotators specified in the rule will be run. If a conversation matches multiple rules, a union of all the annotators will be run. One project can have multiple analysis rules.", "type": "object", "properties": { "active": { "description": "If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.", "type": "boolean" }, "name": { "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, "displayName": { "description": "Display Name of the analysis rule.", "type": "string" }, "analysisPercentage": { "format": "double", "description": "Percentage of conversations that we should apply this analysis setting automatically, between [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The original runtime_percentage & upload percentage will be replaced by defining filters on the conversation.", "type": "number" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which this analysis rule was updated.", "type": "string", "readOnly": true }, "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": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter. If not specified, NO annotators will be run." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which this analysis rule was created.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource": { "description": "Google Cloud Storage Object URI to get the issue model file from.", "type": "object", "properties": { "objectUri": { "description": "Required. Format: `gs:///`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainImportIssueModelRequestGcsSource" }, "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest": { "description": "The message to publish an assessment. Draft and appealed assessments can be published. Publishing simply changes the state of the assessment to published, allowing the console and authorized views to filter on the state.", "type": "object", "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest": { "description": "The request to create an issue.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats": { "id": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats", "properties": { "analyzedConversationsCount": { "format": "int64", "description": "Number of conversations the issue model has analyzed at this point in time.", "type": "string" }, "issueStats": { "additionalProperties": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats" }, "description": "Statistics on each issue. Key is the issue's resource name.", "type": "object" }, "unclassifiedConversationsCount": { "format": "int64", "description": "Number of analyzed conversations for which no issue was applicable at this point in time.", "type": "string" } }, "description": "Aggregated statistics about an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata": { "description": "Metadata about the QA question dimension.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" }, "qaQuestionId": { "description": "Optional. The QA question ID.", "type": "string" }, "questionBody": { "description": "Optional. The full body of the question.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo": { "description": "Info for correlating across conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo", "properties": { "mergedFullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string" }, "correlationTypes": { "readOnly": true, "description": "Output only. The correlation types of this conversation. A single conversation can have multiple correlation types. For example a conversation that only has a single segment is both a SEGMENT and a FULL_CONVERSATION.", "type": "array", "items": { "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ], "type": "string" } }, "fullConversationCorrelationId": { "readOnly": true, "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1mainSampleRule": { "description": "Message for sampling conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainSampleRule", "properties": { "sampleRow": { "description": "Number of the conversations that we should sample based on the dimension.", "type": "string", "format": "int64" }, "samplePercentage": { "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", "type": "number", "format": "double" }, "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1SettingsAnalysisConfig", "properties": { "annotatorSelector": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." }, "runtimeIntegrationAnalysisPercentage": { "format": "double", "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "type": "number" }, "uploadConversationAnalysisPercentage": { "description": "Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].", "type": "number", "format": "double" } }, "description": "Default configuration when creating Analyses in Insights.", "type": "object" }, "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" } } }, "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata": { "properties": { "resultIsTruncated": { "description": "Whether the result rows were truncated because the result row size is too large to materialize.", "type": "boolean" } }, "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsMetadata", "description": "The metadata from querying metrics.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" }, "id": { "description": "The unique identifier of the intent.", "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest": { "description": "The request to undeploy an issue model.", "type": "object", "properties": { "name": { "description": "Required. The issue model to undeploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" }, "GoogleCloudContactcenterinsightsV1alpha1Assessment": { "description": "The assessment resource.", "type": "object", "properties": { "agentInfo": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo", "description": "Information about the agent the assessment is for." }, "createTime": { "description": "Output only. The time at which the assessment was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. The time at which the assessment was last updated.", "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The state of the assessment.", "enum": [ "STATE_UNSPECIFIED", "DRAFT", "PUBLISHED", "APPEALED", "FINALIZED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified. This value should not be used.", "The default state of all new assessments.", "The assessment has been published.", "The assessment has been appealed.", "The assessment has been finalized." ] }, "name": { "description": "Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo", "properties": { "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" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "type": "string" }, "agentType": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string" }, "dispositionCode": { "description": "A user-provided string indicating the outcome of the agent's segment of the call.", "type": "string" }, "entrySubagentDisplayName": { "description": "The entry subagent's display name.", "type": "string" }, "agentId": { "description": "A user-specified string representing the agent.", "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" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" } }, "description": "Information about an agent involved in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1Dimension": { "id": "GoogleCloudContactcenterinsightsV1alpha1Dimension", "properties": { "mediumDimensionMetadata": { "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", "readOnly": true }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata" }, "agentDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension." }, "issueDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, "labelDimensionMetadata": { "description": "Output only. Metadata about conversation labels.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionLabelDimensionMetadata", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "description": "Output only. Metadata about the client sentiment category dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", "readOnly": true }, "qaQuestionDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata" }, "qaScorecardDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", "description": "Output only. Metadata about the QA scorecard dimension." }, "dimensionKey": { "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "description": "The key of the dimension.", "type": "string" }, "conversationProfileDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", "description": "Output only. Metadata about the conversation profile dimension." }, "conversationalAgentsToolDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension." }, "qaQuestionAnswerDimensionMetadata": { "description": "Output only. Metadata about the QA question-answer dimension.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "readOnly": true } }, "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" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary": { "properties": { "transcriptIndex": { "format": "int32", "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer" }, "wordIndex": { "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "analysisRules": { "description": "The analysis_rule that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } } }, "description": "The response of listing views.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats": { "properties": { "totalFilesWritten": { "format": "int32", "description": "Total number of files written to the provided Cloud Storage bucket.", "type": "integer" }, "fileNames": { "description": "Output only. Full name of the files written to Cloud storage.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "successfulDownloadCount": { "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", "type": "integer", "format": "int32" }, "processedObjectCount": { "format": "int32", "description": "The number of objects processed during the download operation.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats", "description": "Statistics for BulkDownloadFeedbackLabels operation.", "type": "object" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationCallMetadata", "description": "Call-specific metadata.", "type": "object" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats": { "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStats", "properties": { "correlatedConversationsCount": { "description": "The number of conversations correlated.", "type": "integer", "format": "int32" }, "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "failedConversationsCount": { "format": "int32", "description": "The number of conversations that failed correlation.", "type": "integer" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } } }, "description": "Statistics for TestCorrelationConfig operation.", "type": "object" }, "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", "description": "The confidence of the match ranging from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number" } } }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata": { "properties": { "datasetValidationWarnings": { "description": "A list of any applicable data validation warnings about the question's feedback labels.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified data validation warning.", "A non-trivial percentage of the feedback labels are invalid.", "The quantity of valid feedback labels provided is less than the recommended minimum.", "One or more of the answers have less than the recommended minimum of feedback labels.", "All the labels in the dataset come from a single answer choice." ], "enum": [ "DATASET_VALIDATION_WARNING_UNSPECIFIED", "TOO_MANY_INVALID_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS", "INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER", "ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER" ] } }, "tuningError": { "description": "Error status of the tuning operation for the question. Will only be set if the tuning operation failed.", "type": "string" }, "totalValidLabelCount": { "description": "Total number of valid labels provided for the question at the time of tuining.", "type": "string", "format": "int64" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "description": "Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination": { "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" } }, "description": "A BigQuery Table Reference.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio": { "properties": { "audioGcsUri": { "description": "The Cloud Storage URI of the audio for any given turn.", "type": "string" }, "audioDuration": { "description": "The duration of the audio.", "type": "string", "format": "google-duration" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ConversationDataSourceTurnLevelAudio", "description": "A wrapper for holding the audio for any given turn.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource": { "description": "A question may have multiple answers from varying sources, one of which becomes the \"main\" answer above. AnswerSource represents each individual answer.", "type": "object", "properties": { "sourceType": { "description": "What created the answer.", "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" ] }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." } }, "id": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" }, "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig": { "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig", "properties": { "summarizationModel": { "enumDescriptions": [ "Unspecified summarization model.", "The CCAI baseline model. This model is deprecated and will be removed in the future. We recommend using `generator` instead.", "The CCAI baseline model, V2.0. This model is deprecated and will be removed in the future. We recommend using `generator` instead." ], "type": "string", "enum": [ "SUMMARIZATION_MODEL_UNSPECIFIED", "BASELINE_MODEL", "BASELINE_MODEL_V2_0" ], "enumDeprecated": [ false, true, true ], "description": "Default summarization model to be used." }, "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" } }, "description": "Configuration for summarization.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest": { "properties": { "name": { "description": "Required. The name of the issue model to delete.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDeleteIssueModelRequest", "description": "The request to delete an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo": { "id": "GoogleCloudContactcenterinsightsV1mainConversationQualityMetadataAgentInfo", "properties": { "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" }, "entrySubagentId": { "description": "The entry subagent's ID.", "type": "string" }, "displayName": { "description": "The agent's name.", "type": "string" }, "location": { "description": "The agent's location.", "type": "string" }, "deploymentId": { "description": "The agent's deployment ID. Only applicable to automated agents.", "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" }, "versionId": { "description": "The agent's version ID. Only applicable to automated agents.", "type": "string" }, "versionDisplayName": { "description": "The agent's version display name. Only applicable to automated agents.", "type": "string" }, "teams": { "description": "User-specified strings representing the agent's teams.", "type": "array", "items": { "type": "string" } }, "agentType": { "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ], "description": "The agent type, e.g. HUMAN_AGENT.", "type": "string" }, "team": { "description": "A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.", "deprecated": true, "type": "string" } }, "description": "Information about an agent involved in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest", "properties": { "autoLabelingRule": { "description": "Required. The auto labeling rule to test.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "conversation": { "description": "Required. Conversation data to test rules against.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "description": "The request message for testing auto labeling rules.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData": { "properties": { "sentiment": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "description": "Sentiment expressed for this mention of the entity." }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1EntityMentionData", "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination": { "description": "Google Sheets document details to write the feedback labels to.", "type": "object", "properties": { "sheetTitle": { "description": "Optional. The title of the new sheet to write the feedback labels to.", "type": "string" }, "spreadsheetUri": { "description": "Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination" }, "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse": { "properties": { "dashboards": { "description": "The dashboards under the parent.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" } }, "nextPageToken": { "description": "The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse", "description": "The response of listing dashboards.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata": { "description": "Metadata about the QA scorecard dimension.", "type": "object", "properties": { "qaScorecardId": { "description": "Optional. The QA scorecard ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionQaScorecardDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainListFeedbackLabelsResponse", "properties": { "nextPageToken": { "description": "The next page token.", "type": "string" }, "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainFeedbackLabel" } } }, "description": "The response for listing feedback labels.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision": { "description": "A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.", "type": "object", "properties": { "state": { "type": "string", "enumDescriptions": [ "Unspecified.", "The scorecard revision can be edited.", "Scorecard model training is in progress.", "Scorecard revision model training failed.", "The revision can be used in analysis.", "Scorecard is being deleted.", "Scorecard model training was explicitly cancelled by the user." ], "description": "Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "EDITABLE", "TRAINING", "TRAINING_FAILED", "READY", "DELETING", "TRAINING_CANCELLED" ] }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp that the revision was created.", "type": "string" }, "alternateIds": { "readOnly": true, "description": "Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, "snapshot": { "description": "The snapshot of the scorecard at the time of this revision's creation.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest", "description": "The original request for deployment." } } }, "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList", "description": "A manual list of scorecards to score." } }, "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage": { "description": "The message in the conversation.", "type": "object", "properties": { "systemMessageWrapper": { "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "readOnly": true }, "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessage" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestion": { "description": "A single question to be scored by the Insights QA feature.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion", "properties": { "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "predefinedQuestionConfig": { "description": "The configuration of the predefined question. This field will only be set if the Question Type is predefined.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionPredefinedQuestionConfig" }, "abbreviation": { "description": "Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., \"Greeting\".", "type": "string" }, "answerChoices": { "description": "A list of valid answers to the question, which the LLM must choose from.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionAnswerChoice" } }, "tags": { "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question.", "type": "array", "items": { "type": "string" } }, "questionType": { "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" ], "description": "The type of question.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. The most recent time at which the question was updated.", "type": "string", "readOnly": true }, "tuningMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTuningMetadata", "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." }, "metrics": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionMetrics", "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." }, "name": { "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The time at which this question was created.", "type": "string", "format": "google-datetime" }, "order": { "format": "int32", "description": "Defines the order of the question within its parent scorecard revision.", "type": "integer" }, "answerInstructions": { "description": "Instructions describing how to determine the answer.", "type": "string" }, "qaQuestionDataOptions": { "description": "Options for configuring the data used to generate the QA question.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionQaQuestionDataOptions" } } }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudContactcenterinsightsV1DialogflowSource": { "description": "A Dialogflow source of conversation data.", "type": "object", "properties": { "dialogflowConversation": { "readOnly": true, "description": "Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowSource" }, "GoogleLongrunningListOperationsResponse": { "properties": { "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QaAnswer": { "description": "An answer to a QaQuestion.", "type": "object", "properties": { "tags": { "description": "User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer.", "type": "array", "items": { "type": "string" } }, "qaQuestion": { "description": "The QaQuestion answered by this answer.", "type": "string" }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "conversation": { "description": "The conversation the answer applies to.", "type": "string" }, "questionBody": { "description": "Question text. E.g., \"Did the agent greet the customer?\"", "type": "string" }, "answerSources": { "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" } } }, "id": "GoogleCloudContactcenterinsightsV1QaAnswer" }, "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata": { "id": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest", "description": "Output only. The original request.", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } }, "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object" }, "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage": { "properties": { "text": { "description": "A message from the user that is interacting with the system.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1GenerativeInsightConversationTranscriptMessageUserMessage", "description": "The user message.", "type": "object" }, "GoogleCloudContactcenterinsightsV1IngestConversationsRequest": { "description": "The request to ingest conversations.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsRequest", "properties": { "gcsSource": { "description": "A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource" }, "conversationConfig": { "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig", "description": "Configuration that applies to all conversations." }, "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" }, "transcriptObjectConfig": { "description": "Configuration for when `source` contains conversation transcripts.", "$ref": "GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig" }, "parent": { "description": "Required. The parent resource for new conversations.", "type": "string" }, "speechConfig": { "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." }, "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." } } }, "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig": { "description": "Configuration for the QA feature.", "type": "object", "properties": { "scorecardList": { "description": "A manual list of scorecards to score.", "$ref": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfigScorecardList" } }, "id": "GoogleCloudContactcenterinsightsV1mainAnnotatorSelectorQaConfig" }, "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations": { "id": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequestConversations", "properties": { "conversations": { "description": "Optional. The conversations.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } } }, "description": "Wrapper for a list of conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse": { "properties": { "issueModels": { "description": "The issue models that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse", "description": "The response of listing issue models.", "type": "object" }, "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata": { "id": "GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata", "properties": {}, "description": "The metadata for querying performance overview.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse": { "description": "The response of listing conversations.", "type": "object", "properties": { "conversations": { "description": "The conversations that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" } }, "nextPageToken": { "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse": { "properties": { "failedAnalysisCount": { "format": "int32", "description": "Count of failed analyses.", "type": "integer" }, "successfulAnalysisCount": { "format": "int32", "description": "Count of successful analyses.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsResponse", "description": "The response for a bulk analyze conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1GcsSource": { "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "properties": { "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" }, "audioUri": { "description": "Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" } }, "description": "A Cloud Storage source of conversation data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationParticipant": { "description": "The call participant speaking for a given utterance.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1ConversationParticipant", "properties": { "userId": { "description": "A user-specified ID representing the participant.", "type": "string" }, "obfuscatedExternalUserId": { "description": "Obfuscated user ID from Dialogflow.", "type": "string" }, "role": { "description": "The role of the participant.", "type": "string", "enumDescriptions": [ "Participant's role is not set.", "Participant is a human agent.", "Participant is an automated agent.", "Participant is an end user who conversed with the contact center.", "Participant is either a human or automated agent." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER", "ANY_AGENT" ] }, "dialogflowParticipantName": { "description": "The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "type": "string" }, "dialogflowParticipant": { "description": "Deprecated. Use `dialogflow_participant_name` instead. The name of the Dialogflow participant. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}", "deprecated": true, "type": "string" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore": { "properties": { "tag": { "description": "Tag name.", "type": "string" }, "averageTagNormalizedScore": { "format": "double", "description": "Average tag normalized score per tag.", "type": "number" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore", "description": "Average QA normalized score for the tag.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData": { "properties": { "intentUniqueId": { "description": "The id of the matched intent. Can be used to retrieve the corresponding intent information.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1IntentMatchData", "description": "The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences.", "type": "object" }, "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo": { "id": "GoogleCloudContactcenterinsightsV1ConversationCorrelationInfo", "properties": { "mergedFullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a merged conversation of.", "type": "string", "readOnly": true }, "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.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default value for unspecified.", "This conversation represents a segment of a full conversation. The lowest level of granularity.", "This conversation represents a partial conversation of potentially multiple segments but is not a full conversation.", "This conversation represents a full conversation of potentially multiple segments.", "This conversation represents a synthetic conversation." ], "enum": [ "CORRELATION_TYPE_UNSPECIFIED", "SEGMENT", "PARTIAL", "FULL", "SYNTHETIC" ] }, "readOnly": true }, "fullConversationCorrelationId": { "description": "Output only. The full conversation correlation id this conversation is a segment of.", "type": "string", "readOnly": true } }, "description": "Info for correlating across conversations.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation": { "id": "GoogleCloudContactcenterinsightsV1mainCesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } }, "description": "The CES end session annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData": { "description": "Conversation summarization suggestion data.", "type": "object", "properties": { "text": { "description": "The summarization content that is concatenated into one string.", "type": "string" }, "answerRecord": { "description": "The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}", "type": "string" }, "textSections": { "description": "The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "type": "object", "additionalProperties": { "type": "string" } }, "conversationModel": { "description": "The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}", "type": "string" }, "metadata": { "description": "A map that contains metadata about the summarization and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "confidence": { "description": "The confidence score of the summarization.", "type": "number", "format": "float" }, "generatorId": { "description": "Agent Assist generator ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainConversationSummarizationSuggestionData" }, "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata": { "properties": { "agentVersionDisplayName": { "description": "Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDeploymentDisplayName": { "description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentDisplayName": { "description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" }, "agentId": { "description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentVersionId": { "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" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "description": "Metadata about the agent dimension.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1mainBulkDeleteFeedbackLabelsResponse", "properties": {}, "description": "Response for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueModelRequest": { "description": "The request to create an issue model.", "type": "object", "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" } } }, "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource": { "description": "The entity whose performance is being queried is a single agent.", "type": "object", "properties": { "agentId": { "description": "Required. Agent id to query performance overview for.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequestAgentSource" }, "GoogleCloudContactcenterinsightsV1AnnotationBoundary": { "properties": { "transcriptIndex": { "description": "The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero.", "type": "integer", "format": "int32" }, "wordIndex": { "format": "int32", "description": "The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero.", "type": "integer" } }, "id": "GoogleCloudContactcenterinsightsV1AnnotationBoundary", "description": "A point in a conversation that marks the start or the end of an annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainHoldData": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1mainHoldData", "description": "The data for a hold annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata": { "description": "Metadata for creating an issue.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "description": "The original request for creation.", "$ref": "GoogleCloudContactcenterinsightsV1mainCreateIssueRequest" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudContactcenterinsightsV1mainCreateIssueMetadata" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData", "description": "The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainIssueMatchData": { "id": "GoogleCloudContactcenterinsightsV1mainIssueMatchData", "properties": { "issueAssignment": { "$ref": "GoogleCloudContactcenterinsightsV1mainIssueAssignment", "description": "Information about the issue's assignment." } }, "description": "The data for an issue match annotation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata": { "description": "Metadata for deploying an issue model.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "description": "The original request for deployment." }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage": { "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessage", "properties": { "userMessage": { "description": "A message from the user that is interacting with the system.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageUserMessage" }, "systemMessageWrapper": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightConversationTranscriptMessageSystemMessages", "description": "A wrapper for system messages per turn." }, "messageId": { "description": "The message id of the message.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.", "type": "string", "readOnly": true } }, "description": "The message in the conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest": { "description": "The request to deploy a QaScorecardRevision", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest", "properties": {} }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { "properties": { "qaAnswerLabel": { "description": "QaAnswer label used for Quality AI example conversations.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue" }, "labeledResource": { "description": "Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Update time of the label.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Create time of the label.", "type": "string", "readOnly": true }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "type": "string" }, "label": { "description": "String label used for Topic Modeling.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse": { "properties": { "analyses": { "description": "The analyses that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse", "description": "The response to list analyses.", "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { "properties": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", "description": "Output only. The original request for delete.", "readOnly": true }, "partialErrors": { "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata", "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest", "properties": { "parent": { "description": "Required. The parent resource to export data from.", "type": "string" }, "writeDisposition": { "description": "Options for what to do if the destination table already exists.", "type": "string", "enumDescriptions": [ "Write disposition is not specified. Defaults to WRITE_TRUNCATE.", "If the table already exists, BigQuery will overwrite the table data and use the schema from the load.", "If the table already exists, BigQuery will append data to the table." ], "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_TRUNCATE", "WRITE_APPEND" ] }, "exportSchemaVersion": { "enumDescriptions": [ "Unspecified. Defaults to EXPORT_V3.", "Export schema version 1.", "Export schema version 2.", "Export schema version 3.", "Export schema version 4.", "Export schema version 5.", "Export schema version 6.", "Export schema version 7.", "Export schema version 8.", "Export schema version 9.", "Export schema version 10.", "Export schema version 11.", "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", "Export schema version 15.", "Export schema version 16.", "Export schema version 17.", "Export schema version latest available." ], "enum": [ "EXPORT_SCHEMA_VERSION_UNSPECIFIED", "EXPORT_V1", "EXPORT_V2", "EXPORT_V3", "EXPORT_V4", "EXPORT_V5", "EXPORT_V6", "EXPORT_V7", "EXPORT_V8", "EXPORT_V9", "EXPORT_V10", "EXPORT_V11", "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", "EXPORT_V15", "EXPORT_V16", "EXPORT_V17", "EXPORT_VERSION_LATEST_AVAILABLE" ], "description": "Optional. Version of the export schema.", "type": "string" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" }, "kmsKey": { "description": "A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}", "type": "string" }, "bigQueryDestination": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." } }, "description": "The request to export insights.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainInterruptionData": { "description": "The data for an interruption annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainInterruptionData", "properties": {} }, "GoogleCloudContactcenterinsightsV1CreateIssueMetadata": { "description": "Metadata for creating an issue.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CreateIssueMetadata", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1CreateIssueRequest", "description": "The original request for creation." }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest": { "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "description": "Required. The issue model to create.", "$ref": "GoogleCloudContactcenterinsightsV1IssueModel" } }, "id": "GoogleCloudContactcenterinsightsV1CreateIssueModelRequest", "description": "The request to create an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true }, "request": { "readOnly": true, "description": "Output only. The original request for initialization.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "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" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse": { "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse", "properties": {}, "description": "Response for an export insights operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1Dataset": { "properties": { "type": { "description": "Dataset usage type.", "type": "string", "enumDescriptions": [ "Default value for unspecified.", "For evals only.", "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" ], "enum": [ "TYPE_UNSPECIFIED", "EVAL", "LIVE" ] }, "ttl": { "description": "Optional. Option TTL for the dataset.", "type": "string", "format": "google-duration" }, "createTime": { "format": "google-datetime", "description": "Output only. Dataset create time.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. Dataset update time.", "type": "string", "readOnly": true }, "name": { "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, "displayName": { "description": "Display name for the dataaset", "type": "string" }, "description": { "description": "Dataset description.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1Dataset", "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource": { "properties": { "format": { "enumDescriptions": [ "Unspecified format.", "CSV format.", "JSON format." ], "enum": [ "FORMAT_UNSPECIFIED", "CSV", "JSON" ], "description": "Required. File format which will be ingested.", "type": "string" }, "objectUri": { "description": "Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequestGcsSource", "description": "Google Cloud Storage Object details to get the feedback label file from.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats": { "description": "Statistics for BulkDownloadFeedbackLabels operation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1mainBulkDownloadFeedbackLabelsMetadataDownloadStats", "properties": { "processedObjectCount": { "format": "int32", "description": "The number of objects processed during the download operation.", "type": "integer" }, "successfulDownloadCount": { "format": "int32", "description": "The number of new feedback labels downloaded during this operation. Different from \"processed\" because some labels might not be downloaded because an error.", "type": "integer" }, "totalFilesWritten": { "description": "Total number of files written to the provided Cloud Storage bucket.", "type": "integer", "format": "int32" }, "fileNames": { "description": "Output only. Full name of the files written to Cloud storage.", "type": "array", "items": { "type": "string" }, "readOnly": true } } }, "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse": { "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelResponse", "properties": {}, "description": "The response to deploy an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata": { "description": "Metadata about the Conversational Agents playbook dimension.", "type": "object", "properties": { "playbookDisplayName": { "description": "Optional. The dialogflow playbook display name.", "type": "string" }, "playbookId": { "description": "Optional. The dialogflow playbook ID.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainDimensionConversationalAgentsPlaybookDimensionMetadata" }, "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats": { "description": "Statistics for TestCorrelationConfig operation.", "type": "object", "properties": { "correlatedConversationsCount": { "format": "int32", "description": "The number of conversations correlated.", "type": "integer" }, "sampledConversationsCount": { "format": "int32", "description": "The number of conversations sampled.", "type": "integer" }, "failedConversationsCount": { "description": "The number of conversations that failed correlation.", "type": "integer", "format": "int32" }, "conversationCorrelationErrors": { "description": "A list of errors that occurred during correlation, one for each conversation that failed.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError" } }, "partialErrors": { "description": "Partial errors during test correlation config operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudContactcenterinsightsV1mainTestCorrelationConfigMetadataFullConversationCorrelationStats" }, "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError": { "properties": { "conversation": { "description": "The conversation resource name that had an error during correlation.", "type": "string" }, "status": { "description": "The error status.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleCloudContactcenterinsightsV1TestCorrelationConfigMetadataFullConversationCorrelationStatsConversationCorrelationError", "description": "An error that occurred during correlation for a specific conversation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { "properties": {}, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "description": "The response for a bulk delete conversations operation.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse": { "description": "The response message for listing auto labeling rules.", "type": "object", "properties": { "autoLabelingRules": { "description": "The auto labeling rules.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "GoogleCloudCesV1mainToolResponse": { "id": "GoogleCloudCesV1mainToolResponse", "properties": { "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" }, "displayName": { "description": "Output only. Display name of the tool.", "type": "string", "readOnly": true }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object" }, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" } }, "description": "The execution result of a specific tool from the client or the agent.", "type": "object" }, "GoogleCloudContactcenterinsightsV1EntityMentionData": { "description": "The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1EntityMentionData", "properties": { "entityUniqueId": { "description": "The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to.", "type": "string" }, "type": { "enumDescriptions": [ "Unspecified.", "Proper noun.", "Common noun (or noun compound)." ], "enum": [ "MENTION_TYPE_UNSPECIFIED", "PROPER", "COMMON" ], "description": "The type of the entity mention.", "type": "string" }, "sentiment": { "description": "Sentiment expressed for this mention of the entity.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" } } }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata": { "description": "The metadata for a bulk delete conversations operation.", "type": "object", "properties": { "partialErrors": { "description": "Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "endTime": { "format": "google-datetime", "description": "The time the operation finished running.", "type": "string" }, "createTime": { "description": "The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "description": "The original request for bulk delete.", "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest": { "description": "The request for generative insights.", "type": "object", "properties": { "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" }, "chart": { "description": "The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "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" }, "naturalLanguageQuery": { "description": "The natural language query specified by the user. If this field is specified, `sql_query` will be ignored.", "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" }, "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" }, "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" }, "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" }, "userProvidedChartSpec": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.", "type": "object" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest": { "properties": { "name": { "description": "Required. The issue model to deploy.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DeployIssueModelRequest", "description": "The request to deploy an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1DialogflowIntent": { "properties": { "displayName": { "description": "The human-readable name of the intent.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1DialogflowIntent", "description": "The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "properties": { "qaQuestionIds": { "description": "Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional.", "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. The time at which the question tag was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. The most recent time at which the question tag was updated.", "type": "string", "format": "google-datetime", "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" }, "displayName": { "description": "Required. A user-specified display name for the tag.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "type": "object" }, "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" } }, "id": "GoogleCloudContactcenterinsightsV1GcsSource", "description": "A Cloud Storage source of conversation data.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata": { "description": "The metadata for updating a QaQuestionTag Resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest", "description": "Output only. The original request.", "readOnly": true }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudContactcenterinsightsV1Entity": { "id": "GoogleCloudContactcenterinsightsV1Entity", "properties": { "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" ] }, "sentiment": { "description": "The aggregate sentiment expressed for this entity in the conversation.", "$ref": "GoogleCloudContactcenterinsightsV1SentimentData" }, "salience": { "format": "float", "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", "type": "number" }, "displayName": { "description": "The representative name for the entity.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", "type": "object" } }, "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" }, "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse": { "id": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse", "properties": { "feedbackLabels": { "description": "The feedback labels that match the request.", "type": "array", "items": { "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" } }, "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 for listing all feedback labels.", "type": "object" }, "GoogleCloudContactcenterinsightsV1Dimension": { "properties": { "conversationProfileDimensionMetadata": { "description": "Output only. Metadata about the conversation profile dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", "readOnly": true }, "conversationalAgentsToolDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", "description": "Output only. Metadata about the Conversational Agents tool dimension.", "readOnly": true }, "qaQuestionAnswerDimensionMetadata": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension." }, "qaQuestionDimensionMetadata": { "description": "Output only. Metadata about the QA question dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "readOnly": true }, "qaScorecardDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", "description": "Output only. Metadata about the QA scorecard dimension.", "readOnly": true }, "dimensionKey": { "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", "The dimension is keyed by the Conversational Agents playbook ID.", "The dimension is keyed by the Conversational Agents playbook display name.", "The dimension is keyed by the Conversational Agents tool ID.", "The dimension is keyed by the Conversational Agents tool display name.", "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents.", "The dimension is keyed by label keys.", "The dimension is keyed by label values.", "The dimension is keyed by label key-value pairs.", "The dimension is keyed by the last transfer sub agent name." ], "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", "CONVERSATIONAL_AGENTS_TOOL_ID", "CONVERSATIONAL_AGENTS_TOOL_NAME", "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID", "LABEL_KEY", "LABEL_VALUE", "LABEL_KEY_AND_VALUE", "LAST_TRANSFER_SUB_AGENT_NAME" ], "description": "The key of the dimension.", "type": "string" }, "issueDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, "labelDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionLabelDimensionMetadata", "description": "Output only. Metadata about conversation labels.", "readOnly": true }, "clientSentimentCategoryDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", "description": "Output only. Metadata about the client sentiment category dimension.", "readOnly": true }, "agentDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, "mediumDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the conversation medium dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata" }, "conversationalAgentsPlaybookDimensionMetadata": { "readOnly": true, "description": "Output only. Metadata about the Conversational Agents playbook dimension.", "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata" } }, "id": "GoogleCloudContactcenterinsightsV1Dimension", "description": "A dimension determines the grouping key for the query. In SQL terms, these would be part of both the \"SELECT\" and \"GROUP BY\" clauses.", "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest": { "id": "GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest", "properties": { "parent": { "description": "Required. The parent resource of the issue model.", "type": "string" }, "issueModel": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel", "description": "Required. The issue model to create." } }, "description": "The request to create an issue model.", "type": "object" }, "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination": { "properties": { "table": { "description": "The BigQuery table name to which the insights data should be written. If this table does not exist, the export call returns an INVALID_ARGUMENT error.", "type": "string" }, "dataset": { "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" }, "projectId": { "description": "A project ID or number. If specified, then export will attempt to write data to this project instead of the resource project. Otherwise, the resource project will be used.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainExportInsightsDataRequestBigQueryDestination", "description": "A BigQuery Table Reference.", "type": "object" }, "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation": { "description": "The CES end session annotation.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1CesEndSessionAnnotation", "properties": { "endSession": { "description": "End session signal from CES.", "$ref": "GoogleCloudCesV1mainEndSession" } } }, "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput": { "description": "Explicit input used for generating the answer", "type": "object", "properties": { "generatorName": { "description": "The resource name of associated generator. Format: `projects//locations//generators/`", "type": "string" }, "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "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" ], "description": "Query source for the answer.", "type": "string" } }, "id": "GoogleCloudContactcenterinsightsV1mainRuntimeAnnotationUserInput" }, "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation": { "description": "The conversation used to generate the chart.", "type": "object", "properties": { "updateTime": { "description": "The update time of the conversation.", "type": "string", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "The create time of the conversation.", "type": "string" }, "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": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversationMessage" } } }, "id": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsChartConversation" }, "GoogleCloudContactcenterinsightsV1IssueModel": { "description": "The issue model resource.", "type": "object", "id": "GoogleCloudContactcenterinsightsV1IssueModel", "properties": { "trainingStats": { "readOnly": true, "$ref": "GoogleCloudContactcenterinsightsV1IssueModelLabelStats", "description": "Output only. Immutable. The issue model's label statistics on its training data." }, "modelType": { "description": "Type of the model.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Type V1.", "Type V2." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "TYPE_V1", "TYPE_V2" ] }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" }, "updateTime": { "description": "Output only. The most recent time at which the issue model was updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "issueCount": { "format": "int64", "description": "Output only. Number of issues in this issue model.", "type": "string", "readOnly": true }, "state": { "description": "Output only. State of the model.", "enum": [ "STATE_UNSPECIFIED", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Model is not deployed but is ready to deploy.", "Model is being deployed.", "Model is deployed and is ready to be used. A model can only be used in analysis if it's in this state.", "Model is being undeployed.", "Model is being deleted." ] }, "createTime": { "format": "google-datetime", "description": "Output only. The time at which this issue model was created.", "type": "string", "readOnly": true }, "languageCode": { "description": "Language of the model.", "type": "string" }, "displayName": { "description": "The representative name for the issue model.", "type": "string" }, "inputDataConfig": { "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "description": "Configs for the input data that used to create the issue model." } } } }, "description": "", "ownerDomain": "google.com", "version_module": true, "rootUrl": "https://contactcenterinsights.googleapis.com/", "baseUrl": "https://contactcenterinsights.googleapis.com/", "servicePath": "", "title": "Contact Center AI Insights API", "resources": { "projects": { "resources": { "locations": { "resources": { "issueModels": { "resources": { "issues": { "methods": { "list": { "path": "v1alpha1/{+parent}/issues", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.issueModels.issues.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssuesResponse" }, "description": "Lists issues.", "httpMethod": "GET", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the issue.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.issueModels.issues.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an issue.", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the issue to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "patch": { "parameters": { "updateMask": { "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string", "location": "query" }, "name": { "type": "string", "required": true, "location": "path", "description": "Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue}", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "description": "Updates an issue.", "id": "contactcenterinsights.projects.locations.issueModels.issues.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+/issues/[^/]+$", "description": "Required. The name of the issue to get." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.issueModels.issues.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" }, "description": "Gets an issue." }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates an issue.", "id": "contactcenterinsights.projects.locations.issueModels.issues.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issues", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The parent resource of the issue.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Issue" } } } } }, "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListIssueModelsResponse" }, "description": "Lists issue models.", "id": "contactcenterinsights.projects.locations.issueModels.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issueModels", "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the issue model.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "GET" }, "undeploy": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", "id": "contactcenterinsights.projects.locations.issueModels.undeploy", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:undeploy", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The issue model to undeploy.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest" } }, "export": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest" }, "parameters": { "name": { "description": "Required. The issue model to export.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:export", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Exports an issue model to the provided destination.", "id": "contactcenterinsights.projects.locations.issueModels.export", "parameterOrder": [ "name" ] }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "Updates an issue model.", "id": "contactcenterinsights.projects.locations.issueModels.patch", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "location": "query", "description": "The list of fields to be updated.", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "create": { "id": "contactcenterinsights.projects.locations.issueModels.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates an issue model.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/issueModels", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the issue model." } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" } }, "get": { "parameters": { "name": { "description": "Required. The name of the issue model to get.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModel" }, "description": "Gets an issue model.", "id": "contactcenterinsights.projects.locations.issueModels.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "calculateIssueModelStats": { "parameters": { "issueModel": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The resource name of the issue model to query against.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateIssueModelStatsResponse" }, "description": "Gets an issue model's statistics.", "id": "contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats", "parameterOrder": [ "issueModel" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+issueModel}:calculateIssueModelStats" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes an issue model.", "id": "contactcenterinsights.projects.locations.issueModels.delete", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the issue model to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$" } }, "httpMethod": "DELETE" }, "import": { "path": "v1alpha1/{+parent}/issueModels:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels:import", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Imports an issue model from a Cloud Storage bucket.", "id": "contactcenterinsights.projects.locations.issueModels.import", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest" }, "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the issue model.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST" }, "deploy": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy", "response": { "$ref": "GoogleLongrunningOperation" }, "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.", "id": "contactcenterinsights.projects.locations.issueModels.deploy", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:deploy", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/issueModels/[^/]+$", "description": "Required. The issue model to deploy.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest" } } } }, "assessmentRules": { "methods": { "delete": { "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "description": "Required. The name of the assessment rule to delete." } }, "id": "contactcenterinsights.projects.locations.assessmentRules.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an assessment rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "list": { "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the assessment rules." } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessmentRules", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentRulesResponse" }, "description": "Lists assessment rules.", "id": "contactcenterinsights.projects.locations.assessmentRules.list", "parameterOrder": [ "parent" ] }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "parameters": { "parent": { "description": "Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" }, "assessmentRuleId": { "description": "Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string", "location": "query" } }, "httpMethod": "POST", "path": "v1alpha1/{+parent}/assessmentRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "Creates an assessment rule.", "id": "contactcenterinsights.projects.locations.assessmentRules.create", "parameterOrder": [ "parent" ] }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the assessment rule to get.", "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.assessmentRules.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "Get an assessment rule." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.assessmentRules.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "description": "Updates an assessment rule.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AssessmentRule" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$", "description": "Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}", "location": "path", "type": "string", "required": true } } } } }, "encryptionSpec": { "methods": { "initialize": { "path": "v1alpha1/{+name}:initialize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST" } } }, "autoLabelingRules": { "methods": { "delete": { "parameters": { "name": { "description": "Required. The name of the auto labeling rule to delete. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an auto labeling rule.", "id": "contactcenterinsights.projects.locations.autoLabelingRules.delete", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project and location to list auto labeling rules from. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of auto labeling rules to return in a single response. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous List request, if any.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/autoLabelingRules", "id": "contactcenterinsights.projects.locations.autoLabelingRules.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAutoLabelingRulesResponse" }, "description": "Lists auto labeling rules." }, "get": { "id": "contactcenterinsights.projects.locations.autoLabelingRules.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "Gets an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "description": "Required. The name of the auto labeling rule to get. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "location": "path", "type": "string", "required": true } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/autoLabelingRules", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "Creates an auto labeling rule.", "id": "contactcenterinsights.projects.locations.autoLabelingRules.create", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The project and location to create the auto labeling rule in. Format: projects/{project}/locations/{location}" }, "autoLabelingRuleId": { "description": "Required. The ID to use for the auto labeling rule, which will become the final component of the auto labeling rule's resource name.", "type": "string", "location": "query" } }, "httpMethod": "POST" }, "test": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent project and location. Format: projects/{project}/locations/{location}", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules:test", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestAutoLabelingRuleResponse" }, "description": "Tests auto labeling rules against a conversation.", "id": "contactcenterinsights.projects.locations.autoLabelingRules.test", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/autoLabelingRules:test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name of the auto-labeling rule. Format: projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/autoLabelingRules/[^/]+$", "required": true, "type": "string", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "id": "contactcenterinsights.projects.locations.autoLabelingRules.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/autoLabelingRules/{autoLabelingRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AutoLabelingRule" }, "description": "Updates an auto labeling rule.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } }, "dashboards": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the dashboard to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$" } }, "httpMethod": "DELETE" }, "list": { "id": "contactcenterinsights.projects.locations.dashboards.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDashboardsResponse" }, "description": "Lists Dashboards.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/dashboards", "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "Optional. The filter expression to filter dashboards listed in the response.", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the dashboards.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. The order by expression to order dashboards listed in the response.", "type": "string", "location": "query" } } }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dashboard.", "location": "path", "type": "string", "required": true }, "dashboardId": { "description": "Optional. A unique ID for the new Dashboard. This ID will become the final component of the Dashboard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string", "location": "query" } }, "httpMethod": "POST", "path": "v1alpha1/{+parent}/dashboards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "description": "Creates a Dashboard.", "id": "contactcenterinsights.projects.locations.dashboards.create", "parameterOrder": [ "parent" ] }, "get": { "id": "contactcenterinsights.projects.locations.dashboards.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "description": "Gets a Dashboard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "description": "Required. The name of the dashboard to get." } } }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "description": "Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` * `description`", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "id": "contactcenterinsights.projects.locations.dashboards.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dashboard" }, "description": "Updates a Dashboard.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "charts": { "methods": { "create": { "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the chart.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$", "required": true, "type": "string", "location": "path" }, "chartId": { "location": "query", "description": "Optional. A unique ID for the new Chart. This ID will become the final component of the Chart's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "id": "contactcenterinsights.projects.locations.dashboards.charts.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "Creates a Chart.", "path": "v1alpha1/{+parent}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.dashboards.charts.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "Gets a Chart.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "description": "Required. The name of the chart to get.", "location": "path", "type": "string", "required": true } } }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$" }, "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`", "type": "string", "format": "google-fieldmask", "location": "query" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "id": "contactcenterinsights.projects.locations.dashboards.charts.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Chart" }, "description": "Updates a Chart.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.dashboards.charts.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts/{chartsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Chart.", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+/charts/[^/]+$", "description": "Required. The name of the chart to delete." } } }, "list": { "id": "contactcenterinsights.projects.locations.dashboards.charts.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}/charts", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListChartsResponse" }, "description": "Lists Charts.", "path": "v1alpha1/{+parent}/charts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the charts.", "pattern": "^projects/[^/]+/locations/[^/]+/dashboards/[^/]+$" } } } } } } }, "analysisRules": { "methods": { "list": { "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.analysisRules.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysisRulesResponse" }, "description": "Lists analysis rules.", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The value returned by the last `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior `ListAnalysisRules` call and the system should return the next page of data.", "type": "string", "location": "query" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the analysis rules." } } }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$", "description": "Required. The name of the analysis rule to delete." } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.analysisRules.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a analysis rule." }, "patch": { "id": "contactcenterinsights.projects.locations.analysisRules.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "Updates a analysis rule.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.", "type": "string", "location": "query" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" } }, "create": { "path": "v1alpha1/{+parent}/analysisRules", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.analysisRules.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "Creates a analysis rule.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the analysis rule. Required. The location to create a analysis rule for. Format: `projects//locations/` or `projects//locations/`", "location": "path", "required": true, "type": "string" } } }, "get": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the AnalysisRule to get.", "pattern": "^projects/[^/]+/locations/[^/]+/analysisRules/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnalysisRule" }, "description": "Get a analysis rule.", "id": "contactcenterinsights.projects.locations.analysisRules.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } }, "phraseMatchers": { "methods": { "list": { "path": "v1alpha1/{+parent}/phraseMatchers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListPhraseMatchersResponse" }, "description": "Lists phrase matchers.", "id": "contactcenterinsights.projects.locations.phraseMatchers.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the phrase matcher.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "format": "int32", "description": "The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.", "type": "string" } }, "httpMethod": "GET" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a phrase matcher.", "id": "contactcenterinsights.projects.locations.phraseMatchers.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the phrase matcher to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$" } }, "httpMethod": "DELETE" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.phraseMatchers.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "description": "Updates a phrase matcher.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "The list of fields to be updated.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "description": "The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "create": { "id": "contactcenterinsights.projects.locations.phraseMatchers.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "description": "Creates a phrase matcher.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/phraseMatchers", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/phraseMatchers/[^/]+$", "description": "Required. The name of the phrase matcher to get." } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.phraseMatchers.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PhraseMatcher" }, "description": "Gets a phrase matcher." } } }, "insightsdata": { "methods": { "export": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource to export data from.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/insightsdata:export", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Export insights data to a destination defined in the request body.", "id": "contactcenterinsights.projects.locations.insightsdata.export", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/insightsdata:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "qaQuestionTags": { "methods": { "list": { "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestionTags.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports conjunctions (ie. AND operators). Supported fields include the following: * `project_id` - id of the project to list tags for * `qa_scorecard_id` - id of the scorecard to list tags for * `revision_id` - id of the scorecard revision to list tags for` * `qa_question_id - id of the question to list tags for`", "type": "string" } }, "path": "v1alpha1/{+parent}/qaQuestionTags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaQuestionTags.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionTagsResponse" }, "description": "Lists the question tags." }, "delete": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the QaQuestionTag to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$" } }, "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a QaQuestionTag.", "id": "contactcenterinsights.projects.locations.qaQuestionTags.delete", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a QaQuestionTag.", "id": "contactcenterinsights.projects.locations.qaQuestionTags.patch", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "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", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "description": "Identifier. Resource name for the QaQuestionTag Format projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} In the above format, the last segment, i.e., qa_question_tag, is a server-generated ID corresponding to the tag resource.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "PATCH" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaQuestionTags", "id": "contactcenterinsights.projects.locations.qaQuestionTags.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "description": "Creates a QaQuestionTag.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaQuestionTag.", "location": "path", "required": true, "type": "string" }, "qaQuestionTagId": { "location": "query", "description": "Optional. A unique ID for the new QaQuestionTag. This ID will become the final component of the QaQuestionTag's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string" } } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag" }, "description": "Gets a QaQuestionTag.", "id": "contactcenterinsights.projects.locations.qaQuestionTags.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaQuestionTags/[^/]+$", "description": "Required. The name of the QaQuestionTag to get." } }, "httpMethod": "GET" } } }, "authorizedViewSets": { "methods": { "create": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "Create AuthorizedViewSet", "path": "v1alpha1/{+parent}/authorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "authorizedViewSetId": { "location": "query", "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the AuthorizedViewSet." } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "Get AuthorizedViewSet", "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "description": "Required. The name of the AuthorizedViewSet to get.", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET" }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", "type": "string" } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedViewSet" }, "description": "Updates an AuthorizedViewSet.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", "parameterOrder": [ "name" ] }, "delete": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "description": "Required. The name of the AuthorizedViewSet to delete." }, "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.", "type": "boolean", "location": "query" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an AuthorizedViewSet.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "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.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized view sets listed in the response.", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the AuthorizedViewSets." }, "filter": { "description": "Optional. The filter expression to filter authorized view sets listed in the response.", "type": "string", "location": "query" } }, "path": "v1alpha1/{+parent}/authorizedViewSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewSetsResponse" }, "description": "List AuthorizedViewSets" } }, "resources": { "authorizedViews": { "methods": { "setIamPolicy": { "parameters": { "resource": { "type": "string", "required": true, "location": "path", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:setIamPolicy" }, "getIamPolicy": { "parameters": { "options.requestedPolicyVersion": { "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "resource": { "required": true, "type": "string", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy", "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an AuthorizedView.", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the AuthorizedView to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "search": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/authorizedViews:search", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SearchAuthorizedViewsResponse" }, "description": "SearchAuthorizedViewSets", "httpMethod": "GET", "parameters": { "query": { "location": "query", "description": "Optional. The query expression to search authorized views.", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string" }, "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" } } }, "testIamPermissions": { "httpMethod": "POST", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "type": "string" } }, "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions", "parameterOrder": [ "resource" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:testIamPermissions" }, "queryMetrics": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics", "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Query metrics.", "path": "v1alpha1/{+location}:queryMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" } }, "generativeInsights": { "path": "v1alpha1/{+location}:generativeInsights", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:generativeInsights", "response": { "$ref": "GoogleLongrunningOperation" }, "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", "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" }, "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST" }, "create": { "httpMethod": "POST", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the AuthorizedView.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "authorizedViewId": { "location": "query", "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See https://google.aip.dev/122#resource-id-segments", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "description": "Create AuthorizedView", "path": "v1alpha1/{+parent}/authorizedViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "description": "Get AuthorizedView", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the AuthorizedView to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "queryPerformanceOverview": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryPerformanceOverview", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}:queryPerformanceOverview", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "description": "Updates an AuthorizedView.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AuthorizedView" }, "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "location": "path", "type": "string", "required": true }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`", "type": "string", "location": "query" } } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAuthorizedViewsResponse" }, "description": "List AuthorizedViewSets", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/authorizedViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$" }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. The order by expression to order authorized views listed in the response.", "type": "string" }, "filter": { "location": "query", "description": "Optional. The filter expression to filter authorized views listed in the response.", "type": "string" } }, "httpMethod": "GET" } }, "resources": { "conversations": { "resources": { "feedbackLabels": { "methods": { "list": { "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "description": "List feedback labels.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "type": "string" } }, "httpMethod": "GET" }, "delete": { "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to delete." } }, "httpMethod": "DELETE", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "description": "Required. The list of fields to be updated.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "required": true, "type": "string", "location": "path", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the feedback label.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the feedback label to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string", "location": "path" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Get feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } }, "assessments": { "resources": { "notes": { "methods": { "list": { "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The parent resource of the notes." }, "pageSize": { "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.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "type": "string" } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "description": "List Notes.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/notes" }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`", "type": "string" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" } }, "create": { "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the note.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Create Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the note to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "DELETE" } } } }, "methods": { "publish": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:publish", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Publish an Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the assessment to publish.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "POST" }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to delete.", "location": "path", "required": true, "type": "string" }, "force": { "location": "query", "description": "Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.", "type": "boolean" } }, "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete an Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete", "parameterOrder": [ "name" ] }, "list": { "parameters": { "filter": { "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.", "location": "path", "type": "string", "required": true }, "pageSize": { "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string", "location": "query" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "description": "List Assessments.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list", "parameterOrder": [ "parent" ] }, "finalize": { "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the assessment to finalize.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Finalize an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:finalize" }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "parameters": { "parent": { "description": "Required. The parent resource of the assessment.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Create Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create", "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "description": "Required. The name of the assessment to get.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Get Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get", "parameterOrder": [ "name" ] }, "appeal": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Appeal an Assessment.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:appeal", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the assessment to appeal.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" } } } } }, "methods": { "delete": { "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the conversation to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$" }, "force": { "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean", "location": "query" } } }, "list": { "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string" }, "view": { "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "description": "The level of details of the conversation. Default is `BASIC`.", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "type": "string", "required": true, "location": "path" }, "pageSize": { "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" } }, "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "description": "Lists conversations." }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to get." }, "view": { "type": "string", "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ], "description": "The level of details of the conversation. Default is `FULL`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ] } }, "httpMethod": "GET" }, "generateSignedAudio": { "parameters": { "name": { "description": "Required. The name of the conversation to sign.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "description": "Gets the signed URI for the audio for the given conversation.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", "parameterOrder": [ "name" ] }, "calculateStats": { "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", "description": "Required. The location of the conversations.", "location": "path", "type": "string", "required": true }, "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string" } }, "httpMethod": "GET", "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "description": "Gets conversation statistics.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats", "parameterOrder": [ "location" ] } } }, "operations": { "methods": { "list": { "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "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`.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "GET" } } } } } } }, "qaScorecards": { "resources": { "revisions": { "methods": { "create": { "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Creates a QaScorecardRevision.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/revisions", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The parent resource of the QaScorecardRevision." }, "qaScorecardRevisionId": { "location": "query", "description": "Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" } }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Gets a QaScorecardRevision.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to get.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET" }, "deploy": { "path": "v1alpha1/{+name}:deploy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.deploy", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Deploy a QaScorecardRevision.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DeployQaScorecardRevisionRequest" }, "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to deploy." } } }, "tuneQaScorecardRevision": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:tuneQaScorecardRevision", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.tuneQaScorecardRevision", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Fine tune one or more QaModels.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TuneQaScorecardRevisionRequest" }, "httpMethod": "POST", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource for new fine tuning job instance.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a QaScorecardRevision.", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The name of the QaScorecardRevision to delete." }, "force": { "description": "Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "type": "boolean", "location": "query" } } }, "undeploy": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UndeployQaScorecardRevisionRequest" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the QaScorecardRevision to undeploy.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:undeploy", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecardRevision" }, "description": "Undeploy a QaScorecardRevision.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.undeploy", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/revisions", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardRevisionsResponse" }, "description": "Lists all revisions under the parent QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character." }, "qaScorecardSources": { "description": "Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards Revisions from Scorecards of one or more sources.", "repeated": true, "enum": [ "QA_SCORECARD_SOURCE_UNSPECIFIED", "QA_SCORECARD_SOURCE_CUSTOMER_DEFINED", "QA_SCORECARD_SOURCE_DISCOVERY_ENGINE" ], "type": "string", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment." ], "location": "query" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.", "type": "string", "location": "query" } }, "httpMethod": "GET" } }, "resources": { "qaQuestions": { "methods": { "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "description": "Required. The name of the QaQuestion to delete.", "location": "path", "type": "string", "required": true } }, "httpMethod": "DELETE" }, "list": { "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "description": "Optional. The maximum number of questions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListQaQuestionsResponse`. This value indicates that this is a continuation of a prior `ListQaQuestions` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "description": "Required. The parent resource of the questions.", "location": "path", "required": true, "type": "string" } }, "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaQuestionsResponse" }, "description": "Lists QaQuestions.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaQuestions" }, "create": { "parameters": { "parent": { "description": "Required. The parent resource of the QaQuestion.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+$", "required": true, "type": "string", "location": "path" }, "qaQuestionId": { "description": "Optional. A unique ID for the new question. This ID will become the final component of the question's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string", "location": "query" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Create a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaQuestions" }, "get": { "parameters": { "name": { "description": "Required. The name of the QaQuestion to get.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Gets a QaQuestion.", "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.get", "parameterOrder": [ "name" ] }, "patch": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "description": "Updates a QaQuestion.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaQuestion" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `abbreviation` * `answer_choices` * `answer_instructions` * `order` * `question_body` * `tags`", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+/revisions/[^/]+/qaQuestions/[^/]+$", "type": "string", "required": true, "location": "path" } } } } } } } }, "methods": { "patch": { "parameters": { "name": { "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "required": true, "location": "path" }, "updateMask": { "format": "google-fieldmask", "description": "Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`", "type": "string", "location": "query" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Updates a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "parameters": { "qaScorecardId": { "location": "query", "description": "Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the QaScorecard.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/qaScorecards", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Create a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.create", "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "description": "Required. The name of the QaScorecard to get.", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaScorecard" }, "description": "Gets a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1alpha1/{+parent}/qaScorecards", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListQaScorecardsResponse" }, "description": "Lists QaScorecards.", "id": "contactcenterinsights.projects.locations.qaScorecards.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.", "type": "string" }, "qaScorecardSources": { "repeated": true, "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.", "enumDescriptions": [ "The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.", "The scorecard is a custom scorecard created by the user.", "The scorecard is a scorecard created through discovery engine deployment." ], "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the scorecards.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "GET" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a QaScorecard.", "id": "contactcenterinsights.projects.locations.qaScorecards.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the QaScorecard to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/qaScorecards/[^/]+$", "type": "string", "required": true, "location": "path" }, "force": { "description": "Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", "type": "boolean", "location": "query" } }, "httpMethod": "DELETE" } } }, "operations": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.operations.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "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`.", "id": "contactcenterinsights.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1alpha1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "contactcenterinsights.projects.locations.operations.list", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "httpMethod": "GET" } } }, "conversations": { "resources": { "analyses": { "methods": { "list": { "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the analyses.", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "type": "integer", "location": "query" }, "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.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/analyses", "id": "contactcenterinsights.projects.locations.conversations.analyses.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAnalysesResponse" }, "description": "Lists analyses." }, "create": { "path": "v1alpha1/{+parent}/analyses", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.analyses.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates an analysis. The long running operation is done when the analysis has completed.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the analysis.", "location": "path", "type": "string", "required": true } } }, "get": { "parameters": { "name": { "description": "Required. The name of the analysis to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "GET", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Analysis" }, "description": "Gets an analysis.", "id": "contactcenterinsights.projects.locations.conversations.analyses.get", "parameterOrder": [ "name" ] }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an analysis.", "id": "contactcenterinsights.projects.locations.conversations.analyses.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/analyses/[^/]+$", "description": "Required. The name of the analysis to delete.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE" } } }, "assessments": { "methods": { "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to delete.", "location": "path", "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.", "type": "boolean", "location": "query" } }, "id": "contactcenterinsights.projects.locations.conversations.assessments.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete an Assessment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "publish": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the assessment to publish.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1PublishAssessmentRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Publish an Assessment.", "id": "contactcenterinsights.projects.locations.conversations.assessments.publish", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:publish" }, "finalize": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Finalize an Assessment.", "id": "contactcenterinsights.projects.locations.conversations.assessments.finalize", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:finalize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the assessment to finalize.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FinalizeAssessmentRequest" } }, "list": { "path": "v1alpha1/{+parent}/assessments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.assessments.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAssessmentsResponse" }, "description": "List Assessments.", "httpMethod": "GET", "parameters": { "pageSize": { "description": "The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character." } } }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the assessment.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/assessments", "id": "contactcenterinsights.projects.locations.conversations.assessments.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Create Assessment." }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the assessment to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.conversations.assessments.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Get Assessment." }, "appeal": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The name of the assessment to appeal." } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1AppealAssessmentRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Assessment" }, "description": "Appeal an Assessment.", "id": "contactcenterinsights.projects.locations.conversations.assessments.appeal", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:appeal" } }, "resources": { "notes": { "methods": { "list": { "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListNotesResponse" }, "description": "List Notes.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/notes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource of the notes.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "required": true, "type": "string", "location": "path" }, "pageSize": { "location": "query", "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.", "type": "integer" }, "pageToken": { "description": "Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.", "type": "string", "location": "query" } } }, "patch": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`", "type": "string" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Update Note.", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.patch", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$", "description": "Required. The parent resource of the note." } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Note" }, "description": "Create Note.", "path": "v1alpha1/{+parent}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Note.", "id": "contactcenterinsights.projects.locations.conversations.assessments.notes.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the note to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "DELETE" } } } } }, "segments": { "methods": { "bulkAnalyze": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/segments:bulkAnalyze", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Analyzes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource to create analyses in." } }, "httpMethod": "POST" } } }, "feedbackLabels": { "methods": { "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.delete", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the feedback label to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "httpMethod": "DELETE" }, "list": { "httpMethod": "GET", "parameters": { "pageSize": { "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "location": "path", "type": "string", "required": true }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" } }, "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "description": "List feedback labels.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels" }, "create": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "POST", "parameters": { "feedbackLabelId": { "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the feedback label.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label." }, "get": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the feedback label to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Get feedback label.", "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.get", "parameterOrder": [ "name" ] }, "patch": { "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "type": "string" }, "name": { "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "id": "contactcenterinsights.projects.locations.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } } }, "methods": { "bulkAnalyze": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource to create analyses in.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Analyzes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.conversations.bulkAnalyze", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:bulkAnalyze" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a conversation.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to delete.", "location": "path", "type": "string", "required": true }, "force": { "location": "query", "description": "If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.", "type": "boolean" } } }, "sample": { "path": "v1alpha1/{+parent}/conversations:sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:sample", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "id": "contactcenterinsights.projects.locations.conversations.sample", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset." } }, "httpMethod": "POST" }, "bulkDelete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:bulkDelete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.conversations.bulkDelete", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "parameters": { "parent": { "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST" }, "upload": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest" }, "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:upload", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:upload", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.", "id": "contactcenterinsights.projects.locations.conversations.upload", "parameterOrder": [ "parent" ] }, "list": { "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversation.", "location": "path", "type": "string", "required": true }, "pageSize": { "format": "int32", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query" }, "pageToken": { "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string", "location": "query" }, "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" } }, "id": "contactcenterinsights.projects.locations.conversations.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "description": "Lists conversations.", "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "location": "path", "required": true, "type": "string" }, "allowMissing": { "description": "Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored.", "type": "boolean", "location": "query" }, "conversationAutoLabelingUpdateConfig.allowAutoLabelingUpdate": { "location": "query", "description": "Optional. If set to true, the conversation will be updated with auto labeling results.", "type": "boolean" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings`", "type": "string" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Updates a conversation.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "ingest": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource for new conversations.", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:ingest", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Imports conversations and processes them according to the user's configuration.", "id": "contactcenterinsights.projects.locations.conversations.ingest", "parameterOrder": [ "parent" ] }, "generateSignedAudio": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to sign.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:generateSignedAudio", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "description": "Gets the signed URI for the audio for the given conversation.", "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", "parameterOrder": [ "name" ] }, "calculateStats": { "httpMethod": "GET", "parameters": { "location": { "type": "string", "required": true, "location": "path", "description": "Required. The location of the conversations.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", "type": "string", "location": "query" } }, "path": "v1alpha1/{+location}/conversations:calculateStats", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.conversations.calculateStats", "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "description": "Gets conversation statistics." }, "create": { "httpMethod": "POST", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource of the conversation.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "conversationId": { "description": "A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`", "type": "string", "location": "query" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "id": "contactcenterinsights.projects.locations.conversations.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations", "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" ], "path": "v1alpha1/{+parent}/conversations" }, "get": { "parameters": { "name": { "description": "Required. The name of the conversation to get.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "required": true, "type": "string", "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`." } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "id": "contactcenterinsights.projects.locations.conversations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" } } }, "views": { "methods": { "create": { "id": "contactcenterinsights.projects.locations.views.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "Creates a view.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/views", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the view. Required. The location to create a view for. Format: `projects//locations/` or `projects//locations/`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the view to get.", "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "type": "string", "required": true, "location": "path" } }, "id": "contactcenterinsights.projects.locations.views.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "Gets a view.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "parameters": { "updateMask": { "format": "google-fieldmask", "description": "The list of fields to be updated.", "type": "string", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "description": "Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view}", "location": "path", "required": true, "type": "string" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1View" }, "description": "Updates a view.", "id": "contactcenterinsights.projects.locations.views.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.views.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a view.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/views/[^/]+$", "description": "Required. The name of the view to delete.", "location": "path", "required": true, "type": "string" } } }, "list": { "id": "contactcenterinsights.projects.locations.views.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/views", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListViewsResponse" }, "description": "Lists views.", "path": "v1alpha1/{+parent}/views", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the views.", "location": "path", "type": "string", "required": true }, "pageSize": { "format": "int32", "description": "The maximum number of views to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer", "location": "query" }, "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.", "type": "string", "location": "query" } } } } }, "datasets": { "resources": { "conversations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.datasets.conversations.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Conversation" }, "description": "Gets a conversation.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to get.", "location": "path", "type": "string", "required": true }, "view": { "description": "The level of details of the conversation. Default is `FULL`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ] } } }, "ingest": { "parameters": { "parent": { "description": "Required. The parent resource for new conversations.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Imports conversations and processes them according to the user's configuration.", "id": "contactcenterinsights.projects.locations.datasets.conversations.ingest", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:ingest" }, "generateSignedAudio": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to sign." } }, "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerateConversationSignedAudioResponse" }, "description": "Gets the signed URI for the audio for the given conversation.", "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:generateSignedAudio", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bulkDelete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/conversations:bulkDelete", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes multiple conversations in a single request.", "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest" }, "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}" } }, "httpMethod": "POST" }, "calculateStats": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+location}/conversations:calculateStats", "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsResponse" }, "description": "Gets conversation statistics.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CalculateStatsRequest" }, "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location of the conversations.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "delete": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a conversation.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The name of the conversation to delete.", "location": "path", "required": true, "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", "location": "query" } } }, "sample": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource of the dataset.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Samples conversations based on user configuration and handles the sampled conversations for different use cases.", "id": "contactcenterinsights.projects.locations.datasets.conversations.sample", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations:sample", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListConversationsResponse" }, "description": "Lists conversations.", "id": "contactcenterinsights.projects.locations.datasets.conversations.list", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource of the conversation." }, "pageSize": { "format": "int32", "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", "type": "string" }, "orderBy": { "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", "type": "string", "location": "query" }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", "type": "string", "location": "query" }, "view": { "description": "The level of details of the conversation. Default is `BASIC`.", "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", "BASIC" ], "type": "string", "location": "query", "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", "Populates all fields in the conversation except the transcript." ] } }, "httpMethod": "GET" } }, "resources": { "feedbackLabels": { "methods": { "create": { "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Create feedback label.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/feedbackLabels", "httpMethod": "POST", "parameters": { "feedbackLabelId": { "location": "query", "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", "type": "string" }, "parent": { "description": "Required. The parent resource of the feedback label.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" } }, "get": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Get feedback label.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Required. The name of the feedback label to get.", "location": "path", "required": true, "type": "string" } } }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "description": "Required. The list of fields to be updated.", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}" } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel" }, "description": "Update feedback label." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the feedback label to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", "required": true, "type": "string", "location": "path" } }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Delete feedback label.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", "description": "Required. The parent resource of the feedback labels.", "location": "path", "type": "string", "required": true }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" } }, "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse" }, "description": "List feedback labels.", "path": "v1alpha1/{+parent}/feedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "insightsdata": { "methods": { "export": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/insightsdata:export", "id": "contactcenterinsights.projects.locations.datasets.insightsdata.export", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Export insights data to a destination defined in the request body.", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource to export data from.", "location": "path", "type": "string", "required": true } } } } } }, "methods": { "listAllFeedbackLabels": { "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "description": "List all feedback labels by project number.", "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource of all feedback labels per project.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "location": "path" }, "filter": { "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string", "location": "query" } }, "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The name of the dataset to delete." } }, "id": "contactcenterinsights.projects.locations.datasets.delete", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete a dataset.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}" }, "bulkDeleteFeedbackLabels": { "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource for new feedback labels." } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete feedback labels in bulk using a filter.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/datasets", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "description": "Creates a dataset.", "id": "contactcenterinsights.projects.locations.datasets.create", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the dataset.", "location": "path", "required": true, "type": "string" }, "datasetId": { "location": "query", "description": "Optional. The ID to use for the dataset.", "type": "string" } }, "httpMethod": "POST" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "description": "Gets a dataset.", "id": "contactcenterinsights.projects.locations.datasets.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the dataset to get.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET" }, "patch": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}" }, "updateMask": { "description": "Optional. The list of fields to update.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.patch", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset" }, "description": "Updates a dataset." }, "list": { "id": "contactcenterinsights.projects.locations.datasets.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListDatasetsResponse" }, "description": "List datasets matching the input.", "path": "v1alpha1/{+parent}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", "type": "integer" }, "pageToken": { "description": "Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of the dataset.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "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`", "type": "string", "location": "query" } } }, "bulkUploadFeedbackLabels": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" } }, "bulkDownloadFeedbackLabels": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The parent resource for new feedback labels." } }, "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies." } } } }, "methods": { "updateSettings": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings", "pattern": "^projects/[^/]+/locations/[^/]+/settings$" }, "updateMask": { "format": "google-fieldmask", "description": "Required. The list of fields to be updated.", "type": "string", "location": "query" } }, "httpMethod": "PATCH", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "description": "Updates project-level settings.", "id": "contactcenterinsights.projects.locations.updateSettings", "parameterOrder": [ "name" ] }, "listAllFeedbackLabels": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse" }, "description": "List all feedback labels by project number.", "id": "contactcenterinsights.projects.locations.listAllFeedbackLabels", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:listAllFeedbackLabels", "parameters": { "pageSize": { "format": "int32", "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", "type": "integer", "location": "query" }, "pageToken": { "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", "type": "string" }, "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The parent resource of all feedback labels per project.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "GET" }, "getCorrelationConfig": { "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "description": "Required. The name of the correlation config resource to get. Format: projects/{project}/locations/{location}/correlationConfig", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "id": "contactcenterinsights.projects.locations.getCorrelationConfig", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "description": "Gets correlation config." }, "getSettings": { "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.getSettings", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/settings", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1Settings" }, "description": "Gets project-level settings.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the settings resource to get.", "pattern": "^projects/[^/]+/locations/[^/]+/settings$" } } }, "bulkUploadFeedbackLabels": { "path": "v1alpha1/{+parent}:bulkUploadFeedbackLabels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkUploadFeedbackLabelsRequest" }, "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST" }, "bulkDownloadFeedbackLabels": { "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDownloadFeedbackLabelsRequest" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDownloadFeedbackLabels" }, "queryPerformanceOverview": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the conversations to derive performance stats from. \"projects/{project}/locations/{location}\"", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "path": "v1alpha1/{+parent}:queryPerformanceOverview", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.", "id": "contactcenterinsights.projects.locations.queryPerformanceOverview", "parameterOrder": [ "parent" ] }, "generativeInsights": { "id": "contactcenterinsights.projects.locations.generativeInsights", "parameterOrder": [ "location" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generativeInsights", "response": { "$ref": "GoogleLongrunningOperation" }, "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" ], "path": "v1alpha1/{+location}:generativeInsights", "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1GenerativeInsightsRequest" } }, "bulkDeleteFeedbackLabels": { "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource for new feedback labels.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest" }, "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete feedback labels in bulk using a filter.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}:bulkDeleteFeedbackLabels" }, "updateCorrelationConfig": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "parameters": { "updateMask": { "description": "Optional. The list of fields to be updated.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "description": "Immutable. Identifier. The resource name of the correlation config. Format: projects/{project}/locations/{location}/correlationConfig", "pattern": "^projects/[^/]+/locations/[^/]+/correlationConfig$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/correlationConfig", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1CorrelationConfig" }, "description": "Updates correlation config.", "id": "contactcenterinsights.projects.locations.updateCorrelationConfig", "parameterOrder": [ "name" ] }, "getEncryptionSpec": { "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", "description": "Required. The name of the encryption spec resource to get.", "location": "path", "required": true, "type": "string" } }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "contactcenterinsights.projects.locations.getEncryptionSpec", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", "response": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec" }, "description": "Gets location-level encryption key specification." }, "testCorrelationConfig": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:testCorrelationConfig", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Tests correlation config on a conversation.", "id": "contactcenterinsights.projects.locations.testCorrelationConfig", "parameterOrder": [ "location" ], "path": "v1alpha1/{+location}:testCorrelationConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "location": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location to test correlation config. Format: projects/{project}/locations/{location}" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1TestCorrelationConfigRequest" } }, "queryMetrics": { "request": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsRequest" }, "parameters": { "location": { "type": "string", "required": true, "location": "path", "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+location}:queryMetrics", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:queryMetrics", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Query metrics.", "id": "contactcenterinsights.projects.locations.queryMetrics", "parameterOrder": [ "location" ] } } } } } }, "fullyEncodeReservedExpansion": true, "name": "contactcenterinsights", "basePath": "", "batchPath": "batch", "kind": "discovery#restDescription", "discoveryVersion": "v1", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "ownerName": "Google", "canonicalName": "Contactcenterinsights", "version": "v1alpha1", "revision": "20260612", "parameters": { "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string", "enum": [ "json", "media", "proto" ], "description": "Data format for response.", "default": "json" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." } }, "mtlsRootUrl": "https://contactcenterinsights.mtls.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "documentationLink": "https://cloud.google.com/contact-center/insights/docs" }