ContactCenterInsightsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport] = 'grpc_asyncio', 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
ContactCenterInsightsAsyncClient
ContactCenterInsightsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport] = 'grpc_asyncio', 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,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The resource name of the issue model to query against. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The location of the conversations. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the analysis. This corresponds to the |
analysis |
Analysis
Required. The analysis to create. This corresponds to the |
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_async.AsyncOperation | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the conversation. This corresponds to the |
conversation |
Conversation
Required. The conversation resource to create. This corresponds to the |
conversation_id |
A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the issue model. This corresponds to the |
issue_model |
IssueModel
Required. The issue model to create. This corresponds to the |
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_async.AsyncOperation | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: |
phrase_matcher |
PhraseMatcher
Required. The phrase matcher resource to create. This corresponds to the |
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. |
create_view
create_view(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateViewRequest, dict]] = None, *, parent: Optional[str] = None, view: Optional[google.cloud.contact_center_insights_v1.types.resources.View] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a view.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contact_center_insights_v1.types.CreateViewRequest, dict]
The request object. The request to create a view. |
parent |
Required. The parent resource of the view. Required. The location to create a view for. Format: |
view |
View
Required. The view resource to create. This corresponds to the |
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.View | The View 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the analysis to delete. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the conversation to delete. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the issue model to delete. This corresponds to the |
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_async.AsyncOperation | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the phrase matcher to delete. This corresponds to the |
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_view
delete_view(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteViewRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a view.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contact_center_insights_v1.types.DeleteViewRequest, dict]
The request object. The request to delete a view. |
name |
Required. The name of the view to delete. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The issue model to deploy. This corresponds to the |
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_async.AsyncOperation | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource to export data from. This corresponds to the |
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_async.AsyncOperation | 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 |
ContactCenterInsightsAsyncClient | 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 |
ContactCenterInsightsAsyncClient | 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 |
ContactCenterInsightsAsyncClient | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the analysis to get. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the conversation to get. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the issue to get. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the issue model to get. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the phrase matcher to get. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The name of the settings resource to get. This corresponds to the |
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. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
get_view
get_view(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.GetViewRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a view.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contact_center_insights_v1.types.GetViewRequest, dict]
The request object. The request to get a view. |
name |
Required. The name of the view to get. This corresponds to the |
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.View | The View 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the analyses. This corresponds to the |
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.ListAnalysesAsyncPager | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the conversation. This corresponds to the |
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.ListConversationsAsyncPager | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the issue model. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the issue. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The parent resource of the phrase matcher. This corresponds to the |
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.ListPhraseMatchersAsyncPager | The response of listing phrase matchers. Iterating over this object will yield results and resolve additional pages automatically. |
list_views
list_views(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.ListViewsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists views.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contact_center_insights_v1.types.ListViewsRequest, dict]
The request object. The request to list views. |
parent |
Required. The parent resource of the views. This corresponds to the |
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.ListViewsAsyncPager | The response of listing views. 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.
parse_view_path
parse_view_path(path: str)
Parses a view 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Required. The issue model to undeploy. This corresponds to the |
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_async.AsyncOperation | 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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Conversation
Required. The new values for the conversation. This corresponds to the |
update_mask |
The list of fields to be updated. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Issue
Required. The new values for the issue. This corresponds to the |
update_mask |
The list of fields to be updated. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
IssueModel
Required. The new values for the issue model. This corresponds to the |
update_mask |
The list of fields to be updated. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
PhraseMatcher
Required. The new values for the phrase matcher. This corresponds to the |
update_mask |
The list of fields to be updated. This corresponds to the |
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, google.api_core.gapic_v1.method._MethodDefault] = <_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 |
Settings
Required. The new settings values. This corresponds to the |
update_mask |
Required. The list of fields to be updated. This corresponds to the |
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. |
update_view
update_view(request: Optional[Union[google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateViewRequest, dict]] = None, *, view: Optional[google.cloud.contact_center_insights_v1.types.resources.View] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a view.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contact_center_insights_v1.types.UpdateViewRequest, dict]
The request object. The request to update a view. |
view |
View
Required. The new view. This corresponds to the |
update_mask |
The list of fields to be updated. This corresponds to the |
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.View | The View resource. |
view_path
view_path(project: str, location: str, view: str)
Returns a fully-qualified view string.