Class ConversationsAsyncClient (2.24.1)

ConversationsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflow_v2beta1.services.conversations.transports.base.ConversationsTransport] = '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 Conversations.

Properties

transport

Returns the transport used by the client instance.

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

Methods

ConversationsAsyncClient

ConversationsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflow_v2beta1.services.conversations.transports.base.ConversationsTransport] = '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 conversations client.

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

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.

answer_record_path

answer_record_path(project: str, answer_record: str) -> str

Returns a fully-qualified answer_record string.

batch_create_messages

batch_create_messages(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.BatchCreateMessagesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2beta1.types.conversation.BatchCreateMessagesResponse

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1

async def sample_batch_create_messages():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

    # Initialize request argument(s)
    requests = dialogflow_v2beta1.CreateMessageRequest()
    requests.parent = "parent_value"
    requests.message.content = "content_value"

    request = dialogflow_v2beta1.BatchCreateMessagesRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.BatchCreateMessagesRequest, dict]]` The request object. The request message for [Conversations.BatchCreateMessagesRequest][].
`parent`	`str` Required. Resource identifier of the conversation to create message. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.BatchCreateMessagesResponse`	The request message for [Conversations.BatchCreateMessagesResponse][].

cancel_operation

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

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`.operations_pb2.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.

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.

complete_conversation

complete_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.CompleteConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2beta1.types.conversation.Conversation

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

# 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_complete_conversation():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.CompleteConversationRequest, dict]]` The request object. The request message for Conversations.CompleteConversation.
`name`	`str` Required. Resource identifier of the conversation to close. 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.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.Conversation`	Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

conversation_model_path

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

Returns a fully-qualified conversation_model string.

conversation_path

conversation_path(project: str, conversation: str) -> str

Returns a fully-qualified conversation string.

conversation_profile_path

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

Returns a fully-qualified conversation_profile string.

create_conversation

create_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.CreateConversationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    conversation: typing.Optional[
        google.cloud.dialogflow_v2beta1.types.conversation.Conversation
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2beta1.types.conversation.Conversation

Creates a new conversation. Conversations are auto-completed after 24 hours.

Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.

For Automated Agent Stage, there will be a dialogflow agent responding to user queries.

For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.

If xref_Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an xref_Intent with xref_Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

# 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():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

    # Initialize request argument(s)
    conversation = dialogflow_v2beta1.Conversation()
    conversation.conversation_profile = "conversation_profile_value"

    request = dialogflow_v2beta1.CreateConversationRequest(
        parent="parent_value",
        conversation=conversation,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.CreateConversationRequest, dict]]` The request object. The request message for Conversations.CreateConversation.
`parent`	`str` Required. Resource identifier of the project creating the conversation. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`conversation`	`Conversation` Required. The conversation to create. This corresponds to the `conversation` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.Conversation`	Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

cx_security_settings_path

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

Returns a fully-qualified cx_security_settings string.

document_path

document_path(project: str, knowledge_base: str, document: str) -> str

Returns a fully-qualified document string.

from_service_account_file

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

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

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

Returns
Type	Description
`ConversationsAsyncClient`	The constructed client.

from_service_account_info

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

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

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

Returns
Type	Description
`ConversationsAsyncClient`	The constructed client.

from_service_account_json

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

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

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

Returns
Type	Description
`ConversationsAsyncClient`	The constructed client.

generate_stateless_summary

generate_stateless_summary(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.GenerateStatelessSummaryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dialogflow_v2beta1.types.conversation.GenerateStatelessSummaryResponse
)

Generates and returns a summary for a conversation that does not have a resource created for it.

# 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_generate_stateless_summary():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

    # Initialize request argument(s)
    stateless_conversation = dialogflow_v2beta1.MinimalConversation()
    stateless_conversation.messages.content = "content_value"
    stateless_conversation.parent = "parent_value"

    conversation_profile = dialogflow_v2beta1.ConversationProfile()
    conversation_profile.display_name = "display_name_value"

    request = dialogflow_v2beta1.GenerateStatelessSummaryRequest(
        stateless_conversation=stateless_conversation,
        conversation_profile=conversation_profile,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.GenerateStatelessSummaryRequest, dict]]` The request object. The request message for Conversations.GenerateStatelessSummary.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.GenerateStatelessSummaryResponse`	The response message for Conversations.GenerateStatelessSummary.

get_conversation

get_conversation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.GetConversationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2beta1.types.conversation.Conversation

Retrieves the specific conversation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1

async def sample_get_conversation():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.GetConversationRequest, dict]]` The request object. The request message for Conversations.GetConversation.
`name`	`str` Required. The name of the conversation. 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.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.Conversation`	Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

get_location

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

Gets information about a location.

Parameters
Name	Description
`request`	`.location_pb2.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
Type	Description
`.location_pb2.Location`	Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_operation

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

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.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
Type	Description
`.operations_pb2.Operation`	An `Operation` object.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.dialogflow_v2beta1.services.conversations.transports.base.ConversationsTransport
    ]
)

Returns an appropriate transport class.

knowledge_base_path

knowledge_base_path(project: str, knowledge_base: str) -> str

Returns a fully-qualified knowledge_base string.

list_conversations

list_conversations(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.ListConversationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dialogflow_v2beta1.services.conversations.pagers.ListConversationsAsyncPager
)

Returns the list of all conversations 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_conversations():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

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

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.ListConversationsRequest, dict]]` The request object. The request message for Conversations.ListConversations.
`parent`	`str` Required. The project from which to list all conversation. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.services.conversations.pagers.ListConversationsAsyncPager`	The response message for Conversations.ListConversations. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

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

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`.location_pb2.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
Type	Description
`.location_pb2.ListLocationsResponse`	Response message for `ListLocations` method.

list_messages

list_messages(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.ListMessagesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dialogflow_v2beta1.services.conversations.pagers.ListMessagesAsyncPager
)

Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

# 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_messages():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

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

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.ListMessagesRequest, dict]]` The request object. The request message for Conversations.ListMessages.
`parent`	`str` Required. The name of the conversation to list messages for. Format: `projects/` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.services.conversations.pagers.ListMessagesAsyncPager`	The response message for Conversations.ListMessages. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

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

Lists operations that match the specified filter in the request.

Parameters
Name	Description
`request`	`.operations_pb2.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
Type	Description
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

message_path

message_path(project: str, conversation: str, message: str) -> str

Returns a fully-qualified message string.

parse_agent_path

parse_agent_path(path: str) -> typing.Dict[str, str]

Parses a agent path into its component segments.

parse_answer_record_path

parse_answer_record_path(path: str) -> typing.Dict[str, str]

Parses a answer_record path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_conversation_model_path

parse_conversation_model_path(path: str) -> typing.Dict[str, str]

Parses a conversation_model path into its component segments.

parse_conversation_path

parse_conversation_path(path: str) -> typing.Dict[str, str]

Parses a conversation path into its component segments.

parse_conversation_profile_path

parse_conversation_profile_path(path: str) -> typing.Dict[str, str]

Parses a conversation_profile path into its component segments.

parse_cx_security_settings_path

parse_cx_security_settings_path(path: str) -> typing.Dict[str, str]

Parses a cx_security_settings path into its component segments.

parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

parse_knowledge_base_path

parse_knowledge_base_path(path: str) -> typing.Dict[str, str]

Parses a knowledge_base path into its component segments.

parse_message_path

parse_message_path(path: str) -> typing.Dict[str, str]

Parses a message path into its component segments.

search_knowledge

search_knowledge(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.SearchKnowledgeRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2beta1.types.conversation.SearchKnowledgeResponse

Get answers for the given query based on knowledge documents.

# 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_search_knowledge():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.SearchKnowledgeRequest(
        conversation_profile="conversation_profile_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.SearchKnowledgeRequest, dict]]` The request object. The request message for Conversations.SearchKnowledge.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.SearchKnowledgeResponse`	The response message for Conversations.SearchKnowledge.

suggest_conversation_summary

suggest_conversation_summary(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflow_v2beta1.types.conversation.SuggestConversationSummaryRequest,
            dict,
        ]
    ] = None,
    *,
    conversation: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dialogflow_v2beta1.types.conversation.SuggestConversationSummaryResponse
)

Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1

async def sample_suggest_conversation_summary():
    # Create a client
    client = dialogflow_v2beta1.ConversationsAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.SuggestConversationSummaryRequest(
        conversation="conversation_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.dialogflow_v2beta1.types.SuggestConversationSummaryRequest, dict]]` The request object. The request message for Conversations.SuggestConversationSummary.
`conversation`	`str` Required. The conversation to fetch suggestion for. Format: `projects/`. This corresponds to the `conversation` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.SuggestConversationSummaryResponse`	The response message for Conversations.SuggestConversationSummary.