Class ParticipantsClient (2.7.1)

ParticipantsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing Participants.

Properties

transport

Returns the transport used by the client instance.

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

Methods

ParticipantsClient

ParticipantsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.services.participants.transports.base.ParticipantsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the participants client.

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

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

analyze_content

analyze_content(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.AnalyzeContentRequest] = None, *, participant: Optional[str] = None, text_input: Optional[google.cloud.dialogflow_v2beta1.types.session.TextInput] = None, event_input: Optional[google.cloud.dialogflow_v2beta1.types.session.EventInput] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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 <https://cloud.google.com/dialogflow/es/docs/agents-versions>__.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2beta1.types.AnalyzeContentRequest` The request object. The request message for Participants.AnalyzeContent.
`participant`	`str` Required. The name of the participant this text comes from. Format: `projects/`. 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.
`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
Type	Description
`google.cloud.dialogflow_v2beta1.types.AnalyzeContentResponse`	The response message for Participants.AnalyzeContent.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

compile_suggestion

compile_suggestion(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.CompileSuggestionRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deprecated. use xref_SuggestArticles and xref_SuggestFaqAnswers instead.

Gets suggestions for a participant based on specific historical messages.

Note that xref_ListSuggestions will only list the auto-generated suggestions, while xref_CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2beta1.types.CompileSuggestionRequest` The request object. The request message for 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
Type	Description
`google.cloud.dialogflow_v2beta1.types.CompileSuggestionResponse`	The response message for Participants.CompileSuggestion.

context_path

context_path(project: str, session: str, context: str)

Returns a fully-qualified context string.

create_participant

create_participant(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.CreateParticipantRequest] = None, *, parent: Optional[str] = None, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new participant in a conversation.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2beta1.types.CreateParticipantRequest` The request object. The request message for Participants.CreateParticipant.
`parent`	`str` Required. Resource identifier of the conversation adding the participant. Format: `projects/`. 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
Type	Description
`google.cloud.dialogflow_v2beta1.types.Participant`	Represents a conversation participant (human agent, virtual agent, end-user).

document_path

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

Returns a fully-qualified document string.

from_service_account_file

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

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

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

Returns
Type	Description
`ParticipantsClient`	The constructed client.

from_service_account_info

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

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

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

Returns
Type	Description
`ParticipantsClient`	The constructed client.

from_service_account_json

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

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

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

Returns
Type	Description
`ParticipantsClient`	The constructed client.

get_participant

get_participant(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.GetParticipantRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves a conversation participant.

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

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.Participant`	Represents a conversation participant (human agent, virtual agent, end-user).

intent_path

intent_path(project: str, intent: str)

Returns a fully-qualified intent string.

list_participants

list_participants(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.ListParticipantsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all participants in the specified conversation.

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

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.services.participants.pagers.ListParticipantsPager`	The response message for Participants.ListParticipants. Iterating over this object will yield results and resolve additional pages automatically.

list_suggestions

list_suggestions(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.ListSuggestionsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See xref_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 <https://cloud.google.com/apis/design/design_patterns#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.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2beta1.types.ListSuggestionsRequest` The request object. The request message for 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
Type	Description
`google.cloud.dialogflow_v2beta1.services.participants.pagers.ListSuggestionsPager`	The response message for Participants.ListSuggestions. Iterating over this object will yield results and resolve additional pages automatically.

message_path

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

Returns a fully-qualified message string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_context_path

parse_context_path(path: str)

Parses a context path into its component segments.

parse_document_path

parse_document_path(path: str)

Parses a document path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

parse_message_path

parse_message_path(path: str)

Parses a message path into its component segments.

parse_participant_path

parse_participant_path(path: str)

Parses a participant path into its component segments.

parse_session_entity_type_path

parse_session_entity_type_path(path: str)

Parses a session_entity_type path into its component segments.

participant_path

participant_path(project: str, conversation: str, participant: str)

Returns a fully-qualified participant string.

session_entity_type_path

session_entity_type_path(project: str, session: str, entity_type: str)

Returns a fully-qualified session_entity_type string.

suggest_articles

suggest_articles(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.SuggestArticlesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Note that xref_ListSuggestions will only list the auto-generated suggestions, while xref_CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

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

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.SuggestArticlesResponse`	The response message for Participants.SuggestArticles.

suggest_faq_answers

suggest_faq_answers(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.SuggestFaqAnswersRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.SuggestFaqAnswersResponse`	The request message for Participants.SuggestFaqAnswers.

suggest_smart_replies

suggest_smart_replies(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.SuggestSmartRepliesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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

Returns
Type	Description
`google.cloud.dialogflow_v2beta1.types.SuggestSmartRepliesResponse`	The response message for Participants.SuggestSmartReplies.

update_participant

update_participant(request: Optional[google.cloud.dialogflow_v2beta1.types.participant.UpdateParticipantRequest] = None, *, participant: Optional[google.cloud.dialogflow_v2beta1.types.participant.Participant] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified participant.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2beta1.types.UpdateParticipantRequest` The request object. The request message for 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
Type	Description
`google.cloud.dialogflow_v2beta1.types.Participant`	Represents a conversation participant (human agent, virtual agent, end-user).