Package Classes (1.19.1)

Summary of entries of Classes for contactcenterinsights.

Classes

ContactCenterInsightsAsyncClient

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

ContactCenterInsightsClient

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

ListAnalysesAsyncPager

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.

ListAnalysesPager

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.

ListConversationsAsyncPager

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.

ListConversationsPager

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.

ListPhraseMatchersAsyncPager

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.

ListPhraseMatchersPager

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.

ListViewsAsyncPager

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.

ListViewsPager

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.

AnalysisResult

The result of an analysis.

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

CallAnalysisMetadata

Call-specific metadata created during analysis.

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.

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

SummarizationModel

Summarization model to use, if conversation_profile is not used.

AnswerFeedback

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

CorrectnessLevel

The correctness level of an answer.

ArticleSuggestionData

Agent Assist Article Suggestion data.

MetadataEntry

The abstract base class for a message.

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.

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.

CustomHighlighterMatchesEntry

The abstract base class for a message.

IssueMatchesEntry

The abstract base class for a message.

IssueMatchesStatsEntry

The abstract base class for a message.

SmartHighlighterMatchesEntry

The abstract base class for a message.

TimeSeries

A time series representing conversations over time.

Interval

A single interval in a time series.

CallAnnotation

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

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

CallMetadata

Call-specific metadata.

DialogflowIntentsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

Medium

Possible media for the conversation.

QualityMetadata

Conversation metadata related to quality management.

AgentInfo

Information about an agent involved in the conversation.

Transcript

A message representing the transcript of a conversation.

TranscriptSegment

A segment of a full transcript.

DialogflowSegmentMetadata

Metadata from Dialogflow relating to the current transcript segment.

WordInfo

Word-level info for words in a transcript.

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

Role

The role of the participant.

ConversationSummarizationSuggestionData

Conversation summarization suggestion data.

MetadataEntry

The abstract base class for a message.

TextSectionsEntry

The abstract base class for a message.

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.

CreateConversationRequest

Request to create a conversation.

CreateIssueModelMetadata

Metadata for creating an issue model.

CreateIssueModelRequest

The request to create an issue model.

CreatePhraseMatcherRequest

Request to create a phrase matcher.

CreateViewRequest

The request to create a view.

DeleteAnalysisRequest

The request to delete an analysis.

DeleteConversationRequest

The request to delete a conversation.

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.

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.

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.

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.

MetadataEntry

The abstract base class for a message.

Type

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

EntityMentionData

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

MentionType

The supported types of mentions.

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

BigQueryDestination

A BigQuery Table Reference.

WriteDisposition

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

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

GcsDestination

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

ExportIssueModelResponse

Response from export issue model

FaqAnswerData

Agent Assist frequently-asked-question answer data.

MetadataEntry

The abstract base class for a message.

GcsSource

A Cloud Storage source of conversation data.

GetAnalysisRequest

The request to get an analysis.

GetConversationRequest

The request to get a conversation.

GetEncryptionSpecRequest

The request to get location-level encryption specification.

GetIssueModelRequest

The request to get an issue model.

GetIssueRequest

The request to get an issue.

GetPhraseMatcherRequest

The request to get a a phrase matcher.

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

GcsSource

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

ImportIssueModelResponse

Response from import issue model

IngestConversationsMetadata

The metadata for an IngestConversations operation.

IngestConversationsStats

Statistics for IngestConversations operation.

IngestConversationsRequest

The request to ingest conversations.

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

ConversationConfig

Configuration that applies to all conversations.

GcsSource

Configuration for Cloud Storage bucket sources.

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

BucketObjectType

TranscriptObjectConfig

Configuration for processing transcript objects.

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.

InputDataConfig

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

ModelType

Type of the model.

State

State of the model.

IssueModelLabelStats

Aggregated statistics about an issue model.

IssueStats

Aggregated statistics about an issue.

IssueStatsEntry

The abstract base class for a message.

IssueModelResult

Issue Modeling result on a conversation.

ListAnalysesRequest

The request to list analyses.

ListAnalysesResponse

The response to list analyses.

ListConversationsRequest

Request to list conversations.

ListConversationsResponse

The response of listing conversations.

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.

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.

PhraseMatchRuleGroupType

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

PhraseMatcher

The phrase matcher resource.

PhraseMatcherType

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

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

UserInput

Explicit input used for generating the answer

QuerySource

The source of the query.

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

AnalysisConfig

Default configuration when creating Analyses in Insights.

PubsubNotificationSettingsEntry

The abstract base class for a message.

SilenceData

The data for a silence annotation.

SmartComposeSuggestionData

Agent Assist Smart Compose suggestion data.

MetadataEntry

The abstract base class for a message.

SmartReplyData

Agent Assist Smart Reply data.

MetadataEntry

The abstract base class for a message.

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.

Modules

pagers

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