Class ConversationProfilesAsyncClient (2.37.0)

ConversationProfilesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport, typing.Callable[[...], google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport]]] = '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>)

Service for managing ConversationProfiles.

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

ConversationProfilesAsyncClient

ConversationProfilesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport, typing.Callable[[...], google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport]]] = '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 conversation profiles 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,ConversationProfilesTransport,Callable[..., ConversationProfilesTransport]]]` 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 ConversationProfilesTransport 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 `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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

agent_path

agent_path(project: str) -> str

Returns a fully-qualified agent string.

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, typing.Union[str, bytes]]] = ()
) -> 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`	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` method.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

clear_suggestion_feature_config

clear_suggestion_feature_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2.types.conversation_profile.ClearSuggestionFeatureConfigRequest,
            dict,
        ]
    ] = None,
    *,
    conversation_profile: typing.Optional[str] = None,
    participant_role: typing.Optional[
        google.cloud.dialogflow_v2.types.participant.Participant.Role
    ] = None,
    suggestion_feature_type: typing.Optional[
        google.cloud.dialogflow_v2.types.conversation_profile.SuggestionFeature.Type
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Clears a suggestion feature from a conversation profile for the given participant role.

This method is a long-running operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: xref_ClearSuggestionFeatureConfigOperationMetadata
response: xref_ConversationProfile

# 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 dialogflow_v2

async def sample_clear_suggestion_feature_config():
    # Create a client
    client = dialogflow_v2.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2.ClearSuggestionFeatureConfigRequest(
        conversation_profile="conversation_profile_value",
        participant_role="END_USER",
        suggestion_feature_type="KNOWLEDGE_ASSIST",
    )

    # Make the request
    operation = client.clear_suggestion_feature_config(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.dialogflow_v2.types.ClearSuggestionFeatureConfigRequest, dict]]` The request object. The request message for ConversationProfiles.ClearSuggestionFeatureConfig.
`conversation_profile`	`str` Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects/`. This corresponds to the `conversation_profile` field on the `request` instance; if `request` is provided, this should not be set.
`participant_role`	`Role` Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used. This corresponds to the `participant_role` field on the `request` instance; if `request` is provided, this should not be set.
`suggestion_feature_type`	`Type` Required. The type of the suggestion feature to remove. This corresponds to the `suggestion_feature_type` field on the `request` instance; if `request` is provided, this should not be set.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be ConversationProfile Defines the services to connect to incoming Dialogflow conversations.

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_model_path

conversation_model_path(
    project: str, location: str, conversation_model: str
) -> str

Returns a fully-qualified conversation_model string.

conversation_profile_path

conversation_profile_path(project: str, conversation_profile: str) -> str

Returns a fully-qualified conversation_profile string.

create_conversation_profile

create_conversation_profile(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2.types.conversation_profile.CreateConversationProfileRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    conversation_profile: typing.Optional[
        google.cloud.dialogflow_v2.types.conversation_profile.ConversationProfile
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.dialogflow_v2.types.conversation_profile.ConversationProfile

Creates a conversation profile in the specified project.

xref_ConversationProfile.create_time and xref_ConversationProfile.update_time aren't populated in the response. You can retrieve them via xref_GetConversationProfile API.

# 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 dialogflow_v2

async def sample_create_conversation_profile():
    # Create a client
    client = dialogflow_v2.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    conversation_profile = dialogflow_v2.ConversationProfile()
    conversation_profile.display_name = "display_name_value"

    request = dialogflow_v2.CreateConversationProfileRequest(
        parent="parent_value",
        conversation_profile=conversation_profile,
    )

    # Make the request
    response = await client.create_conversation_profile(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2.types.CreateConversationProfileRequest, dict]]` The request object. The request message for ConversationProfiles.CreateConversationProfile.
`parent`	`str` Required. The project to create a conversation profile for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`conversation_profile`	`ConversationProfile` Required. The conversation profile to create. This corresponds to the `conversation_profile` field on the `request` instance; if `request` is provided, this should not be set.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.dialogflow_v2.types.ConversationProfile`	Defines the services to connect to incoming Dialogflow conversations.

cx_security_settings_path

cx_security_settings_path(
    project: str, location: str, security_settings: str
) -> str

Returns a fully-qualified cx_security_settings string.

delete_conversation_profile

delete_conversation_profile(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2.types.conversation_profile.DeleteConversationProfileRequest,
            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, typing.Union[str, bytes]]] = ()
) -> None

Deletes the specified conversation profile.

# 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 dialogflow_v2

async def sample_delete_conversation_profile():
    # Create a client
    client = dialogflow_v2.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2.DeleteConversationProfileRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_conversation_profile(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2.types.DeleteConversationProfileRequest, dict]]` The request object. The request message for ConversationProfiles.DeleteConversationProfile. This operation fails if the conversation profile is still referenced from a phone number.
`name`	`str` Required. The name of the conversation profile to delete. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry`