Class ContactCenterInsightsClient (1.1.0)

ContactCenterInsightsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`ContactCenterInsightsTransport`	The transport used by the client instance.

Methods

ContactCenterInsightsClient

ContactCenterInsightsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the contact center insights client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, ContactCenterInsightsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

analysis_path

analysis_path(project: str, location: str, conversation: str, analysis: str)

Returns a fully-qualified analysis string.

calculate_issue_model_stats

calculate_issue_model_stats(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateIssueModelStatsRequest, dict]] = None, *, issue_model: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an issue model's statistics.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CalculateIssueModelStatsRequest, dict]` The request object. Request to get statistics of an issue model.
`issue_model`	`str` Required. The resource name of the issue model to query against. This corresponds to the `issue_model` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.CalculateIssueModelStatsResponse`	Response of querying an issue model's statistics.

calculate_stats

calculate_stats(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateStatsRequest, dict]] = None, *, location: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets conversation statistics.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CalculateStatsRequest, dict]` The request object. The request for calculating conversation statistics.
`location`	`str` Required. The location of the conversations. This corresponds to the `location` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.CalculateStatsResponse`	The response for calculating conversation statistics.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

conversation_path

conversation_path(project: str, location: str, conversation: str)

Returns a fully-qualified conversation string.

create_analysis

create_analysis(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateAnalysisRequest, dict]] = None, *, parent: Optional[str] = None, analysis: Optional[google.cloud.contact_center_insights_v1.types.resources.Analysis] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an analysis. The long running operation is done when the analysis has completed.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CreateAnalysisRequest, dict]` The request object. The request to create an analysis.
`parent`	`str` Required. The parent resource of the analysis. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`analysis`	`google.cloud.contact_center_insights_v1.types.Analysis` Required. The analysis to create. This corresponds to the `analysis` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Analysis The analysis resource.

create_conversation

create_conversation(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateConversationRequest, dict]] = None, *, parent: Optional[str] = None, conversation: Optional[google.cloud.contact_center_insights_v1.types.resources.Conversation] = None, conversation_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a conversation.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CreateConversationRequest, dict]` The request object. Request to create a conversation.
`parent`	`str` Required. The parent resource of the conversation. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`conversation`	`google.cloud.contact_center_insights_v1.types.Conversation` Required. The conversation resource to create. This corresponds to the `conversation` field on the `request` instance; if `request` is provided, this should not be set.
`conversation_id`	`str` 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-32 characters and must match the regular expression /^[a-z0-9-]{4,32}$/. Valid characters are /`a-z][0-9]`-/ This corresponds to the `conversation_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Conversation`	The conversation resource.

create_issue_model

create_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateIssueModelRequest, dict]] = None, *, parent: Optional[str] = None, issue_model: Optional[google.cloud.contact_center_insights_v1.types.resources.IssueModel] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an issue model.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CreateIssueModelRequest, dict]` The request object. The request to create an issue model.
`parent`	`str` Required. The parent resource of the issue model. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`issue_model`	`google.cloud.contact_center_insights_v1.types.IssueModel` Required. The issue model to create. This corresponds to the `issue_model` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be IssueModel The issue model resource.

create_phrase_matcher

create_phrase_matcher(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CreatePhraseMatcherRequest, dict]] = None, *, parent: Optional[str] = None, phrase_matcher: Optional[google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a phrase matcher.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.CreatePhraseMatcherRequest, dict]` The request object. Request to create a phrase matcher.
`parent`	`str` Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects/` or `projects/` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`phrase_matcher`	`google.cloud.contact_center_insights_v1.types.PhraseMatcher` Required. The phrase matcher resource to create. This corresponds to the `phrase_matcher` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.PhraseMatcher`	The phrase matcher resource.

delete_analysis

delete_analysis(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteAnalysisRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an analysis.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.DeleteAnalysisRequest, dict]` The request object. The request to delete an analysis.
`name`	`str` Required. The name of the analysis to delete. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_conversation

delete_conversation(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteConversationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a conversation.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.DeleteConversationRequest, dict]` The request object. The request to delete a conversation.
`name`	`str` Required. The name of the conversation to delete. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_issue_model

delete_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteIssueModelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an issue model.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.DeleteIssueModelRequest, dict]` The request object. The request to delete an issue model.
`name`	`str` Required. The name of the issue model to delete. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); } The JSON representation for Empty is empty JSON object {}.

delete_phrase_matcher

delete_phrase_matcher(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeletePhraseMatcherRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a phrase matcher.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.DeletePhraseMatcherRequest, dict]` The request object. The request to delete a phrase matcher.
`name`	`str` Required. The name of the phrase matcher to delete. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

deploy_issue_model

deploy_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeployIssueModelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.DeployIssueModelRequest, dict]` The request object. The request to deploy an issue model.
`name`	`str` Required. The issue model to deploy. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DeployIssueModelResponse The response to deploy an issue model.

export_insights_data

export_insights_data(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ExportInsightsDataRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Export insights data to a destination defined in the request body.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ExportInsightsDataRequest, dict]` The request object. The request to export insights.
`parent`	`str` Required. The parent resource to export data from. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be ExportInsightsDataResponse Response for an export insights operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`ContactCenterInsightsClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`ContactCenterInsightsClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`ContactCenterInsightsClient`	The constructed client.

get_analysis

get_analysis(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetAnalysisRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an analysis.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetAnalysisRequest, dict]` The request object. The request to get an analysis.
`name`	`str` Required. The name of the analysis to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Analysis`	The analysis resource.

get_conversation

get_conversation(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetConversationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a conversation.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetConversationRequest, dict]` The request object. The request to get a conversation.
`name`	`str` Required. The name of the conversation to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Conversation`	The conversation resource.

get_issue

get_issue(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetIssueRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an issue.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetIssueRequest, dict]` The request object. The request to get an issue.
`name`	`str` Required. The name of the issue to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Issue`	The issue resource.

get_issue_model

get_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetIssueModelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an issue model.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetIssueModelRequest, dict]` The request object. The request to get an issue model.
`name`	`str` Required. The name of the issue model to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.IssueModel`	The issue model resource.

get_phrase_matcher

get_phrase_matcher(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetPhraseMatcherRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a phrase matcher.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetPhraseMatcherRequest, dict]` The request object. The request to get a a phrase matcher.
`name`	`str` Required. The name of the phrase matcher to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.PhraseMatcher`	The phrase matcher resource.

get_settings

get_settings(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets project-level settings.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.GetSettingsRequest, dict]` The request object. The request to get project-level settings.
`name`	`str` Required. The name of the settings resource to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Settings`	The settings resource.

issue_model_path

issue_model_path(project: str, location: str, issue_model: str)

Returns a fully-qualified issue_model string.

issue_path

issue_path(project: str, location: str, issue_model: str, issue: str)

Returns a fully-qualified issue string.

list_analyses

list_analyses(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListAnalysesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists analyses.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ListAnalysesRequest, dict]` The request object. The request to list analyses.
`parent`	`str` Required. The parent resource of the analyses. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListAnalysesPager`	The response to list analyses. Iterating over this object will yield results and resolve additional pages automatically.

list_conversations

list_conversations(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListConversationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists conversations.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ListConversationsRequest, dict]` The request object. Request to list conversations.
`parent`	`str` Required. The parent resource of the conversation. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListConversationsPager`	The response of listing conversations. Iterating over this object will yield results and resolve additional pages automatically.

list_issue_models

list_issue_models(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssueModelsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists issue models.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ListIssueModelsRequest, dict]` The request object. Request to list issue models.
`parent`	`str` Required. The parent resource of the issue model. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.ListIssueModelsResponse`	The response of listing issue models.

list_issues

list_issues(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssuesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists issues.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ListIssuesRequest, dict]` The request object. Request to list issues.
`parent`	`str` Required. The parent resource of the issue. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.ListIssuesResponse`	The response of listing issues.

list_phrase_matchers

list_phrase_matchers(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListPhraseMatchersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists phrase matchers.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.ListPhraseMatchersRequest, dict]` The request object. Request to list phrase matchers.
`parent`	`str` Required. The parent resource of the phrase matcher. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListPhraseMatchersPager`	The response of listing phrase matchers. Iterating over this object will yield results and resolve additional pages automatically.

parse_analysis_path

parse_analysis_path(path: str)

Parses a analysis path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_conversation_path

parse_conversation_path(path: str)

Parses a conversation path into its component segments.

parse_issue_model_path

parse_issue_model_path(path: str)

Parses a issue_model path into its component segments.

parse_issue_path

parse_issue_path(path: str)

Parses a issue path into its component segments.

parse_participant_path

parse_participant_path(path: str)

Parses a participant path into its component segments.

parse_phrase_matcher_path

parse_phrase_matcher_path(path: str)

Parses a phrase_matcher path into its component segments.

parse_settings_path

parse_settings_path(path: str)

Parses a settings path into its component segments.

participant_path

participant_path(project: str, conversation: str, participant: str)

Returns a fully-qualified participant string.

phrase_matcher_path

phrase_matcher_path(project: str, location: str, phrase_matcher: str)

Returns a fully-qualified phrase_matcher string.

settings_path

settings_path(project: str, location: str)

Returns a fully-qualified settings string.

undeploy_issue_model

undeploy_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UndeployIssueModelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UndeployIssueModelRequest, dict]` The request object. The request to undeploy an issue model.
`name`	`str` Required. The issue model to undeploy. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be UndeployIssueModelResponse The response to undeploy an issue model.

update_conversation

update_conversation(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateConversationRequest, dict]] = None, *, conversation: Optional[google.cloud.contact_center_insights_v1.types.resources.Conversation] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a conversation.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UpdateConversationRequest, dict]` The request object. The request to update a conversation.
`conversation`	`google.cloud.contact_center_insights_v1.types.Conversation` Required. The new values for the conversation. This corresponds to the `conversation` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Conversation`	The conversation resource.

update_issue

update_issue(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateIssueRequest, dict]] = None, *, issue: Optional[google.cloud.contact_center_insights_v1.types.resources.Issue] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an issue.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UpdateIssueRequest, dict]` The request object. The request to update an issue.
`issue`	`google.cloud.contact_center_insights_v1.types.Issue` Required. The new values for the issue. This corresponds to the `issue` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Issue`	The issue resource.

update_issue_model

update_issue_model(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateIssueModelRequest, dict]] = None, *, issue_model: Optional[google.cloud.contact_center_insights_v1.types.resources.IssueModel] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an issue model.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UpdateIssueModelRequest, dict]` The request object. The request to update an issue model.
`issue_model`	`google.cloud.contact_center_insights_v1.types.IssueModel` Required. The new values for the issue model. This corresponds to the `issue_model` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.IssueModel`	The issue model resource.

update_phrase_matcher

update_phrase_matcher(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdatePhraseMatcherRequest, dict]] = None, *, phrase_matcher: Optional[google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a phrase matcher.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UpdatePhraseMatcherRequest, dict]` The request object. The request to update a phrase matcher.
`phrase_matcher`	`google.cloud.contact_center_insights_v1.types.PhraseMatcher` Required. The new values for the phrase matcher. This corresponds to the `phrase_matcher` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.PhraseMatcher`	The phrase matcher resource.

update_settings

update_settings(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateSettingsRequest, dict]] = None, *, settings: Optional[google.cloud.contact_center_insights_v1.types.resources.Settings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates project-level settings.

Parameters
Name	Description
`request`	`Union[google.cloud.contact_center_insights_v1.types.UpdateSettingsRequest, dict]` The request object. The request to update project-level settings.
`settings`	`google.cloud.contact_center_insights_v1.types.Settings` Required. The new settings values. This corresponds to the `settings` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The list of fields to be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contact_center_insights_v1.types.Settings`	The settings resource.