As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ConversationProfiles¶

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

Service for managing [ConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfile].

Instantiates the conversation profiles async client.

Parameters

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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static agent_path(project: str) → str¶: Returns a fully-qualified agent string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

async clear_suggestion_feature_config(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.ClearSuggestionFeatureConfigRequest, dict]] = None, *, conversation_profile: Optional[str] = None, participant_role: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant.Role] = None, suggestion_feature_type: Optional[google.cloud.dialogflow_v2beta1.types.participant.SuggestionFeature.Type] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata]
response: [ConversationProfile][google.cloud.dialogflow.v2beta1.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_v2beta1

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.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

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.ClearSuggestionFeatureConfigRequest, dict]]) – The request object. The request message for [ConversationProfiles.ClearFeature][].
conversation_profile (str) –
Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
participant_role (google.cloud.dialogflow_v2beta1.types.Participant.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 (google.cloud.dialogflow_v2beta1.types.SuggestionFeature.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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflow_v2beta1.types.ConversationProfile Defines the services to connect to incoming Dialogflow conversations.

Return type

google.api_core.operation_async.AsyncOperation

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

static conversation_model_path(project: str, location: str, conversation_model: str) → str¶: Returns a fully-qualified conversation_model string.

static conversation_profile_path(project: str, conversation_profile: str) → str¶: Returns a fully-qualified conversation_profile string.

async create_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.CreateConversationProfileRequest, dict]] = None, *, parent: Optional[str] = None, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren’t populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.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_v2beta1

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

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

    request = dialogflow_v2beta1.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

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.CreateConversationProfileRequest, dict]]) – The request object. The request message for [ConversationProfiles.CreateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.CreateConversationProfile].
parent (str) –
Required. The project to create a conversation profile for. Format: projects/<Project ID>/locations/<Location ID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
conversation_profile (google.cloud.dialogflow_v2beta1.types.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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

static cx_security_settings_path(project: str, location: str, security_settings: str) → str¶: Returns a fully-qualified cx_security_settings string.

async delete_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.DeleteConversationProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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_v2beta1

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

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

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

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.DeleteConversationProfileRequest, dict]]) –
The request object. The request message for [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2beta1.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/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

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) – 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.

static document_path(project: str, knowledge_base: str, document: str) → str¶: Returns a fully-qualified document string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesAsyncClient

static generator_path(project: str, location: str, generator: str) → str¶: Returns a fully-qualified generator string.

async get_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.GetConversationProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Retrieves 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_v2beta1

async def sample_get_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.GetConversationProfileRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.GetConversationProfileRequest, dict]]) – The request object. The request message for [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile].
name (str) –
Required. The resource name of the conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

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) – 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

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.dialogflow_v2beta1.services.conversation_profiles.transports.base.ConversationProfilesTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

static knowledge_base_path(project: str, knowledge_base: str) → str¶: Returns a fully-qualified knowledge_base string.

async list_conversation_profiles(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesAsyncPager[source]¶

Returns the list of all conversation profiles in the specified project.

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

async def sample_list_conversation_profiles():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListConversationProfilesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_conversation_profiles(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.ListConversationProfilesRequest, dict]]) – The request object. The request message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles].
parent (str) –
Required. The project to list all conversation profiles from. Format: projects/<Project ID>/locations/<Location ID>.

This corresponds to the parent 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for: [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static parse_agent_path(path: str) → Dict[str, str]¶: Parses a agent path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_conversation_model_path(path: str) → Dict[str, str]¶: Parses a conversation_model path into its component segments.

static parse_conversation_profile_path(path: str) → Dict[str, str]¶: Parses a conversation_profile path into its component segments.

static parse_cx_security_settings_path(path: str) → Dict[str, str]¶: Parses a cx_security_settings path into its component segments.

static parse_document_path(path: str) → Dict[str, str]¶: Parses a document path into its component segments.

static parse_generator_path(path: str) → Dict[str, str]¶: Parses a generator path into its component segments.

static parse_knowledge_base_path(path: str) → Dict[str, str]¶: Parses a knowledge_base path into its component segments.

static parse_phrase_set_path(path: str) → Dict[str, str]¶: Parses a phrase_set path into its component segments.

static phrase_set_path(project: str, location: str, phrase_set: str) → str¶: Returns a fully-qualified phrase_set string.

async set_suggestion_feature_config(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.SetSuggestionFeatureConfigRequest, dict]] = None, *, conversation_profile: Optional[str] = None, participant_role: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant.Role] = None, suggestion_feature_config: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.HumanAgentAssistantConfig.SuggestionFeatureConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata]
response: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

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

async def sample_set_suggestion_feature_config():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.SetSuggestionFeatureConfigRequest(
        conversation_profile="conversation_profile_value",
        participant_role="END_USER",
    )

    # Make the request
    operation = client.set_suggestion_feature_config(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.SetSuggestionFeatureConfigRequest, dict]]) – The request object. The request message for [ConversationProfiles.SetSuggestionFeature][].
conversation_profile (str) –
Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
participant_role (google.cloud.dialogflow_v2beta1.types.Participant.Role) –
Required. The participant role to add or update 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_config (google.cloud.dialogflow_v2beta1.types.HumanAgentAssistantConfig.SuggestionFeatureConfig) –
Required. The suggestion feature config to add or update.

This corresponds to the suggestion_feature_config 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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflow_v2beta1.types.ConversationProfile Defines the services to connect to incoming Dialogflow conversations.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.dialogflow_v2beta1.services.conversation_profiles.transports.base.ConversationProfilesTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: ConversationProfilesTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.UpdateConversationProfileRequest, dict]] = None, *, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren’t populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.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_v2beta1

async def sample_update_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesAsyncClient()

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

    request = dialogflow_v2beta1.UpdateConversationProfileRequest(
        conversation_profile=conversation_profile,
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.UpdateConversationProfileRequest, dict]]) – The request object. The request message for [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.UpdateConversationProfile].
conversation_profile (google.cloud.dialogflow_v2beta1.types.ConversationProfile) –
Required. The conversation profile to update.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The mask to control which fields to update.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

class google.cloud.dialogflow_v2beta1.services.conversation_profiles.ConversationProfilesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2beta1.services.conversation_profiles.transports.base.ConversationProfilesTransport, typing.Callable[[...], google.cloud.dialogflow_v2beta1.services.conversation_profiles.transports.base.ConversationProfilesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service for managing [ConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfile].

Instantiates the conversation profiles client.

Parameters

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

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static agent_path(project: str) → str[source]¶: Returns a fully-qualified agent string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

clear_suggestion_feature_config(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.ClearSuggestionFeatureConfigRequest, dict]] = None, *, conversation_profile: Optional[str] = None, participant_role: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant.Role] = None, suggestion_feature_type: Optional[google.cloud.dialogflow_v2beta1.types.participant.SuggestionFeature.Type] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata]
response: [ConversationProfile][google.cloud.dialogflow.v2beta1.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_v2beta1

def sample_clear_suggestion_feature_config():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.ClearSuggestionFeatureConfigRequest, dict]) – The request object. The request message for [ConversationProfiles.ClearFeature][].
conversation_profile (str) –
Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
participant_role (google.cloud.dialogflow_v2beta1.types.Participant.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 (google.cloud.dialogflow_v2beta1.types.SuggestionFeature.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflow_v2beta1.types.ConversationProfile Defines the services to connect to incoming Dialogflow conversations.

Return type

google.api_core.operation.Operation

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static conversation_model_path(project: str, location: str, conversation_model: str) → str[source]¶: Returns a fully-qualified conversation_model string.

static conversation_profile_path(project: str, conversation_profile: str) → str[source]¶: Returns a fully-qualified conversation_profile string.

create_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.CreateConversationProfileRequest, dict]] = None, *, parent: Optional[str] = None, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren’t populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.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_v2beta1

def sample_create_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.CreateConversationProfileRequest, dict]) – The request object. The request message for [ConversationProfiles.CreateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.CreateConversationProfile].
parent (str) –
Required. The project to create a conversation profile for. Format: projects/<Project ID>/locations/<Location ID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
conversation_profile (google.cloud.dialogflow_v2beta1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

static cx_security_settings_path(project: str, location: str, security_settings: str) → str[source]¶: Returns a fully-qualified cx_security_settings string.

delete_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.DeleteConversationProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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_v2beta1

def sample_delete_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

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

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

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.DeleteConversationProfileRequest, dict]) –
The request object. The request message for [ConversationProfiles.DeleteConversationProfile][google.cloud.dialogflow.v2beta1.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/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static document_path(project: str, knowledge_base: str, document: str) → str[source]¶: Returns a fully-qualified document string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ConversationProfilesClient

static generator_path(project: str, location: str, generator: str) → str[source]¶: Returns a fully-qualified generator string.

get_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.GetConversationProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Retrieves 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_v2beta1

def sample_get_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.GetConversationProfileRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_conversation_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.GetConversationProfileRequest, dict]) – The request object. The request message for [ConversationProfiles.GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile].
name (str) –
Required. The resource name of the conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

static knowledge_base_path(project: str, knowledge_base: str) → str[source]¶: Returns a fully-qualified knowledge_base string.

list_conversation_profiles(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesPager[source]¶

Returns the list of all conversation profiles in the specified project.

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

def sample_list_conversation_profiles():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListConversationProfilesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_conversation_profiles(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.ListConversationProfilesRequest, dict]) – The request object. The request message for [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles].
parent (str) –
Required. The project to list all conversation profiles from. Format: projects/<Project ID>/locations/<Location ID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for: [ConversationProfiles.ListConversationProfiles][google.cloud.dialogflow.v2beta1.ConversationProfiles.ListConversationProfiles].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static parse_agent_path(path: str) → Dict[str, str][source]¶: Parses a agent path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_conversation_model_path(path: str) → Dict[str, str][source]¶: Parses a conversation_model path into its component segments.

static parse_conversation_profile_path(path: str) → Dict[str, str][source]¶: Parses a conversation_profile path into its component segments.

static parse_cx_security_settings_path(path: str) → Dict[str, str][source]¶: Parses a cx_security_settings path into its component segments.

static parse_document_path(path: str) → Dict[str, str][source]¶: Parses a document path into its component segments.

static parse_generator_path(path: str) → Dict[str, str][source]¶: Parses a generator path into its component segments.

static parse_knowledge_base_path(path: str) → Dict[str, str][source]¶: Parses a knowledge_base path into its component segments.

static parse_phrase_set_path(path: str) → Dict[str, str][source]¶: Parses a phrase_set path into its component segments.

static phrase_set_path(project: str, location: str, phrase_set: str) → str[source]¶: Returns a fully-qualified phrase_set string.

set_suggestion_feature_config(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.SetSuggestionFeatureConfigRequest, dict]] = None, *, conversation_profile: Optional[str] = None, participant_role: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant.Role] = None, suggestion_feature_config: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.HumanAgentAssistantConfig.SuggestionFeatureConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata]
response: [ConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

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

def sample_set_suggestion_feature_config():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.SetSuggestionFeatureConfigRequest(
        conversation_profile="conversation_profile_value",
        participant_role="END_USER",
    )

    # Make the request
    operation = client.set_suggestion_feature_config(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.SetSuggestionFeatureConfigRequest, dict]) – The request object. The request message for [ConversationProfiles.SetSuggestionFeature][].
conversation_profile (str) –
Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
participant_role (google.cloud.dialogflow_v2beta1.types.Participant.Role) –
Required. The participant role to add or update 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_config (google.cloud.dialogflow_v2beta1.types.HumanAgentAssistantConfig.SuggestionFeatureConfig) –
Required. The suggestion feature config to add or update.

This corresponds to the suggestion_feature_config field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflow_v2beta1.types.ConversationProfile Defines the services to connect to incoming Dialogflow conversations.

Return type

google.api_core.operation.Operation

property transport: google.cloud.dialogflow_v2beta1.services.conversation_profiles.transports.base.ConversationProfilesTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

ConversationProfilesTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.conversation_profile.UpdateConversationProfileRequest, dict]] = None, *, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile[source]¶

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren’t populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.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_v2beta1

def sample_update_conversation_profile():
    # Create a client
    client = dialogflow_v2beta1.ConversationProfilesClient()

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

    request = dialogflow_v2beta1.UpdateConversationProfileRequest(
        conversation_profile=conversation_profile,
    )

    # Make the request
    response = client.update_conversation_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.UpdateConversationProfileRequest, dict]) – The request object. The request message for [ConversationProfiles.UpdateConversationProfile][google.cloud.dialogflow.v2beta1.ConversationProfiles.UpdateConversationProfile].
conversation_profile (google.cloud.dialogflow_v2beta1.types.ConversationProfile) –
Required. The conversation profile to update.

This corresponds to the conversation_profile field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The mask to control which fields to update.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines the services to connect to incoming Dialogflow conversations.

Return type

google.cloud.dialogflow_v2beta1.types.ConversationProfile

class google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesResponse]], request: google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesRequest, response: google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_conversation_profiles requests.

This class thinly wraps an initial google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse object, and provides an __aiter__ method to iterate through its conversation_profiles field.

If there are more pages, the __aiter__ method will make additional ListConversationProfiles requests and continue to iterate through the conversation_profiles field on the corresponding responses.

All the usual google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.dialogflow_v2beta1.types.ListConversationProfilesRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.cloud.dialogflow_v2beta1.services.conversation_profiles.pagers.ListConversationProfilesPager(method: Callable[[...], google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesResponse], request: google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesRequest, response: google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_conversation_profiles requests.

This class thinly wraps an initial google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse object, and provides an __iter__ method to iterate through its conversation_profiles field.

If there are more pages, the __iter__ method will make additional ListConversationProfiles requests and continue to iterate through the conversation_profiles field on the corresponding responses.

All the usual google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.dialogflow_v2beta1.types.ListConversationProfilesRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListConversationProfilesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

ConversationProfiles¶

google-cloud-dialogflow

Navigation

Related Topics