Package types (1.22.0)

API documentation for contact_center_insights_v1.types package.

Classes

AnalysisResult

The result of an analysis.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnnotationBoundary

A point in a conversation that marks the start or the end of an annotation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AnnotatorSelector

Selector of all available annotators and phrase matchers to run.

AnswerFeedback

The feedback that the customer has about a certain answer in the conversation.

ArticleSuggestionData

Agent Assist Article Suggestion data.

BulkAnalyzeConversationsMetadata

The metadata for a bulk analyze conversations operation.

BulkAnalyzeConversationsRequest

The request to analyze conversations in bulk.

BulkAnalyzeConversationsResponse

The response for a bulk analyze conversations operation.

BulkDeleteConversationsMetadata

The metadata for a bulk delete conversations operation.

BulkDeleteConversationsRequest

The request to delete conversations in bulk.

BulkDeleteConversationsResponse

The response for a bulk delete conversations operation.

BulkDownloadFeedbackLabelsMetadata

Metadata for the BulkDownloadFeedbackLabel endpoint.

BulkDownloadFeedbackLabelsRequest

Request for the BulkDownloadFeedbackLabel endpoint.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BulkDownloadFeedbackLabelsResponse

Response for the BulkDownloadFeedbackLabel endpoint.

BulkUploadFeedbackLabelsMetadata

Metadata for the Bulk Upload Feedback Labels API.

BulkUploadFeedbackLabelsRequest

The request for bulk uploading feedback labels.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BulkUploadFeedbackLabelsResponse

Response for the Bulk Upload Feedback Labels API.

CalculateIssueModelStatsRequest

Request to get statistics of an issue model.

CalculateIssueModelStatsResponse

Response of querying an issue model's statistics.

CalculateStatsRequest

The request for calculating conversation statistics.

CalculateStatsResponse

The response for calculating conversation statistics.

CallAnnotation

A piece of metadata that applies to a window of a call.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Conversation

The conversation resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConversationDataSource

The conversation source, which is a combination of transcript and audio.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConversationLevelSentiment

One channel of conversation-level sentiment data.

ConversationLevelSilence

Conversation-level silence data.

ConversationParticipant

The call participant speaking for a given utterance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConversationSummarizationSuggestionData

Conversation summarization suggestion data.

ConversationView

Represents the options for viewing a conversation.

    -  Defaults to `FULL` in `GetConversationRequest`.
    -  Defaults to `BASIC` in `ListConversationsRequest`.
FULL (2):
    Populates all fields in the conversation.
BASIC (1):
    Populates all fields in the conversation
    except the transcript.

CreateAnalysisOperationMetadata

Metadata for a create analysis operation.

CreateAnalysisRequest

The request to create an analysis.

CreateAnalysisRuleRequest

The request to create a analysis rule. analysis_rule_id will be generated by the server.

CreateConversationRequest

Request to create a conversation.

CreateFeedbackLabelRequest

The request for creating a feedback label.

CreateIssueModelMetadata

Metadata for creating an issue model.

CreateIssueModelRequest

The request to create an issue model.

CreatePhraseMatcherRequest

Request to create a phrase matcher.

CreateQaQuestionRequest

The request for creating a QaQuestion.

CreateQaScorecardRequest

The request for creating a QaScorecard.

CreateQaScorecardRevisionRequest

The request for creating a QaScorecardRevision.

CreateViewRequest

The request to create a view.

DatasetValidationWarning

Enum for the different types of issues a tuning dataset can have. These warnings are currentlyraised when trying to validate a dataset for tuning a scorecard.

DeleteAnalysisRequest

The request to delete an analysis.

DeleteAnalysisRuleRequest

The request to delete a analysis rule.

DeleteConversationRequest

The request to delete a conversation.

DeleteFeedbackLabelRequest

The request for deleting a feedback label.

DeleteIssueModelMetadata

Metadata for deleting an issue model.

DeleteIssueModelRequest

The request to delete an issue model.

DeleteIssueRequest

The request to delete an issue.

DeletePhraseMatcherRequest

The request to delete a phrase matcher.

DeleteQaQuestionRequest

The request for deleting a QaQuestion.

DeleteQaScorecardRequest

The request for deleting a QaScorecard.

DeleteQaScorecardRevisionRequest

The request to delete a QaScorecardRevision.

DeleteViewRequest

The request to delete a view.

DeployIssueModelMetadata

Metadata for deploying an issue model.

DeployIssueModelRequest

The request to deploy an issue model.

DeployIssueModelResponse

The response to deploy an issue model.

DeployQaScorecardRevisionRequest

The request to deploy a QaScorecardRevision

DialogflowIntent

The data for a Dialogflow intent. Represents a detected intent in the conversation, e.g. MAKES_PROMISE.

DialogflowInteractionData

Dialogflow interaction data.

DialogflowSource

A Dialogflow source of conversation data.

Dimension

A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EncryptionSpec

A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).

Entity

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.

EntityMentionData

The data for an entity mention annotation. This represents a mention of an Entity in the conversation.

ExactMatchConfig

Exact match configuration.

ExportInsightsDataMetadata

Metadata for an export insights operation.

ExportInsightsDataRequest

The request to export insights.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportInsightsDataResponse

Response for an export insights operation.

ExportIssueModelMetadata

Metadata used for export issue model.

ExportIssueModelRequest

Request to export an issue model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportIssueModelResponse

Response from export issue model

FaqAnswerData

Agent Assist frequently-asked-question answer data.

FeedbackLabel

Represents a conversation, resource, and label provided by the user.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GcsSource

A Cloud Storage source of conversation data.

GetAnalysisRequest

The request to get an analysis.

GetAnalysisRuleRequest

The request for getting a analysis rule.

GetConversationRequest

The request to get a conversation.

GetEncryptionSpecRequest

The request to get location-level encryption specification.

GetFeedbackLabelRequest

The request for getting a feedback label.

GetIssueModelRequest

The request to get an issue model.

GetIssueRequest

The request to get an issue.

GetPhraseMatcherRequest

The request to get a a phrase matcher.

GetQaQuestionRequest

The request for a QaQuestion.

GetQaScorecardRequest

The request for a QaScorecard. By default, returns the latest revision.

GetQaScorecardRevisionRequest

The request for a QaScorecardRevision.

GetSettingsRequest

The request to get project-level settings.

GetViewRequest

The request to get a view.

HoldData

The data for a hold annotation.

ImportIssueModelMetadata

Metadata used for import issue model.

ImportIssueModelRequest

Request to import an issue model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportIssueModelResponse

Response from import issue model

IngestConversationsMetadata

The metadata for an IngestConversations operation.

IngestConversationsRequest

The request to ingest conversations.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IngestConversationsResponse

The response to an IngestConversations operation.

InitializeEncryptionSpecMetadata

Metadata for initializing a location-level encryption specification.

InitializeEncryptionSpecRequest

The request to initialize a location-level encryption specification.

InitializeEncryptionSpecResponse

The response to initialize a location-level encryption specification.

Intent

The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.

IntentMatchData

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.

InterruptionData

The data for an interruption annotation.

Issue

The issue resource.

IssueAssignment

Information about the issue.

IssueMatchData

The data for an issue match annotation.

IssueModel

The issue model resource.

IssueModelLabelStats

Aggregated statistics about an issue model.

IssueModelResult

Issue Modeling result on a conversation.

ListAllFeedbackLabelsRequest

The request for listing all feedback labels.

ListAllFeedbackLabelsResponse

The response for listing all feedback labels.

ListAnalysesRequest

The request to list analyses.

ListAnalysesResponse

The response to list analyses.

ListAnalysisRulesRequest

The request to list analysis rules.

ListAnalysisRulesResponse

The response of listing views.

ListConversationsRequest

Request to list conversations.

ListConversationsResponse

The response of listing conversations.

ListFeedbackLabelsRequest

The request for listing feedback labels.

ListFeedbackLabelsResponse

The response for listing feedback labels.

ListIssueModelsRequest

Request to list issue models.

ListIssueModelsResponse

The response of listing issue models.

ListIssuesRequest

Request to list issues.

ListIssuesResponse

The response of listing issues.

ListPhraseMatchersRequest

Request to list phrase matchers.

ListPhraseMatchersResponse

The response of listing phrase matchers.

ListQaQuestionsRequest

Request to list QaQuestions.

ListQaQuestionsResponse

The response from a ListQaQuestions request.

ListQaScorecardRevisionsRequest

Request to list QaScorecardRevisions

ListQaScorecardRevisionsResponse

The response from a ListQaScorecardRevisions request.

ListQaScorecardsRequest

Request to list QaScorecards.

ListQaScorecardsResponse

The response from a ListQaScorecards request.

ListViewsRequest

The request to list views.

ListViewsResponse

The response of listing views.

PhraseMatchData

The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match.

PhraseMatchRule

The data for a phrase match rule.

PhraseMatchRuleConfig

Configuration information of a phrase match rule.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PhraseMatchRuleGroup

A message representing a rule in the phrase matcher.

PhraseMatcher

The phrase matcher resource.

QaAnswer

An answer to a QaQuestion.

QaQuestion

A single question to be scored by the Insights QA feature.

QaScorecard

A QaScorecard represents a collection of questions to be scored during analysis.

QaScorecardResult

The results of scoring a single conversation against a QaScorecard. Contains a collection of QaAnswers and aggregate score.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

QaScorecardRevision

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.

QueryMetricsMetadata

The metadata from querying metrics.

QueryMetricsRequest

The request for querying metrics.

QueryMetricsResponse

The response for querying metrics.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RedactionConfig

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.

RuntimeAnnotation

An annotation that was generated during the customer and agent interaction.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SentimentData

The data for a sentiment annotation.

Settings

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 withupdateSettings` <https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings>__.

SilenceData

The data for a silence annotation.

SmartComposeSuggestionData

Agent Assist Smart Compose suggestion data.

SmartReplyData

Agent Assist Smart Reply data.

SpeechConfig

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.