Package Classes (1.20.0)

An API that lets users analyze and explore their business conversation data.

An API that lets users analyze and explore their business conversation data.

A pager for iterating through list_all_feedback_labels requests.

This class thinly wraps an initial ListAllFeedbackLabelsResponse object, and provides an __aiter__ method to iterate through its feedback_labels field.

If there are more pages, the __aiter__ method will make additional ListAllFeedbackLabels requests and continue to iterate through the feedback_labels field on the corresponding responses.

All the usual ListAllFeedbackLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_all_feedback_labels requests.

This class thinly wraps an initial ListAllFeedbackLabelsResponse object, and provides an __iter__ method to iterate through its feedback_labels field.

If there are more pages, the __iter__ method will make additional ListAllFeedbackLabels requests and continue to iterate through the feedback_labels field on the corresponding responses.

All the usual ListAllFeedbackLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __aiter__ method to iterate through its analyses field.

If there are more pages, the __aiter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __iter__ method to iterate through its analyses field.

If there are more pages, the __iter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_analysis_rules requests.

This class thinly wraps an initial ListAnalysisRulesResponse object, and provides an __aiter__ method to iterate through its analysis_rules field.

If there are more pages, the __aiter__ method will make additional ListAnalysisRules requests and continue to iterate through the analysis_rules field on the corresponding responses.

All the usual ListAnalysisRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_analysis_rules requests.

This class thinly wraps an initial ListAnalysisRulesResponse object, and provides an __iter__ method to iterate through its analysis_rules field.

If there are more pages, the __iter__ method will make additional ListAnalysisRules requests and continue to iterate through the analysis_rules field on the corresponding responses.

All the usual ListAnalysisRulesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __aiter__ method to iterate through its conversations field.

If there are more pages, the __aiter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __iter__ method to iterate through its conversations field.

If there are more pages, the __iter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_feedback_labels requests.

This class thinly wraps an initial ListFeedbackLabelsResponse object, and provides an __aiter__ method to iterate through its feedback_labels field.

If there are more pages, the __aiter__ method will make additional ListFeedbackLabels requests and continue to iterate through the feedback_labels field on the corresponding responses.

All the usual ListFeedbackLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_feedback_labels requests.

This class thinly wraps an initial ListFeedbackLabelsResponse object, and provides an __iter__ method to iterate through its feedback_labels field.

If there are more pages, the __iter__ method will make additional ListFeedbackLabels requests and continue to iterate through the feedback_labels field on the corresponding responses.

All the usual ListFeedbackLabelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_phrase_matchers requests.

This class thinly wraps an initial ListPhraseMatchersResponse object, and provides an __aiter__ method to iterate through its phrase_matchers field.

If there are more pages, the __aiter__ method will make additional ListPhraseMatchers requests and continue to iterate through the phrase_matchers field on the corresponding responses.

All the usual ListPhraseMatchersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_phrase_matchers requests.

This class thinly wraps an initial ListPhraseMatchersResponse object, and provides an __iter__ method to iterate through its phrase_matchers field.

If there are more pages, the __iter__ method will make additional ListPhraseMatchers requests and continue to iterate through the phrase_matchers field on the corresponding responses.

All the usual ListPhraseMatchersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_questions requests.

This class thinly wraps an initial ListQaQuestionsResponse object, and provides an __aiter__ method to iterate through its qa_questions field.

If there are more pages, the __aiter__ method will make additional ListQaQuestions requests and continue to iterate through the qa_questions field on the corresponding responses.

All the usual ListQaQuestionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_questions requests.

This class thinly wraps an initial ListQaQuestionsResponse object, and provides an __iter__ method to iterate through its qa_questions field.

If there are more pages, the __iter__ method will make additional ListQaQuestions requests and continue to iterate through the qa_questions field on the corresponding responses.

All the usual ListQaQuestionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_scorecard_revisions requests.

This class thinly wraps an initial ListQaScorecardRevisionsResponse object, and provides an __aiter__ method to iterate through its qa_scorecard_revisions field.

If there are more pages, the __aiter__ method will make additional ListQaScorecardRevisions requests and continue to iterate through the qa_scorecard_revisions field on the corresponding responses.

All the usual ListQaScorecardRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_scorecard_revisions requests.

This class thinly wraps an initial ListQaScorecardRevisionsResponse object, and provides an __iter__ method to iterate through its qa_scorecard_revisions field.

If there are more pages, the __iter__ method will make additional ListQaScorecardRevisions requests and continue to iterate through the qa_scorecard_revisions field on the corresponding responses.

All the usual ListQaScorecardRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_scorecards requests.

This class thinly wraps an initial ListQaScorecardsResponse object, and provides an __aiter__ method to iterate through its qa_scorecards field.

If there are more pages, the __aiter__ method will make additional ListQaScorecards requests and continue to iterate through the qa_scorecards field on the corresponding responses.

All the usual ListQaScorecardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_qa_scorecards requests.

This class thinly wraps an initial ListQaScorecardsResponse object, and provides an __iter__ method to iterate through its qa_scorecards field.

If there are more pages, the __iter__ method will make additional ListQaScorecards requests and continue to iterate through the qa_scorecards field on the corresponding responses.

All the usual ListQaScorecardsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_views requests.

This class thinly wraps an initial ListViewsResponse object, and provides an __aiter__ method to iterate through its views field.

If there are more pages, the __aiter__ method will make additional ListViews requests and continue to iterate through the views field on the corresponding responses.

All the usual ListViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_views requests.

This class thinly wraps an initial ListViewsResponse object, and provides an __iter__ method to iterate through its views field.

If there are more pages, the __iter__ method will make additional ListViews requests and continue to iterate through the views field on the corresponding responses.

All the usual ListViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

The analysis resource.

The result of an analysis.

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

Call-specific metadata created during analysis.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

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

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

Selector of all available annotators and phrase matchers to run.

Configuration for the QA feature.

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

Container for a list of scorecards.

Configuration for summarization.

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

Summarization model to use, if conversation_profile is not used.

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

The correctness level of an answer.

Agent Assist Article Suggestion data.

The abstract base class for a message.

The metadata for a bulk analyze conversations operation.

The request to analyze conversations in bulk.

The response for a bulk analyze conversations operation.

The metadata for a bulk delete conversations operation.

The request to delete conversations in bulk.

The response for a bulk delete conversations operation.

Metadata for the BulkDownloadFeedbackLabel endpoint.

Statistics for BulkDownloadFeedbackLabels operation.

Request for the BulkDownloadFeedbackLabel endpoint.

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

Possible feedback label types that will be downloaded.

Google Cloud Storage Object details to write the feedback labels to.

All permissible file formats. See records_per_file_count to override the default number of records per file.

Response for the BulkDownloadFeedbackLabel endpoint.

Metadata for the Bulk Upload Feedback Labels API.

Statistics for BulkUploadFeedbackLabels operation.

The request for bulk uploading feedback labels.

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

Google Cloud Storage Object details to get the feedback label file from.

All permissible file formats.

Response for the Bulk Upload Feedback Labels API.

Request to get statistics of an issue model.

Response of querying an issue model's statistics.

The request for calculating conversation statistics.

The response for calculating conversation statistics.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

A time series representing conversations over time.

A single interval in a time series.

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

The conversation resource.

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

Call-specific metadata.

The abstract base class for a message.

The abstract base class for a message.

Possible media for the conversation.

Conversation metadata related to quality management.

Information about an agent involved in the conversation.

A message representing the transcript of a conversation.

A segment of a full transcript.

Metadata from Dialogflow relating to the current transcript segment.

Word-level info for words in a transcript.

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

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

One channel of conversation-level sentiment data.

Conversation-level silence data.

The call participant speaking for a given utterance.

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

The role of the participant.

Conversation summarization suggestion data.

The abstract base class for a message.

The abstract base class for a message.

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.

Metadata for a create analysis operation.

The request to create an analysis.

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

Request to create a conversation.

The request for creating a feedback label.

Metadata for creating an issue model.

The request to create an issue model.

Request to create a phrase matcher.

The request for creating a QaQuestion.

The request for creating a QaScorecard.

The request for creating a QaScorecardRevision.

The request to create a view.

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.

The request to delete an analysis.

The request to delete a analysis rule.

The request to delete a conversation.

The request for deleting a feedback label.

Metadata for deleting an issue model.

The request to delete an issue model.

The request to delete an issue.

The request to delete a phrase matcher.

The request for deleting a QaQuestion.

The request for deleting a QaScorecard.

The request to delete a QaScorecardRevision.

The request to delete a view.

Metadata for deploying an issue model.

The request to deploy an issue model.

The response to deploy an issue model.

The request to deploy a QaScorecardRevision

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

Dialogflow interaction data.

A Dialogflow source of conversation data.

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

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

Metadata about the agent dimension.

The key of the dimension.

Metadata about the issue dimension.

Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.

Metadata about the QA question dimension.

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

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.

The abstract base class for a message.

The type of the entity. For most entity types, the associated metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid). The table below lists the associated fields for entities that have different metadata.

    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 (10):
    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 (11):
    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 (12):
    Number.

    The metadata is the number itself.
PRICE (13):
    Price.

    The metadata identifies the `value` and `currency`.

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

The supported types of mentions.

Exact match configuration.

Metadata for an export insights operation.

The request to export insights.

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

A BigQuery Table Reference.

Specifies the action that occurs if the destination table already exists.

Response for an export insights operation.

Metadata used for export issue model.

Request to export an issue model.

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

Google Cloud Storage Object URI to save the issue model to.

Response from export issue model

Agent Assist frequently-asked-question answer data.

The abstract base class for a message.

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

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

A Cloud Storage source of conversation data.

The request to get an analysis.

The request for getting a analysis rule.

The request to get a conversation.

The request to get location-level encryption specification.

The request for getting a feedback label.

The request to get an issue model.

The request to get an issue.

The request to get a a phrase matcher.

The request for a QaQuestion.

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

The request for a QaScorecardRevision.

The request to get project-level settings.

The request to get a view.

The data for a hold annotation.

Metadata used for import issue model.

Request to import an issue model.

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

Google Cloud Storage Object URI to get the issue model file from.

Response from import issue model

The metadata for an IngestConversations operation.

Statistics for IngestConversations operation.

The request to ingest conversations.

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

Configuration that applies to all conversations.

Configuration for Cloud Storage bucket sources.

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

Configuration for processing transcript objects.

The response to an IngestConversations operation.

Metadata for initializing a location-level encryption specification.

The request to initialize a location-level encryption specification.

The response to initialize a location-level encryption specification.

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

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.

The data for an interruption annotation.

The issue resource.

Information about the issue.

The data for an issue match annotation.

The issue model resource.

Configs for the input data used to create the issue model.

Type of the model.

State of the model.

Aggregated statistics about an issue model.

Aggregated statistics about an issue.

The abstract base class for a message.

Issue Modeling result on a conversation.

The request for listing all feedback labels.

The response for listing all feedback labels.

The request to list analyses.

The response to list analyses.

The request to list analysis rules.

The response of listing views.

Request to list conversations.

The response of listing conversations.

The request for listing feedback labels.

The response for listing feedback labels.

Request to list issue models.

The response of listing issue models.

Request to list issues.

The response of listing issues.

Request to list phrase matchers.

The response of listing phrase matchers.

Request to list QaQuestions.

The response from a ListQaQuestions request.

Request to list QaScorecardRevisions

The response from a ListQaScorecardRevisions request.

Request to list QaScorecards.

The response from a ListQaScorecards request.

The request to list views.

The response of listing views.

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

The data for a phrase match rule.

Configuration information of a phrase match rule.

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

A message representing a rule in the phrase matcher.

Specifies how to combine each phrase match rule for whether there is a match.

The phrase matcher resource.

Specifies how to combine each phrase match rule group to determine whether there is a match.

An answer to a QaQuestion.

A question may have multiple answers from varying sources, one of which becomes the "main" answer above. AnswerSource represents each individual answer.

What created the answer.

Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question.

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

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

Message representing a possible answer to the question.

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

A wrapper representing metrics calculated against a test-set on a LLM that was fine tuned for this question.

Metadata about the tuning operation for the question. Will only be set if a scorecard containing this question has been tuned.

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

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

Tags and their corresponding results.

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

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.

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

What created the score.

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.

Enum representing the set of states a scorecard revision may be in.

The metadata from querying metrics.

The request for querying metrics.

A time granularity divides the time line into discrete time periods. This is useful for defining buckets over which filtering and aggregation should be performed.

The response for querying metrics.

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

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 -> dimensions=[Issue 1]
• Slice 2 -> dimensions=[Issue 2]

A data point contains the metric values mapped to an interval.

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

The measure related to conversations.

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

Average QA normalized score for the tag.

A time series of metric values.

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.

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

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

Explicit input used for generating the answer

The source of the query.

The data for a sentiment annotation.

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>__.

Default configuration when creating Analyses in Insights.

The abstract base class for a message.

The data for a silence annotation.

Agent Assist Smart Compose suggestion data.

The abstract base class for a message.

Agent Assist Smart Reply data.

The abstract base class for a message.

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.

Metadata for TuneQaScorecardRevision endpoint.

Contains performance metrics for each QaQuestion in the TuneScorecardRevision request.

Performance metrics for the question's dataset calculated over the tuned model.

Contains validation results for a question in the tuning request.

Request for TuneQaScorecardRevision endpoint.

Response for TuneQaScorecardRevision endpoint.

Metadata for undeploying an issue model.

The request to undeploy an issue model.

The response to undeploy an issue model.

The request to undeploy a QaScorecardRevision

The request to update a analysis rule.

The request to update a conversation.

The request for updating a feedback label.

The request to update an issue model.

The request to update an issue.

The request to update a phrase matcher.

The request for updating a QaQuestion.

The request for updating a QaScorecard.

The request to update project-level settings.

The request to update a view.

The metadata for an UploadConversation operation.

Request to upload a conversation.

The View resource.

API documentation for contact_center_insights_v1.services.contact_center_insights.pagers module.