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.

Participants¶

class google.cloud.dialogflow_v2beta1.services.participants.ParticipantsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport, typing.Callable[[...], google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport]]] = '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 [Participants][google.cloud.dialogflow.v2beta1.Participant].

Instantiates the participants 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,ParticipantsTransport,Callable[..., ParticipantsTransport]]]) – 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 ParticipantsTransport 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.

async analyze_content(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.AnalyzeContentRequest, dict]] = None, *, participant: Optional[str] = None, text_input: Optional[google.cloud.dialogflow_v2beta1.types.session.TextInput] = None, audio_input: Optional[google.cloud.dialogflow_v2beta1.types.participant.AudioInput] = None, event_input: Optional[google.cloud.dialogflow_v2beta1.types.session.EventInput] = 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.participant.AnalyzeContentResponse[source]¶

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.AnalyzeContentRequest(
        participant="participant_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.AnalyzeContentRequest, dict]]) – The request object. The request message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent].
participant (str) –
Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

This corresponds to the participant field on the request instance; if request is provided, this should not be set.
text_input (google.cloud.dialogflow_v2beta1.types.TextInput) –
The natural language text to be processed.

This corresponds to the text_input field on the request instance; if request is provided, this should not be set.
audio_input (google.cloud.dialogflow_v2beta1.types.AudioInput) –
The natural language speech audio to be processed.

This corresponds to the audio_input field on the request instance; if request is provided, this should not be set.
event_input (google.cloud.dialogflow_v2beta1.types.EventInput) – An input event to send to Dialogflow. This corresponds to the event_input 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: [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent].

Return type

google.cloud.dialogflow_v2beta1.types.AnalyzeContentResponse

static answer_record_path(project: str, answer_record: str) → str¶: Returns a fully-qualified answer_record 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

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.

async compile_suggestion(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.CompileSuggestionRequest, dict]] = 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.participant.CompileSuggestionResponse[source]¶

Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

Gets suggestions for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.CompileSuggestionRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.CompileSuggestionRequest, dict]]) – The request object. The request message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion].
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: [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion].

Return type

google.cloud.dialogflow_v2beta1.types.CompileSuggestionResponse

static context_path(project: str, session: str, context: str) → str¶: Returns a fully-qualified context string.

async create_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.CreateParticipantRequest, dict]] = None, *, parent: Optional[str] = None, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = 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.participant.Participant[source]¶

Creates a new participant in a conversation.

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

async def sample_create_participant():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.CreateParticipantRequest, dict]]) – The request object. The request message for [Participants.CreateParticipant][google.cloud.dialogflow.v2beta1.Participants.CreateParticipant].
parent (str) –
Required. Resource identifier of the conversation adding the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
participant (google.cloud.dialogflow_v2beta1.types.Participant) – Required. The participant to create. This corresponds to the participant 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

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

ParticipantsAsyncClient

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

ParticipantsAsyncClient

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

ParticipantsAsyncClient

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

async get_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.GetParticipantRequest, 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.participant.Participant[source]¶

Retrieves a conversation participant.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.GetParticipantRequest, dict]]) – The request object. The request message for [Participants.GetParticipant][google.cloud.dialogflow.v2beta1.Participants.GetParticipant].
name (str) –
Required. The name of the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

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

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 intent_path(project: str, intent: str) → str¶: Returns a fully-qualified intent string.

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

async list_participants(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsRequest, 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.participants.pagers.ListParticipantsAsyncPager[source]¶

Returns the list of all participants in the specified 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_list_participants():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsAsyncClient()

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

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

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

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.ListParticipantsRequest, dict]]) – The request object. The request message for [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants].
parent (str) –
Required. The conversation to list all participants from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation 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: [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants].

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

Return type

google.cloud.dialogflow_v2beta1.services.participants.pagers.ListParticipantsAsyncPager

async list_suggestions(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsRequest, dict]] = 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.participants.pagers.ListSuggestionsAsyncPager[source]¶

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions 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_suggestions():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListSuggestionsRequest(
    )

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

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

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.ListSuggestionsRequest, dict]]) – The request object. The request message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions].
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: [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions].

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

Return type

google.cloud.dialogflow_v2beta1.services.participants.pagers.ListSuggestionsAsyncPager

static message_path(project: str, conversation: str, message: str) → str¶: Returns a fully-qualified message string.

static parse_answer_record_path(path: str) → Dict[str, str]¶: Parses a answer_record 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_context_path(path: str) → Dict[str, str]¶: Parses a context path into its component segments.

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

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

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

static parse_participant_path(path: str) → Dict[str, str]¶: Parses a participant 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 parse_session_entity_type_path(path: str) → Dict[str, str]¶: Parses a session_entity_type path into its component segments.

static participant_path(project: str, conversation: str, participant: str) → str¶: Returns a fully-qualified participant string.

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

static session_entity_type_path(project: str, session: str, entity_type: str) → str¶: Returns a fully-qualified session_entity_type string.

streaming_analyze_content(requests: Optional[AsyncIterator[google.cloud.dialogflow_v2beta1.types.participant.StreamingAnalyzeContentRequest]] = 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]] = ()) → Awaitable[AsyncIterable[google.cloud.dialogflow_v2beta1.types.participant.StreamingAnalyzeContentResponse]][source]¶

Adds a text (e.g., chat) or audio (e.g., phone recording) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field, and potentially the reply_audio and/or the automated_agent_reply fields.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

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

    # Initialize request argument(s)
    audio_config = dialogflow_v2beta1.InputAudioConfig()
    audio_config.audio_encoding = "AUDIO_ENCODING_ALAW"
    audio_config.sample_rate_hertz = 1817
    audio_config.language_code = "language_code_value"

    request = dialogflow_v2beta1.StreamingAnalyzeContentRequest(
        audio_config=audio_config,
        input_audio=b'input_audio_blob',
        participant="participant_value",
    )

    # This method expects an iterator which contains
    # 'dialogflow_v2beta1.StreamingAnalyzeContentRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = await client.streaming_analyze_content(requests=request_generator())

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

Parameters

requests (AsyncIterator[google.cloud.dialogflow_v2beta1.types.StreamingAnalyzeContentRequest]) –
The request object AsyncIterator. The top-level message sent by the client to the [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method.

Multiple request messages should be sent in order:
1. The first message must contain [participant][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.participant], [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionally [query_params][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.query_params]. If you want to receive an audio response, it should also contain [reply_audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.reply_audio_config]. The message must not contain [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input].
2. If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.audio_config], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_audio] to continue with Speech recognition. If you decide to rather analyze text input after you already started Speech recognition, please send a message with [StreamingAnalyzeContentRequest.input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text].
  
  However, note that:
  - Dialogflow will bill you for the audio so far.
  - Dialogflow discards all Speech recognition results in favor of the text input.
3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.text_config], then the second message must contain only [input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text]. Moreover, you must not send more than two messages.
After you sent all input, you must half-close or abort the request stream.
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 top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.

In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply.

In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

Return type

AsyncIterable[google.cloud.dialogflow_v2beta1.types.StreamingAnalyzeContentResponse]

async suggest_articles(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestArticlesRequest, 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.types.participant.SuggestArticlesResponse[source]¶

Gets suggested articles for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.SuggestArticlesRequest, dict]]) – The request object. The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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: [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestArticlesResponse

async suggest_faq_answers(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestFaqAnswersRequest, 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.types.participant.SuggestFaqAnswersResponse[source]¶

Gets suggested faq answers for a participant based on specific historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.SuggestFaqAnswersRequest, dict]]) – The request object. The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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 request message for: [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestFaqAnswersResponse

async suggest_knowledge_assist(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestKnowledgeAssistRequest, dict]] = 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.participant.SuggestKnowledgeAssistResponse[source]¶

Gets knowledge assist suggestions based on historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.SuggestKnowledgeAssistRequest, dict]]) – The request object. The request message for [Participants.SuggestKnowledgeAssist][google.cloud.dialogflow.v2beta1.Participants.SuggestKnowledgeAssist].
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: [Participants.SuggestKnowledgeAssist][google.cloud.dialogflow.v2beta1.Participants.SuggestKnowledgeAssist].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestKnowledgeAssistResponse

async suggest_smart_replies(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestSmartRepliesRequest, 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.types.participant.SuggestSmartRepliesResponse[source]¶

Gets smart replies for a participant based on specific historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.SuggestSmartRepliesRequest, dict]]) – The request object. The request message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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: [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestSmartRepliesResponse

property transport: google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport¶

Returns the transport used by the client instance.

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

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_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.UpdateParticipantRequest, dict]] = None, *, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = 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.participant.Participant[source]¶

Updates the specified participant.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.UpdateParticipantRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.UpdateParticipantRequest, dict]]) – The request object. The request message for [Participants.UpdateParticipant][google.cloud.dialogflow.v2beta1.Participants.UpdateParticipant].
participant (google.cloud.dialogflow_v2beta1.types.Participant) – Required. The participant to update. This corresponds to the participant 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 specify 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

class google.cloud.dialogflow_v2beta1.services.participants.ParticipantsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport, typing.Callable[[...], google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport]]] = 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 [Participants][google.cloud.dialogflow.v2beta1.Participant].

Instantiates the participants 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,ParticipantsTransport,Callable[..., ParticipantsTransport]]]) – 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 ParticipantsTransport 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!

analyze_content(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.AnalyzeContentRequest, dict]] = None, *, participant: Optional[str] = None, text_input: Optional[google.cloud.dialogflow_v2beta1.types.session.TextInput] = None, audio_input: Optional[google.cloud.dialogflow_v2beta1.types.participant.AudioInput] = None, event_input: Optional[google.cloud.dialogflow_v2beta1.types.session.EventInput] = 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.participant.AnalyzeContentResponse[source]¶

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.AnalyzeContentRequest(
        participant="participant_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.AnalyzeContentRequest, dict]) – The request object. The request message for [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent].
participant (str) –
Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

This corresponds to the participant field on the request instance; if request is provided, this should not be set.
text_input (google.cloud.dialogflow_v2beta1.types.TextInput) –
The natural language text to be processed.

This corresponds to the text_input field on the request instance; if request is provided, this should not be set.
audio_input (google.cloud.dialogflow_v2beta1.types.AudioInput) –
The natural language speech audio to be processed.

This corresponds to the audio_input field on the request instance; if request is provided, this should not be set.
event_input (google.cloud.dialogflow_v2beta1.types.EventInput) – An input event to send to Dialogflow. This corresponds to the event_input 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: [Participants.AnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.AnalyzeContent].

Return type

google.cloud.dialogflow_v2beta1.types.AnalyzeContentResponse

static answer_record_path(project: str, answer_record: str) → str[source]¶: Returns a fully-qualified answer_record 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

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.

compile_suggestion(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.CompileSuggestionRequest, dict]] = 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.participant.CompileSuggestionResponse[source]¶

Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

Gets suggestions for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.CompileSuggestionRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.CompileSuggestionRequest, dict]) – The request object. The request message for [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion].
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: [Participants.CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion].

Return type

google.cloud.dialogflow_v2beta1.types.CompileSuggestionResponse

static context_path(project: str, session: str, context: str) → str[source]¶: Returns a fully-qualified context string.

create_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.CreateParticipantRequest, dict]] = None, *, parent: Optional[str] = None, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = 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.participant.Participant[source]¶

Creates a new participant in a conversation.

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

def sample_create_participant():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.CreateParticipantRequest, dict]) – The request object. The request message for [Participants.CreateParticipant][google.cloud.dialogflow.v2beta1.Participants.CreateParticipant].
parent (str) –
Required. Resource identifier of the conversation adding the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
participant (google.cloud.dialogflow_v2beta1.types.Participant) – Required. The participant to create. This corresponds to the participant 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

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

ParticipantsClient

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

ParticipantsClient

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

ParticipantsClient

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

get_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.GetParticipantRequest, 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.participant.Participant[source]¶

Retrieves a conversation participant.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.GetParticipantRequest, dict]) – The request object. The request message for [Participants.GetParticipant][google.cloud.dialogflow.v2beta1.Participants.GetParticipant].
name (str) –
Required. The name of the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

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

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

list_participants(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsRequest, 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.participants.pagers.ListParticipantsPager[source]¶

Returns the list of all participants in the specified 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

def sample_list_participants():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsClient()

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

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

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

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.ListParticipantsRequest, dict]) – The request object. The request message for [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants].
parent (str) –
Required. The conversation to list all participants from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation 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: [Participants.ListParticipants][google.cloud.dialogflow.v2beta1.Participants.ListParticipants].

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

Return type

google.cloud.dialogflow_v2beta1.services.participants.pagers.ListParticipantsPager

list_suggestions(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsRequest, dict]] = 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.participants.pagers.ListSuggestionsPager[source]¶

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions 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

def sample_list_suggestions():
    # Create a client
    client = dialogflow_v2beta1.ParticipantsClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListSuggestionsRequest(
    )

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

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

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.ListSuggestionsRequest, dict]) – The request object. The request message for [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions].
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: [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions].

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

Return type

google.cloud.dialogflow_v2beta1.services.participants.pagers.ListSuggestionsPager

static message_path(project: str, conversation: str, message: str) → str[source]¶: Returns a fully-qualified message string.

static parse_answer_record_path(path: str) → Dict[str, str][source]¶: Parses a answer_record 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_context_path(path: str) → Dict[str, str][source]¶: Parses a context 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_intent_path(path: str) → Dict[str, str][source]¶: Parses a intent path into its component segments.

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

static parse_participant_path(path: str) → Dict[str, str][source]¶: Parses a participant 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 parse_session_entity_type_path(path: str) → Dict[str, str][source]¶: Parses a session_entity_type path into its component segments.

static participant_path(project: str, conversation: str, participant: str) → str[source]¶: Returns a fully-qualified participant string.

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

static session_entity_type_path(project: str, session: str, entity_type: str) → str[source]¶: Returns a fully-qualified session_entity_type string.

streaming_analyze_content(requests: Optional[Iterator[google.cloud.dialogflow_v2beta1.types.participant.StreamingAnalyzeContentRequest]] = 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]] = ()) → Iterable[google.cloud.dialogflow_v2beta1.types.participant.StreamingAnalyzeContentResponse][source]¶

Adds a text (e.g., chat) or audio (e.g., phone recording) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field, and potentially the reply_audio and/or the automated_agent_reply fields.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

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

    # Initialize request argument(s)
    audio_config = dialogflow_v2beta1.InputAudioConfig()
    audio_config.audio_encoding = "AUDIO_ENCODING_ALAW"
    audio_config.sample_rate_hertz = 1817
    audio_config.language_code = "language_code_value"

    request = dialogflow_v2beta1.StreamingAnalyzeContentRequest(
        audio_config=audio_config,
        input_audio=b'input_audio_blob',
        participant="participant_value",
    )

    # This method expects an iterator which contains
    # 'dialogflow_v2beta1.StreamingAnalyzeContentRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = client.streaming_analyze_content(requests=request_generator())

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

Parameters

requests (Iterator[google.cloud.dialogflow_v2beta1.types.StreamingAnalyzeContentRequest]) –
The request object iterator. The top-level message sent by the client to the [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method.

Multiple request messages should be sent in order:
1. The first message must contain [participant][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.participant], [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionally [query_params][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.query_params]. If you want to receive an audio response, it should also contain [reply_audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.reply_audio_config]. The message must not contain [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input].
2. If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.audio_config], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_audio] to continue with Speech recognition. If you decide to rather analyze text input after you already started Speech recognition, please send a message with [StreamingAnalyzeContentRequest.input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text].
  
  However, note that:
  - Dialogflow will bill you for the audio so far.
  - Dialogflow discards all Speech recognition results in favor of the text input.
3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.text_config], then the second message must contain only [input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text]. Moreover, you must not send more than two messages.
After you sent all input, you must half-close or abort the request stream.
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 top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.

In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply.

In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

Return type

Iterable[google.cloud.dialogflow_v2beta1.types.StreamingAnalyzeContentResponse]

suggest_articles(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestArticlesRequest, 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.types.participant.SuggestArticlesResponse[source]¶

Gets suggested articles for a participant based on specific historical messages.

Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.SuggestArticlesRequest, dict]) – The request object. The request message for [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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: [Participants.SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestArticlesResponse

suggest_faq_answers(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestFaqAnswersRequest, 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.types.participant.SuggestFaqAnswersResponse[source]¶

Gets suggested faq answers for a participant based on specific historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.SuggestFaqAnswersRequest, dict]) – The request object. The request message for [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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 request message for: [Participants.SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestFaqAnswersResponse

suggest_knowledge_assist(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestKnowledgeAssistRequest, dict]] = 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.participant.SuggestKnowledgeAssistResponse[source]¶

Gets knowledge assist suggestions based on historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.SuggestKnowledgeAssistRequest, dict]) – The request object. The request message for [Participants.SuggestKnowledgeAssist][google.cloud.dialogflow.v2beta1.Participants.SuggestKnowledgeAssist].
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: [Participants.SuggestKnowledgeAssist][google.cloud.dialogflow.v2beta1.Participants.SuggestKnowledgeAssist].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestKnowledgeAssistResponse

suggest_smart_replies(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.SuggestSmartRepliesRequest, 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.types.participant.SuggestSmartRepliesResponse[source]¶

Gets smart replies for a participant based on specific historical messages.

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.SuggestSmartRepliesRequest, dict]) – The request object. The request message for [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies].
parent (str) –
Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant 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: [Participants.SuggestSmartReplies][google.cloud.dialogflow.v2beta1.Participants.SuggestSmartReplies].

Return type

google.cloud.dialogflow_v2beta1.types.SuggestSmartRepliesResponse

property transport: google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

ParticipantsTransport

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_participant(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.participant.UpdateParticipantRequest, dict]] = None, *, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = 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.participant.Participant[source]¶

Updates the specified participant.

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

    # Initialize request argument(s)
    request = dialogflow_v2beta1.UpdateParticipantRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.UpdateParticipantRequest, dict]) – The request object. The request message for [Participants.UpdateParticipant][google.cloud.dialogflow.v2beta1.Participants.UpdateParticipant].
participant (google.cloud.dialogflow_v2beta1.types.Participant) – Required. The participant to update. This corresponds to the participant 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 specify 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

Represents a conversation participant (human agent, virtual agent, end-user).

Return type

google.cloud.dialogflow_v2beta1.types.Participant

class google.cloud.dialogflow_v2beta1.services.participants.pagers.ListParticipantsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsResponse]], request: google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsRequest, response: google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsResponse, *, 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_participants requests.

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

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

All the usual google.cloud.dialogflow_v2beta1.types.ListParticipantsResponse 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.ListParticipantsRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListParticipantsResponse) – 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.participants.pagers.ListParticipantsPager(method: Callable[[...], google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsResponse], request: google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsRequest, response: google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsResponse, *, 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_participants requests.

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

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

All the usual google.cloud.dialogflow_v2beta1.types.ListParticipantsResponse 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.ListParticipantsRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListParticipantsResponse) – 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.

class google.cloud.dialogflow_v2beta1.services.participants.pagers.ListSuggestionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsResponse]], request: google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsRequest, response: google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsResponse, *, 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_suggestions requests.

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

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

All the usual google.cloud.dialogflow_v2beta1.types.ListSuggestionsResponse 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.ListSuggestionsRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListSuggestionsResponse) – 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.participants.pagers.ListSuggestionsPager(method: Callable[[...], google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsResponse], request: google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsRequest, response: google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsResponse, *, 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_suggestions requests.

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

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

All the usual google.cloud.dialogflow_v2beta1.types.ListSuggestionsResponse 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.ListSuggestionsRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListSuggestionsResponse) – 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.

Participants¶

google-cloud-dialogflow

Navigation

Related Topics