AgentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.agents.transports.base.AgentsTransport] = 'grpc_asyncio', 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 Agents.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
AgentsTransport | The transport used by the client instance. |
Methods
AgentsAsyncClient
AgentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.agents.transports.base.AgentsTransport] = 'grpc_asyncio', 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 agents 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,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
agent_path
agent_path(project: str, location: str, agent: str)
Returns a fully-qualified agent string.
agent_validation_result_path
agent_validation_result_path(project: str, location: str, agent: str)
Returns a fully-qualified agent_validation_result string.
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.
create_agent
create_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.CreateAgentRequest, dict]] = None, *, parent: Optional[str] = None, agent: Optional[google.cloud.dialogflowcx_v3beta1.types.agent.Agent] = 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 an agent in the specified location.
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3beta1
async def sample_create_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
agent = dialogflowcx_v3beta1.Agent()
agent.display_name = "display_name_value"
agent.default_language_code = "default_language_code_value"
agent.time_zone = "time_zone_value"
request = dialogflowcx_v3beta1.CreateAgentRequest(
parent="parent_value",
agent=agent,
)
# Make the request
response = await client.create_agent(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.CreateAgentRequest, dict]
The request object. The request message for Agents.CreateAgent. |
parent |
Required. The location to create a agent for. Format: |
agent |
Agent
Required. The agent 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.dialogflowcx_v3beta1.types.Agent | Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3beta1.EntityType], Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. |
delete_agent
delete_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.DeleteAgentRequest, 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]] = ())
Deletes the specified agent.
from google.cloud import dialogflowcx_v3beta1
async def sample_delete_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.DeleteAgentRequest(
name="name_value",
)
# Make the request
await client.delete_agent(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.DeleteAgentRequest, dict]
The request object. The request message for Agents.DeleteAgent. |
name |
Required. The name of the agent to delete. 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. |
environment_path
environment_path(project: str, location: str, agent: str, environment: str)
Returns a fully-qualified environment string.
export_agent
export_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.ExportAgentRequest, dict]] = 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]] = ())
Exports the specified agent to a binary file.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: An emptyStruct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>
__response
: xref_ExportAgentResponse
from google.cloud import dialogflowcx_v3beta1
async def sample_export_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.ExportAgentRequest(
name="name_value",
)
# Make the request
operation = client.export_agent(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.ExportAgentRequest, dict]
The request object. The request message for Agents.ExportAgent. |
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.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ExportAgentResponse The response message for Agents.ExportAgent. |
flow_path
flow_path(project: str, location: str, agent: str, flow: str)
Returns a fully-qualified flow string.
flow_validation_result_path
flow_validation_result_path(project: str, location: str, agent: str, flow: str)
Returns a fully-qualified flow_validation_result 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 |
AgentsAsyncClient | 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 |
AgentsAsyncClient | 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 |
AgentsAsyncClient | The constructed client. |
get_agent
get_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.GetAgentRequest, 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 the specified agent.
from google.cloud import dialogflowcx_v3beta1
async def sample_get_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.GetAgentRequest(
name="name_value",
)
# Make the request
response = await client.get_agent(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.GetAgentRequest, dict]
The request object. The request message for Agents.GetAgent. |
name |
Required. The name of the agent. 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.dialogflowcx_v3beta1.types.Agent | Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3beta1.EntityType], Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. |
get_agent_validation_result
get_agent_validation_result(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.GetAgentValidationResultRequest, 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]] = ())
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
from google.cloud import dialogflowcx_v3beta1
async def sample_get_agent_validation_result():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.GetAgentValidationResultRequest(
name="name_value",
)
# Make the request
response = await client.get_agent_validation_result(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.GetAgentValidationResultRequest, dict]
The request object. The request message for Agents.GetAgentValidationResult. |
name |
Required. The agent name. 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.dialogflowcx_v3beta1.types.AgentValidationResult | The response message for Agents.GetAgentValidationResult. |
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_transport_class
get_transport_class()
Returns an appropriate transport class.
list_agents
list_agents(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.ListAgentsRequest, 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 agents in the specified location.
from google.cloud import dialogflowcx_v3beta1
async def sample_list_agents():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.ListAgentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_agents(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.ListAgentsRequest, dict]
The request object. The request message for Agents.ListAgents. |
parent |
Required. The location to list all agents 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.dialogflowcx_v3beta1.services.agents.pagers.ListAgentsAsyncPager | The response message for Agents.ListAgents. Iterating over this object will yield results and resolve additional pages automatically. |
parse_agent_path
parse_agent_path(path: str)
Parses a agent path into its component segments.
parse_agent_validation_result_path
parse_agent_validation_result_path(path: str)
Parses a agent_validation_result 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_environment_path
parse_environment_path(path: str)
Parses a environment path into its component segments.
parse_flow_path
parse_flow_path(path: str)
Parses a flow path into its component segments.
parse_flow_validation_result_path
parse_flow_validation_result_path(path: str)
Parses a flow_validation_result path into its component segments.
parse_security_settings_path
parse_security_settings_path(path: str)
Parses a security_settings path into its component segments.
restore_agent
restore_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.RestoreAgentRequest, dict]] = 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]] = ())
Restores the specified agent from a binary file.
Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: An emptyStruct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>
__response
: AnEmpty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>
__
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3beta1
async def sample_restore_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.RestoreAgentRequest(
agent_uri="agent_uri_value",
name="name_value",
)
# Make the request
operation = client.restore_agent(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.RestoreAgentRequest, dict]
The request object. The request message for Agents.RestoreAgent. |
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.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
security_settings_path
security_settings_path(project: str, location: str, security_settings: str)
Returns a fully-qualified security_settings string.
update_agent
update_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.UpdateAgentRequest, dict]] = None, *, agent: Optional[google.cloud.dialogflowcx_v3beta1.types.agent.Agent] = 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 agent.
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3beta1
async def sample_update_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
agent = dialogflowcx_v3beta1.Agent()
agent.display_name = "display_name_value"
agent.default_language_code = "default_language_code_value"
agent.time_zone = "time_zone_value"
request = dialogflowcx_v3beta1.UpdateAgentRequest(
agent=agent,
)
# Make the request
response = await client.update_agent(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.UpdateAgentRequest, dict]
The request object. The request message for Agents.UpdateAgent. |
agent |
Agent
Required. The agent to update. This corresponds to the |
update_mask |
The mask to control which fields get updated. If the mask is not present, all fields will be updated. 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.dialogflowcx_v3beta1.types.Agent | Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3beta1.EntityType], Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. |
validate_agent
validate_agent(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.agent.ValidateAgentRequest, dict]] = 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]] = ())
Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
from google.cloud import dialogflowcx_v3beta1
async def sample_validate_agent():
# Create a client
client = dialogflowcx_v3beta1.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.ValidateAgentRequest(
name="name_value",
)
# Make the request
response = await client.validate_agent(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.ValidateAgentRequest, dict]
The request object. The request message for Agents.ValidateAgent. |
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.dialogflowcx_v3beta1.types.AgentValidationResult | The response message for Agents.GetAgentValidationResult. |