ParticipantsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.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_v2.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 |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
analyze_content
analyze_content(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.AnalyzeContentRequest, dict]] = None, *, participant: Optional[str] = None, text_input: Optional[google.cloud.dialogflow_v2.types.session.TextInput] = None, event_input: Optional[google.cloud.dialogflow_v2.types.session.EventInput] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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>
__.
from google.cloud import dialogflow_v2
def sample_analyze_content():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
text_input = dialogflow_v2.TextInput()
text_input.text = "text_value"
text_input.language_code = "language_code_value"
request = dialogflow_v2.AnalyzeContentRequest(
text_input=text_input,
participant="participant_value",
)
# Make the request
response = client.analyze_content(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.AnalyzeContentRequest, dict]
The request object. The request message for Participants.AnalyzeContent. |
participant |
str
Required. The name of the participant this text comes from. Format: |
text_input |
google.cloud.dialogflow_v2.types.TextInput
The natural language text to be processed. This corresponds to the |
event_input |
google.cloud.dialogflow_v2.types.EventInput
An input event to send to Dialogflow. This corresponds to the |
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_v2.types.AnalyzeContentResponse | The response message for Participants.AnalyzeContent. |
answer_record_path
answer_record_path(project: str, answer_record: str)
Returns a fully-qualified answer_record string.
cancel_operation
cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
common_billing_account_path
common_billing_account_path(billing_account: str)
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.
context_path
context_path(project: str, session: str, context: str)
Returns a fully-qualified context string.
create_participant
create_participant(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.CreateParticipantRequest, dict]] = None, *, parent: Optional[str] = None, participant: Optional[google.cloud.dialogflow_v2.types.participant.Participant] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new participant in a conversation.
from google.cloud import dialogflow_v2
def sample_create_participant():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.CreateParticipantRequest(
parent="parent_value",
)
# Make the request
response = client.create_participant(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.CreateParticipantRequest, dict]
The request object. The request message for Participants.CreateParticipant. |
parent |
str
Required. Resource identifier of the conversation adding the participant. Format: |
participant |
google.cloud.dialogflow_v2.types.Participant
Required. The participant to create. This corresponds to the |
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_v2.types.Participant | Represents a conversation participant (human agent, virtual agent, end-user). |
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_location
get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Location object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_operation
get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
| An Operation object. |
get_participant
get_participant(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.GetParticipantRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves a conversation participant.
from google.cloud import dialogflow_v2
def sample_get_participant():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.GetParticipantRequest(
name="name_value",
)
# Make the request
response = client.get_participant(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.GetParticipantRequest, dict]
The request object. The request message for Participants.GetParticipant. |
name |
str
Required. The name of the participant. Format: |
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_v2.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_locations
list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
| Response message for ListLocations method. |
list_operations
list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
| Response message for ListOperations method. |
list_participants
list_participants(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.ListParticipantsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all participants in the specified conversation.
from google.cloud import dialogflow_v2
def sample_list_participants():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.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 | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.ListParticipantsRequest, dict]
The request object. The request message for Participants.ListParticipants. |
parent |
str
Required. The conversation to list all participants from. Format: |
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_v2.services.participants.pagers.ListParticipantsPager | The response message for Participants.ListParticipants. 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_answer_record_path
parse_answer_record_path(path: str)
Parses a answer_record path into its component segments.
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_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[Union[google.cloud.dialogflow_v2.types.participant.SuggestArticlesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import dialogflow_v2
def sample_suggest_articles():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.SuggestArticlesRequest(
parent="parent_value",
)
# Make the request
response = client.suggest_articles(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.SuggestArticlesRequest, dict]
The request object. The request message for Participants.SuggestArticles. |
parent |
str
Required. The name of the participant to fetch suggestion for. Format: |
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_v2.types.SuggestArticlesResponse | The response message for Participants.SuggestArticles. |
suggest_faq_answers
suggest_faq_answers(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.SuggestFaqAnswersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import dialogflow_v2
def sample_suggest_faq_answers():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.SuggestFaqAnswersRequest(
parent="parent_value",
)
# Make the request
response = client.suggest_faq_answers(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.SuggestFaqAnswersRequest, dict]
The request object. The request message for Participants.SuggestFaqAnswers. |
parent |
str
Required. The name of the participant to fetch suggestion for. Format: |
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_v2.types.SuggestFaqAnswersResponse | The request message for Participants.SuggestFaqAnswers. |
suggest_smart_replies
suggest_smart_replies(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.SuggestSmartRepliesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
from google.cloud import dialogflow_v2
def sample_suggest_smart_replies():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.SuggestSmartRepliesRequest(
parent="parent_value",
)
# Make the request
response = client.suggest_smart_replies(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.SuggestSmartRepliesRequest, dict]
The request object. The request message for Participants.SuggestSmartReplies. |
parent |
str
Required. The name of the participant to fetch suggestion for. Format: |
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_v2.types.SuggestSmartRepliesResponse | The response message for Participants.SuggestSmartReplies. |
update_participant
update_participant(request: Optional[Union[google.cloud.dialogflow_v2.types.participant.UpdateParticipantRequest, dict]] = None, *, participant: Optional[google.cloud.dialogflow_v2.types.participant.Participant] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified participant.
from google.cloud import dialogflow_v2
def sample_update_participant():
# Create a client
client = dialogflow_v2.ParticipantsClient()
# Initialize request argument(s)
request = dialogflow_v2.UpdateParticipantRequest(
)
# Make the request
response = client.update_participant(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.UpdateParticipantRequest, dict]
The request object. The request message for Participants.UpdateParticipant. |
participant |
google.cloud.dialogflow_v2.types.Participant
Required. The participant to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. The mask to specify which fields to update. This corresponds to the |
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_v2.types.Participant | Represents a conversation participant (human agent, virtual agent, end-user). |