ContactCenterInsightsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport, typing.Callable[[...], google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport]]] = 'grpc_asyncio', client_options: typing.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
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
ContactCenterInsightsTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
ContactCenterInsightsAsyncClient
ContactCenterInsightsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport, typing.Callable[[...], google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport]]] = 'grpc_asyncio', client_options: typing.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 async 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 |
Optional[Union[str,ContactCenterInsightsTransport,Callable[..., ContactCenterInsightsTransport]]]
The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ContactCenterInsightsTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
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 |
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) -> str
Returns a fully-qualified analysis string.
bulk_analyze_conversations
bulk_analyze_conversations(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.BulkAnalyzeConversationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
analysis_percentage: typing.Optional[float] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Analyzes multiple conversations in a single request.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_bulk_analyze_conversations():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.BulkAnalyzeConversationsRequest(
parent="parent_value",
filter="filter_value",
analysis_percentage=0.20170000000000002,
)
# Make the request
operation = client.bulk_analyze_conversations(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.BulkAnalyzeConversationsRequest, dict]]
The request object. The request to analyze conversations in bulk. |
parent |
Required. The parent resource to create analyses in. This corresponds to the |
filter |
Required. Filter used to select the subset of conversations to analyze. This corresponds to the |
analysis_percentage |
Required. Percentage of selected conversation to analyze, between [0, 100]. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 BulkAnalyzeConversationsResponse The response for a bulk analyze conversations operation. |
bulk_delete_conversations
bulk_delete_conversations(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.BulkDeleteConversationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes multiple conversations in a single request.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_bulk_delete_conversations():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.BulkDeleteConversationsRequest(
parent="parent_value",
)
# Make the request
operation = client.bulk_delete_conversations(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.BulkDeleteConversationsRequest, dict]]
The request object. The request to delete conversations in bulk. |
parent |
Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location} This corresponds to the |
filter |
Filter used to select the subset of conversations to delete. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 BulkDeleteConversationsResponse The response for a bulk delete conversations operation. |
calculate_issue_model_stats
calculate_issue_model_stats(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateIssueModelStatsRequest,
dict,
]
] = None,
*,
issue_model: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateIssueModelStatsResponse
)
Gets an issue model's statistics.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_calculate_issue_model_stats():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CalculateIssueModelStatsRequest(
issue_model="issue_model_value",
)
# Make the request
response = await client.calculate_issue_model_stats(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateStatsRequest,
dict,
]
] = None,
*,
location: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.types.contact_center_insights.CalculateStatsResponse
)
Gets conversation statistics.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_calculate_stats():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CalculateStatsRequest(
location="location_value",
)
# Make the request
response = await client.calculate_stats(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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. |
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
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. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
conversation_path
conversation_path(project: str, location: str, conversation: str) -> str
Returns a fully-qualified conversation string.
conversation_profile_path
conversation_profile_path(
project: str, location: str, conversation_profile: str
) -> str
Returns a fully-qualified conversation_profile string.
create_analysis
create_analysis(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateAnalysisRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
analysis: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.Analysis
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an analysis. The long running operation is done when the analysis has completed.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_create_analysis():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CreateAnalysisRequest(
parent="parent_value",
)
# Make the request
operation = client.create_analysis(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.Conversation
] = None,
conversation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Conversation
Creates a conversation. Note that this method does not support
audio transcription or redaction. Use conversations.upload
instead.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_create_conversation():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CreateConversationRequest(
parent="parent_value",
)
# Make the request
response = await client.create_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateIssueModelRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
issue_model: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.IssueModel
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an issue model.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_create_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CreateIssueModelRequest(
parent="parent_value",
)
# Make the request
operation = client.create_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CreatePhraseMatcherRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
phrase_matcher: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher
Creates a phrase matcher.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_create_phrase_matcher():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
phrase_matcher = contact_center_insights_v1.PhraseMatcher()
phrase_matcher.type_ = "ANY_OF"
request = contact_center_insights_v1.CreatePhraseMatcherRequest(
parent="parent_value",
phrase_matcher=phrase_matcher,
)
# Make the request
response = await client.create_phrase_matcher(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.CreateViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
view: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.View
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.View
Creates a view.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_create_view():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.CreateViewRequest(
parent="parent_value",
)
# Make the request
response = await client.create_view(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteAnalysisRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an analysis.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_analysis():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeleteAnalysisRequest(
name="name_value",
)
# Make the request
await client.delete_analysis(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a conversation.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_conversation():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeleteConversationRequest(
name="name_value",
)
# Make the request
await client.delete_conversation(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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
delete_issue(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteIssueRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an issue.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_issue():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeleteIssueRequest(
name="name_value",
)
# Make the request
await client.delete_issue(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.DeleteIssueRequest, dict]]
The request object. The request to delete an issue. |
name |
Required. The name of the issue to delete. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteIssueModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes an issue model.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeleteIssueModelRequest(
name="name_value",
)
# Make the request
operation = client.delete_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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); } |
delete_phrase_matcher
delete_phrase_matcher(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeletePhraseMatcherRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a phrase matcher.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_phrase_matcher():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeletePhraseMatcherRequest(
name="name_value",
)
# Make the request
await client.delete_phrase_matcher(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeleteViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a view.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_delete_view():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeleteViewRequest(
name="name_value",
)
# Make the request
await client.delete_view(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.DeployIssueModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_deploy_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.DeployIssueModelRequest(
name="name_value",
)
# Make the request
operation = client.deploy_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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. |
encryption_spec_path
encryption_spec_path(project: str, location: str) -> str
Returns a fully-qualified encryption_spec string.
export_insights_data
export_insights_data(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ExportInsightsDataRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Export insights data to a destination defined in the request body.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_export_insights_data():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
big_query_destination = contact_center_insights_v1.BigQueryDestination()
big_query_destination.dataset = "dataset_value"
request = contact_center_insights_v1.ExportInsightsDataRequest(
big_query_destination=big_query_destination,
parent="parent_value",
)
# Make the request
operation = client.export_insights_data(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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. |
export_issue_model
export_issue_model(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ExportIssueModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports an issue model to the provided destination.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_export_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
gcs_destination = contact_center_insights_v1.GcsDestination()
gcs_destination.object_uri = "object_uri_value"
request = contact_center_insights_v1.ExportIssueModelRequest(
gcs_destination=gcs_destination,
name="name_value",
)
# Make the request
operation = client.export_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.ExportIssueModelRequest, dict]]
The request object. Request to export an issue model. |
name |
Required. The issue model to export. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 ExportIssueModelResponse Response from export issue model |
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetAnalysisRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Analysis
Gets an analysis.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_analysis():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetAnalysisRequest(
name="name_value",
)
# Make the request
response = await client.get_analysis(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Conversation
Gets a conversation.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_conversation():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetConversationRequest(
name="name_value",
)
# Make the request
response = await client.get_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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_encryption_spec
get_encryption_spec(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetEncryptionSpecRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.EncryptionSpec
Gets location-level encryption key specification.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_encryption_spec():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetEncryptionSpecRequest(
name="name_value",
)
# Make the request
response = await client.get_encryption_spec(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.GetEncryptionSpecRequest, dict]]
The request object. The request to get location-level encryption specification. |
name |
Required. The name of the encryption spec resource to get. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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.EncryptionSpec |
A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). |
get_issue
get_issue(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetIssueRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Issue
Gets an issue.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_issue():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetIssueRequest(
name="name_value",
)
# Make the request
response = await client.get_issue(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetIssueModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.IssueModel
Gets an issue model.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetIssueModelRequest(
name="name_value",
)
# Make the request
response = await client.get_issue_model(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
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 |
|
An Operation object. |
get_phrase_matcher
get_phrase_matcher(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetPhraseMatcherRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher
Gets a phrase matcher.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_phrase_matcher():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetPhraseMatcherRequest(
name="name_value",
)
# Make the request
response = await client.get_phrase_matcher(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetSettingsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Settings
Gets project-level settings.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_settings():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetSettingsRequest(
name="name_value",
)
# Make the request
response = await client.get_settings(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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 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 with [updateSettings](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). |
get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.contact_center_insights_v1.services.contact_center_insights.transports.base.ContactCenterInsightsTransport
]
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
get_view
get_view(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.GetViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.View
Gets a view.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_get_view():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.GetViewRequest(
name="name_value",
)
# Make the request
response = await client.get_view(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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. |
import_issue_model
import_issue_model(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ImportIssueModelRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports an issue model from a Cloud Storage bucket.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_import_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
gcs_source = contact_center_insights_v1.GcsSource()
gcs_source.object_uri = "object_uri_value"
request = contact_center_insights_v1.ImportIssueModelRequest(
gcs_source=gcs_source,
parent="parent_value",
)
# Make the request
operation = client.import_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.ImportIssueModelRequest, dict]]
The request object. Request to import an issue model. |
parent |
Required. The parent resource of the issue model. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 ImportIssueModelResponse Response from import issue model |
ingest_conversations
ingest_conversations(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.IngestConversationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Imports conversations and processes them according to the user's configuration.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_ingest_conversations():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
gcs_source = contact_center_insights_v1.GcsSource()
gcs_source.bucket_uri = "bucket_uri_value"
transcript_object_config = contact_center_insights_v1.TranscriptObjectConfig()
transcript_object_config.medium = "CHAT"
request = contact_center_insights_v1.IngestConversationsRequest(
gcs_source=gcs_source,
transcript_object_config=transcript_object_config,
parent="parent_value",
)
# Make the request
operation = client.ingest_conversations(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.IngestConversationsRequest, dict]]
The request object. The request to ingest conversations. |
parent |
Required. The parent resource for new conversations. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 IngestConversationsResponse The response to an IngestConversations operation. |
initialize_encryption_spec
initialize_encryption_spec(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.InitializeEncryptionSpecRequest,
dict,
]
] = None,
*,
encryption_spec: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.EncryptionSpec
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_initialize_encryption_spec():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
encryption_spec = contact_center_insights_v1.EncryptionSpec()
encryption_spec.kms_key = "kms_key_value"
request = contact_center_insights_v1.InitializeEncryptionSpecRequest(
encryption_spec=encryption_spec,
)
# Make the request
operation = client.initialize_encryption_spec(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.InitializeEncryptionSpecRequest, dict]]
The request object. The request to initialize a location-level encryption specification. |
encryption_spec |
EncryptionSpec
Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
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 InitializeEncryptionSpecResponse The response to initialize a location-level encryption specification. |
issue_model_path
issue_model_path(project: str, location: str, issue_model: str) -> str
Returns a fully-qualified issue_model string.
issue_path
issue_path(project: str, location: str, issue_model: str, issue: str) -> str
Returns a fully-qualified issue string.
list_analyses
list_analyses(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListAnalysesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListAnalysesAsyncPager
)
Lists analyses.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_analyses():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListAnalysesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_analyses(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListConversationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListConversationsAsyncPager
)
Lists conversations.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_conversations():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListConversationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_conversations(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssueModelsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssueModelsResponse
)
Lists issue models.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_issue_models():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListIssueModelsRequest(
parent="parent_value",
)
# Make the request
response = await client.list_issue_models(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssuesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListIssuesResponse
)
Lists issues.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_issues():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListIssuesRequest(
parent="parent_value",
)
# Make the request
response = await client.list_issues(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
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 |
|
Response message for ListOperations method. |
list_phrase_matchers
list_phrase_matchers(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListPhraseMatchersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListPhraseMatchersAsyncPager
)
Lists phrase matchers.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_phrase_matchers():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListPhraseMatchersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_phrase_matchers(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.ListViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contact_center_insights_v1.services.contact_center_insights.pagers.ListViewsAsyncPager
)
Lists views.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_list_views():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.ListViewsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_views(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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) -> typing.Dict[str, str]
Parses a analysis path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_conversation_path
parse_conversation_path(path: str) -> typing.Dict[str, str]
Parses a conversation path into its component segments.
parse_conversation_profile_path
parse_conversation_profile_path(path: str) -> typing.Dict[str, str]
Parses a conversation_profile path into its component segments.
parse_encryption_spec_path
parse_encryption_spec_path(path: str) -> typing.Dict[str, str]
Parses a encryption_spec path into its component segments.
parse_issue_model_path
parse_issue_model_path(path: str) -> typing.Dict[str, str]
Parses a issue_model path into its component segments.
parse_issue_path
parse_issue_path(path: str) -> typing.Dict[str, str]
Parses a issue path into its component segments.
parse_participant_path
parse_participant_path(path: str) -> typing.Dict[str, str]
Parses a participant path into its component segments.
parse_phrase_matcher_path
parse_phrase_matcher_path(path: str) -> typing.Dict[str, str]
Parses a phrase_matcher path into its component segments.
parse_recognizer_path
parse_recognizer_path(path: str) -> typing.Dict[str, str]
Parses a recognizer path into its component segments.
parse_settings_path
parse_settings_path(path: str) -> typing.Dict[str, str]
Parses a settings path into its component segments.
parse_view_path
parse_view_path(path: str) -> typing.Dict[str, str]
Parses a view path into its component segments.
participant_path
participant_path(project: str, conversation: str, participant: str) -> str
Returns a fully-qualified participant string.
phrase_matcher_path
phrase_matcher_path(project: str, location: str, phrase_matcher: str) -> str
Returns a fully-qualified phrase_matcher string.
recognizer_path
recognizer_path(project: str, location: str, recognizer: str) -> str
Returns a fully-qualified recognizer string.
settings_path
settings_path(project: str, location: str) -> str
Returns a fully-qualified settings string.
undeploy_issue_model
undeploy_issue_model(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UndeployIssueModelRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_undeploy_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UndeployIssueModelRequest(
name="name_value",
)
# Make the request
operation = client.undeploy_issue_model(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.Conversation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Conversation
Updates a conversation.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_conversation():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UpdateConversationRequest(
)
# Make the request
response = await client.update_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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. All possible fields can be updated by passing |
retry |
google.api_core.retry_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateIssueRequest,
dict,
]
] = None,
*,
issue: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.Issue
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Issue
Updates an issue.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_issue():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UpdateIssueRequest(
)
# Make the request
response = await client.update_issue(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateIssueModelRequest,
dict,
]
] = None,
*,
issue_model: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.IssueModel
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.IssueModel
Updates an issue model.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_issue_model():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UpdateIssueModelRequest(
)
# Make the request
response = await client.update_issue_model(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdatePhraseMatcherRequest,
dict,
]
] = None,
*,
phrase_matcher: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.PhraseMatcher
Updates a phrase matcher.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_phrase_matcher():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
phrase_matcher = contact_center_insights_v1.PhraseMatcher()
phrase_matcher.type_ = "ANY_OF"
request = contact_center_insights_v1.UpdatePhraseMatcherRequest(
phrase_matcher=phrase_matcher,
)
# Make the request
response = await client.update_phrase_matcher(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateSettingsRequest,
dict,
]
] = None,
*,
settings: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.Settings
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.Settings
Updates project-level settings.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_settings():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UpdateSettingsRequest(
)
# Make the request
response = await client.update_settings(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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 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 with [updateSettings](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). |
update_view
update_view(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UpdateViewRequest,
dict,
]
] = None,
*,
view: typing.Optional[
google.cloud.contact_center_insights_v1.types.resources.View
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contact_center_insights_v1.types.resources.View
Updates a view.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_update_view():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UpdateViewRequest(
)
# Make the request
response = await client.update_view(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
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. |
upload_conversation
upload_conversation(
request: typing.Optional[
typing.Union[
google.cloud.contact_center_insights_v1.types.contact_center_insights.UploadConversationRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a long-running conversation upload operation. This method
differs from CreateConversation
by allowing audio
transcription and optional DLP redaction.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contact_center_insights_v1
async def sample_upload_conversation():
# Create a client
client = contact_center_insights_v1.ContactCenterInsightsAsyncClient()
# Initialize request argument(s)
request = contact_center_insights_v1.UploadConversationRequest(
parent="parent_value",
)
# Make the request
operation = client.upload_conversation(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.contact_center_insights_v1.types.UploadConversationRequest, dict]]
The request object. Request to upload a conversation. |
retry |
google.api_core.retry_async.AsyncRetry
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 Conversation The conversation resource. |
view_path
view_path(project: str, location: str, view: str) -> str
Returns a fully-qualified view string.