Services for Google Cloud Dialogflowcx v3 API¶
-
class
google.cloud.dialogflowcx_v3.services.agents.
AgentsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.agents.transports.base.AgentsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].
Instantiate the agents 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 (Union[str, AgentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
agent_path
(project: str, location: str, agent: str) → str¶ Return a fully-qualified agent string.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_agent
(request: google.cloud.dialogflowcx_v3.types.agent.CreateAgentRequest = None, *, parent: str = None, agent: google.cloud.dialogflowcx_v3.types.agent.Agent = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Creates an agent in the specified location.
- Parameters
request (
CreateAgentRequest
) – The request object. The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].parent (
str
) – Required. The location to create a agent for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.agent (
Agent
) – Required. The agent to create. This corresponds to theagent
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
async
delete_agent
(request: google.cloud.dialogflowcx_v3.types.agent.DeleteAgentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified agent.
- Parameters
request (
DeleteAgentRequest
) – The request object. The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].name (
str
) – Required. The name of the agent to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
async
export_agent
(request: google.cloud.dialogflowcx_v3.types.agent.ExportAgentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶ Exports the specified agent to a binary file.
- Parameters
request (
ExportAgentRequest
) – The request object. The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.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
An object representing a long-running operation.
The result type for the operation will be :class:
~.agent.ExportAgentResponse
: The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].- Return type
AsyncOperation
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str¶ Return a fully-qualified flow string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_agent
(request: google.cloud.dialogflowcx_v3.types.agent.GetAgentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Retrieves the specified agent.
- Parameters
request (
GetAgentRequest
) – The request object. The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].name (
str
) – Required. The name of the agent. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.agents.transports.base.AgentsTransport]¶ Return 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.
-
async
list_agents
(request: google.cloud.dialogflowcx_v3.types.agent.ListAgentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.agents.pagers.ListAgentsAsyncPager[source]¶ Returns the list of all agents in the specified location.
- Parameters
request (
ListAgentsRequest
) – The request object. The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].parent (
str
) – Required. The location to list all agents for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListAgentsAsyncPager
-
static
parse_agent_path
(path: str) → Dict[str, str]¶ Parse a agent 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.
-
async
restore_agent
(request: google.cloud.dialogflowcx_v3.types.agent.RestoreAgentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶ 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.
- Parameters
request (
RestoreAgentRequest
) – The request object. The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.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
An object representing a long-running operation.
The result type for the operation will be :class:
~.empty.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{}
.- Return type
AsyncOperation
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
AgentsTransport
-
async
update_agent
(request: google.cloud.dialogflowcx_v3.types.agent.UpdateAgentRequest = None, *, agent: google.cloud.dialogflowcx_v3.types.agent.Agent = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Updates the specified agent.
- Parameters
request (
UpdateAgentRequest
) – The request object. The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].agent (
Agent
) – Required. The agent to update. This corresponds to theagent
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
class
google.cloud.dialogflowcx_v3.services.agents.
AgentsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.agents.transports.base.AgentsTransport]] = 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>)[source]¶ Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].
Instantiate the agents 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 (Union[str, AgentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
agent_path
(project: str, location: str, agent: str) → str[source]¶ Return a fully-qualified agent string.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_agent
(request: google.cloud.dialogflowcx_v3.types.agent.CreateAgentRequest = None, *, parent: str = None, agent: google.cloud.dialogflowcx_v3.types.agent.Agent = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Creates an agent in the specified location.
- Parameters
request (
CreateAgentRequest
) – The request object. The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].parent (
str
) – Required. The location to create a agent for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.agent (
Agent
) – Required. The agent to create. This corresponds to theagent
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
delete_agent
(request: google.cloud.dialogflowcx_v3.types.agent.DeleteAgentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified agent.
- Parameters
request (
DeleteAgentRequest
) – The request object. The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].name (
str
) – Required. The name of the agent to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
export_agent
(request: google.cloud.dialogflowcx_v3.types.agent.ExportAgentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶ Exports the specified agent to a binary file.
- Parameters
request (
ExportAgentRequest
) – The request object. The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.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
An object representing a long-running operation.
The result type for the operation will be :class:
~.agent.ExportAgentResponse
: The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].- Return type
Operation
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str[source]¶ Return a fully-qualified flow 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
-
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
-
get_agent
(request: google.cloud.dialogflowcx_v3.types.agent.GetAgentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Retrieves the specified agent.
- Parameters
request (
GetAgentRequest
) – The request object. The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].name (
str
) – Required. The name of the agent. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
list_agents
(request: google.cloud.dialogflowcx_v3.types.agent.ListAgentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.agents.pagers.ListAgentsPager[source]¶ Returns the list of all agents in the specified location.
- Parameters
request (
ListAgentsRequest
) – The request object. The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].parent (
str
) – Required. The location to list all agents for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListAgentsPager
-
static
parse_agent_path
(path: str) → Dict[str, str][source]¶ Parse a agent 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_flow_path
(path: str) → Dict[str, str][source]¶ Parse a flow path into its component segments.
-
restore_agent
(request: google.cloud.dialogflowcx_v3.types.agent.RestoreAgentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶ 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.
- Parameters
request (
RestoreAgentRequest
) – The request object. The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.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
An object representing a long-running operation.
The result type for the operation will be :class:
~.empty.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{}
.- Return type
Operation
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
AgentsTransport
-
update_agent
(request: google.cloud.dialogflowcx_v3.types.agent.UpdateAgentRequest = None, *, agent: google.cloud.dialogflowcx_v3.types.agent.Agent = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.agent.Agent[source]¶ Updates the specified agent.
- Parameters
request (
UpdateAgentRequest
) – The request object. The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].agent (
Agent
) – Required. The agent to update. This corresponds to theagent
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
- Return type
Agent
-
class
google.cloud.dialogflowcx_v3.services.entity_types.
EntityTypesAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.entity_types.transports.base.EntityTypesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].
Instantiate the entity types 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 (Union[str, EntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.CreateEntityTypeRequest = None, *, parent: str = None, entity_type: google.cloud.dialogflowcx_v3.types.entity_type.EntityType = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Creates an entity type in the specified agent.
- Parameters
request (
CreateEntityTypeRequest
) – The request object. The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.CreateEntityType].parent (
str
) – Required. The agent to create a entity type for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.entity_type (
EntityType
) – Required. The entity type to create. This corresponds to theentity_type
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
async
delete_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.DeleteEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified entity type.
- Parameters
request (
DeleteEntityTypeRequest
) – The request object. The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.DeleteEntityType].name (
str
) – Required. The name of the entity type to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str¶ Return a fully-qualified entity_type string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.GetEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Retrieves the specified entity type.
- Parameters
request (
GetEntityTypeRequest
) – The request object. The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType].name (
str
) – Required. The name of the entity type. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.entity_types.transports.base.EntityTypesTransport]¶ Return 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.
-
async
list_entity_types
(request: google.cloud.dialogflowcx_v3.types.entity_type.ListEntityTypesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.entity_types.pagers.ListEntityTypesAsyncPager[source]¶ Returns the list of all entity types in the specified agent.
- Parameters
request (
ListEntityTypesRequest
) – The request object. The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].parent (
str
) – Required. The agent to list all entity types for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListEntityTypesAsyncPager
-
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_entity_type_path
(path: str) → Dict[str, str]¶ Parse a entity_type path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
EntityTypesTransport
-
async
update_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.UpdateEntityTypeRequest = None, *, entity_type: google.cloud.dialogflowcx_v3.types.entity_type.EntityType = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Updates the specified entity type.
- Parameters
request (
UpdateEntityTypeRequest
) – The request object. The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].entity_type (
EntityType
) – Required. The entity type to update. This corresponds to theentity_type
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
class
google.cloud.dialogflowcx_v3.services.entity_types.
EntityTypesClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.entity_types.transports.base.EntityTypesTransport]] = 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>)[source]¶ Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].
Instantiate the entity types 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 (Union[str, EntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.CreateEntityTypeRequest = None, *, parent: str = None, entity_type: google.cloud.dialogflowcx_v3.types.entity_type.EntityType = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Creates an entity type in the specified agent.
- Parameters
request (
CreateEntityTypeRequest
) – The request object. The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.CreateEntityType].parent (
str
) – Required. The agent to create a entity type for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.entity_type (
EntityType
) – Required. The entity type to create. This corresponds to theentity_type
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
delete_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.DeleteEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified entity type.
- Parameters
request (
DeleteEntityTypeRequest
) – The request object. The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.DeleteEntityType].name (
str
) – Required. The name of the entity type to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str[source]¶ Return a fully-qualified entity_type 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
-
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
-
get_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.GetEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Retrieves the specified entity type.
- Parameters
request (
GetEntityTypeRequest
) – The request object. The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType].name (
str
) – Required. The name of the entity type. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
list_entity_types
(request: google.cloud.dialogflowcx_v3.types.entity_type.ListEntityTypesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.entity_types.pagers.ListEntityTypesPager[source]¶ Returns the list of all entity types in the specified agent.
- Parameters
request (
ListEntityTypesRequest
) – The request object. The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].parent (
str
) – Required. The agent to list all entity types for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListEntityTypesPager
-
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_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a entity_type path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
EntityTypesTransport
-
update_entity_type
(request: google.cloud.dialogflowcx_v3.types.entity_type.UpdateEntityTypeRequest = None, *, entity_type: google.cloud.dialogflowcx_v3.types.entity_type.EntityType = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.entity_type.EntityType[source]¶ Updates the specified entity type.
- Parameters
request (
UpdateEntityTypeRequest
) – The request object. The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].entity_type (
EntityType
) – Required. The entity type to update. This corresponds to theentity_type
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
- Return type
EntityType
-
class
google.cloud.dialogflowcx_v3.services.environments.
EnvironmentsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].
Instantiate the environments 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 (Union[str, EnvironmentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_environment
(request: google.cloud.dialogflowcx_v3.types.environment.CreateEnvironmentRequest = None, *, parent: str = None, environment: google.cloud.dialogflowcx_v3.types.environment.Environment = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶ Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
- Parameters
request (
CreateEnvironmentRequest
) – The request object. The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].parent (
str
) – Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.environment (
Environment
) – Required. The environment to create. This corresponds to theenvironment
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.gcdc_environment.Environment
: Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.- Return type
AsyncOperation
-
async
delete_environment
(request: google.cloud.dialogflowcx_v3.types.environment.DeleteEnvironmentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
DeleteEnvironmentRequest
) – The request object. The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].name (
str
) – Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
environment_path
(project: str, location: str, agent: str, environment: str) → str¶ Return a fully-qualified environment string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_environment
(request: google.cloud.dialogflowcx_v3.types.environment.GetEnvironmentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.environment.Environment[source]¶ Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
GetEnvironmentRequest
) – The request object. The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].name (
str
) – Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
- Return type
Environment
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport]¶ Return 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.
-
async
list_environments
(request: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsAsyncPager[source]¶ Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
- Parameters
request (
ListEnvironmentsRequest
) – The request object. The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].parent (
str
) – Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListEnvironmentsAsyncPager
-
async
lookup_environment_history
(request: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryAsyncPager[source]¶ Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
LookupEnvironmentHistoryRequest
) – The request object. The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].name (
str
) – Required. Resource name of the environment to look up the history for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
LookupEnvironmentHistoryAsyncPager
-
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_environment_path
(path: str) → Dict[str, str]¶ Parse a environment path into its component segments.
-
static
parse_version_path
(path: str) → Dict[str, str]¶ Parse a version path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
EnvironmentsTransport
-
async
update_environment
(request: google.cloud.dialogflowcx_v3.types.environment.UpdateEnvironmentRequest = None, *, environment: google.cloud.dialogflowcx_v3.types.environment.Environment = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶ Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
UpdateEnvironmentRequest
) – The request object. The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].environment (
Environment
) – Required. The environment to update. This corresponds to theenvironment
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.gcdc_environment.Environment
: Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.- Return type
AsyncOperation
-
class
google.cloud.dialogflowcx_v3.services.environments.
EnvironmentsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport]] = 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>)[source]¶ Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].
Instantiate the environments 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 (Union[str, EnvironmentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_environment
(request: google.cloud.dialogflowcx_v3.types.environment.CreateEnvironmentRequest = None, *, parent: str = None, environment: google.cloud.dialogflowcx_v3.types.environment.Environment = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶ Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
- Parameters
request (
CreateEnvironmentRequest
) – The request object. The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].parent (
str
) – Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.environment (
Environment
) – Required. The environment to create. This corresponds to theenvironment
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.gcdc_environment.Environment
: Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.- Return type
Operation
-
delete_environment
(request: google.cloud.dialogflowcx_v3.types.environment.DeleteEnvironmentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
DeleteEnvironmentRequest
) – The request object. The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].name (
str
) – Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
environment_path
(project: str, location: str, agent: str, environment: str) → str[source]¶ Return a fully-qualified environment 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
-
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
-
get_environment
(request: google.cloud.dialogflowcx_v3.types.environment.GetEnvironmentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.environment.Environment[source]¶ Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
GetEnvironmentRequest
) – The request object. The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].name (
str
) – Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.
- Return type
Environment
-
list_environments
(request: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsPager[source]¶ Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
- Parameters
request (
ListEnvironmentsRequest
) – The request object. The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].parent (
str
) – Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListEnvironmentsPager
-
lookup_environment_history
(request: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryPager[source]¶ Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
LookupEnvironmentHistoryRequest
) – The request object. The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].name (
str
) – Required. Resource name of the environment to look up the history for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
LookupEnvironmentHistoryPager
-
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_environment_path
(path: str) → Dict[str, str][source]¶ Parse a environment path into its component segments.
-
static
parse_version_path
(path: str) → Dict[str, str][source]¶ Parse a version path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
EnvironmentsTransport
-
update_environment
(request: google.cloud.dialogflowcx_v3.types.environment.UpdateEnvironmentRequest = None, *, environment: google.cloud.dialogflowcx_v3.types.environment.Environment = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶ Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].
- Parameters
request (
UpdateEnvironmentRequest
) – The request object. The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].environment (
Environment
) – Required. The environment to update. This corresponds to theenvironment
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.gcdc_environment.Environment
: Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.- Return type
Operation
-
class
google.cloud.dialogflowcx_v3.services.flows.
FlowsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
Instantiate the flows 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 (Union[str, FlowsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_flow
(request: google.cloud.dialogflowcx_v3.types.flow.CreateFlowRequest = None, *, parent: str = None, flow: google.cloud.dialogflowcx_v3.types.flow.Flow = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Creates a flow in the specified agent.
- Parameters
request (
CreateFlowRequest
) – The request object. The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].parent (
str
) – Required. The agent to create a flow for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.flow (
Flow
) – Required. The flow to create. This corresponds to theflow
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
async
delete_flow
(request: google.cloud.dialogflowcx_v3.types.flow.DeleteFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes a specified flow.
- Parameters
request (
DeleteFlowRequest
) – The request object. The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].name (
str
) – Required. The name of the flow to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str¶ Return a fully-qualified flow string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_flow
(request: google.cloud.dialogflowcx_v3.types.flow.GetFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Retrieves the specified flow.
- Parameters
request (
GetFlowRequest
) – The request object. The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].name (
str
) – Required. The name of the flow to get. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport]¶ Return 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, location: str, agent: str, intent: str) → str¶ Return a fully-qualified intent string.
-
async
list_flows
(request: google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsAsyncPager[source]¶ Returns the list of all flows in the specified agent.
- Parameters
request (
ListFlowsRequest
) – The request object. The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].parent (
str
) – Required. The agent containing the flows. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListFlowsAsyncPager
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str¶ Return a fully-qualified page string.
-
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_intent_path
(path: str) → Dict[str, str]¶ Parse a intent path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str]¶ Parse a webhook path into its component segments.
-
async
train_flow
(request: google.cloud.dialogflowcx_v3.types.flow.TrainFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶ Trains the specified flow. Note that only the flow in ‘draft’ environment is trained.
- Parameters
request (
TrainFlowRequest
) – The request object. The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].name (
str
) – Required. The flow to train. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.empty.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{}
.- Return type
AsyncOperation
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
FlowsTransport
-
async
update_flow
(request: google.cloud.dialogflowcx_v3.types.flow.UpdateFlowRequest = None, *, flow: google.cloud.dialogflowcx_v3.types.flow.Flow = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Updates the specified flow.
- Parameters
request (
UpdateFlowRequest
) – The request object. The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].flow (
Flow
) – Required. The flow to update. This corresponds to theflow
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. Ifupdate_mask
is not specified, an error will be returned. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
class
google.cloud.dialogflowcx_v3.services.flows.
FlowsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport]] = 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>)[source]¶ Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
Instantiate the flows 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 (Union[str, FlowsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_flow
(request: google.cloud.dialogflowcx_v3.types.flow.CreateFlowRequest = None, *, parent: str = None, flow: google.cloud.dialogflowcx_v3.types.flow.Flow = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Creates a flow in the specified agent.
- Parameters
request (
CreateFlowRequest
) – The request object. The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].parent (
str
) – Required. The agent to create a flow for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.flow (
Flow
) – Required. The flow to create. This corresponds to theflow
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
delete_flow
(request: google.cloud.dialogflowcx_v3.types.flow.DeleteFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes a specified flow.
- Parameters
request (
DeleteFlowRequest
) – The request object. The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].name (
str
) – Required. The name of the flow to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str[source]¶ Return a fully-qualified flow 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
-
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
-
get_flow
(request: google.cloud.dialogflowcx_v3.types.flow.GetFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Retrieves the specified flow.
- Parameters
request (
GetFlowRequest
) – The request object. The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].name (
str
) – Required. The name of the flow to get. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
static
intent_path
(project: str, location: str, agent: str, intent: str) → str[source]¶ Return a fully-qualified intent string.
-
list_flows
(request: google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsPager[source]¶ Returns the list of all flows in the specified agent.
- Parameters
request (
ListFlowsRequest
) – The request object. The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].parent (
str
) – Required. The agent containing the flows. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListFlowsPager
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str[source]¶ Return a fully-qualified page string.
-
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_flow_path
(path: str) → Dict[str, str][source]¶ Parse a flow path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str][source]¶ Parse a intent path into its component segments.
-
static
parse_page_path
(path: str) → Dict[str, str][source]¶ Parse a page path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str][source]¶ Parse a webhook path into its component segments.
-
train_flow
(request: google.cloud.dialogflowcx_v3.types.flow.TrainFlowRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶ Trains the specified flow. Note that only the flow in ‘draft’ environment is trained.
- Parameters
request (
TrainFlowRequest
) – The request object. The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].name (
str
) – Required. The flow to train. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be :class:
~.empty.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{}
.- Return type
Operation
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
FlowsTransport
-
update_flow
(request: google.cloud.dialogflowcx_v3.types.flow.UpdateFlowRequest = None, *, flow: google.cloud.dialogflowcx_v3.types.flow.Flow = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.flow.Flow[source]¶ Updates the specified flow.
- Parameters
request (
UpdateFlowRequest
) – The request object. The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].flow (
Flow
) – Required. The flow to update. This corresponds to theflow
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. Ifupdate_mask
is not specified, an error will be returned. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
- Return type
Flow
-
class
google.cloud.dialogflowcx_v3.services.intents.
IntentsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.intents.transports.base.IntentsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent].
Instantiate the intents 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 (Union[str, IntentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_intent
(request: google.cloud.dialogflowcx_v3.types.intent.CreateIntentRequest = None, *, parent: str = None, intent: google.cloud.dialogflowcx_v3.types.intent.Intent = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Creates an intent in the specified agent.
- Parameters
request (
CreateIntentRequest
) – The request object. The request message for [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent].parent (
str
) – Required. The agent to create an intent for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.intent (
Intent
) – Required. The intent to create. This corresponds to theintent
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
async
delete_intent
(request: google.cloud.dialogflowcx_v3.types.intent.DeleteIntentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified intent.
- Parameters
request (
DeleteIntentRequest
) – The request object. The request message for [Intents.DeleteIntent][google.cloud.dialogflow.cx.v3.Intents.DeleteIntent].name (
str
) – Required. The name of the intent to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str¶ Return a fully-qualified entity_type string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_intent
(request: google.cloud.dialogflowcx_v3.types.intent.GetIntentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Retrieves the specified intent.
- Parameters
request (
GetIntentRequest
) – The request object. The request message for [Intents.GetIntent][google.cloud.dialogflow.cx.v3.Intents.GetIntent].name (
str
) – Required. The name of the intent. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.intents.transports.base.IntentsTransport]¶ Return 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, location: str, agent: str, intent: str) → str¶ Return a fully-qualified intent string.
-
async
list_intents
(request: google.cloud.dialogflowcx_v3.types.intent.ListIntentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.intents.pagers.ListIntentsAsyncPager[source]¶ Returns the list of all intents in the specified agent.
- Parameters
request (
ListIntentsRequest
) – The request object. The request message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].parent (
str
) – Required. The agent to list all intents for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListIntentsAsyncPager
-
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_entity_type_path
(path: str) → Dict[str, str]¶ Parse a entity_type path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str]¶ Parse a intent path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
IntentsTransport
-
async
update_intent
(request: google.cloud.dialogflowcx_v3.types.intent.UpdateIntentRequest = None, *, intent: google.cloud.dialogflowcx_v3.types.intent.Intent = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Updates the specified intent.
- Parameters
request (
UpdateIntentRequest
) – The request object. The request message for [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent].intent (
Intent
) – Required. The intent to update. This corresponds to theintent
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
class
google.cloud.dialogflowcx_v3.services.intents.
IntentsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.intents.transports.base.IntentsTransport]] = 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>)[source]¶ Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent].
Instantiate the intents 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 (Union[str, IntentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_intent
(request: google.cloud.dialogflowcx_v3.types.intent.CreateIntentRequest = None, *, parent: str = None, intent: google.cloud.dialogflowcx_v3.types.intent.Intent = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Creates an intent in the specified agent.
- Parameters
request (
CreateIntentRequest
) – The request object. The request message for [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent].parent (
str
) – Required. The agent to create an intent for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.intent (
Intent
) – Required. The intent to create. This corresponds to theintent
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
delete_intent
(request: google.cloud.dialogflowcx_v3.types.intent.DeleteIntentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified intent.
- Parameters
request (
DeleteIntentRequest
) – The request object. The request message for [Intents.DeleteIntent][google.cloud.dialogflow.cx.v3.Intents.DeleteIntent].name (
str
) – Required. The name of the intent to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str[source]¶ Return a fully-qualified entity_type 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
-
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
-
get_intent
(request: google.cloud.dialogflowcx_v3.types.intent.GetIntentRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Retrieves the specified intent.
- Parameters
request (
GetIntentRequest
) – The request object. The request message for [Intents.GetIntent][google.cloud.dialogflow.cx.v3.Intents.GetIntent].name (
str
) – Required. The name of the intent. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
static
intent_path
(project: str, location: str, agent: str, intent: str) → str[source]¶ Return a fully-qualified intent string.
-
list_intents
(request: google.cloud.dialogflowcx_v3.types.intent.ListIntentsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.intents.pagers.ListIntentsPager[source]¶ Returns the list of all intents in the specified agent.
- Parameters
request (
ListIntentsRequest
) – The request object. The request message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].parent (
str
) – Required. The agent to list all intents for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListIntentsPager
-
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_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a entity_type path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str][source]¶ Parse a intent path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
IntentsTransport
-
update_intent
(request: google.cloud.dialogflowcx_v3.types.intent.UpdateIntentRequest = None, *, intent: google.cloud.dialogflowcx_v3.types.intent.Intent = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.intent.Intent[source]¶ Updates the specified intent.
- Parameters
request (
UpdateIntentRequest
) – The request object. The request message for [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent].intent (
Intent
) – Required. The intent to update. This corresponds to theintent
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
- Return type
Intent
-
class
google.cloud.dialogflowcx_v3.services.pages.
PagesAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].
Instantiate the pages 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 (Union[str, PagesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_page
(request: google.cloud.dialogflowcx_v3.types.page.CreatePageRequest = None, *, parent: str = None, page: google.cloud.dialogflowcx_v3.types.page.Page = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Creates a page in the specified flow.
- Parameters
request (
CreatePageRequest
) – The request object. The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].parent (
str
) – Required. The flow to create a page for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.page (
Page
) – Required. The page to create. This corresponds to thepage
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
async
delete_page
(request: google.cloud.dialogflowcx_v3.types.page.DeletePageRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified page.
- Parameters
request (
DeletePageRequest
) – The request object. The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].name (
str
) – Required. The name of the page to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str¶ Return a fully-qualified entity_type string.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str¶ Return a fully-qualified flow string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_page
(request: google.cloud.dialogflowcx_v3.types.page.GetPageRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Retrieves the specified page.
- Parameters
request (
GetPageRequest
) – The request object. The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].name (
str
) – Required. The name of the page. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport]¶ Return 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, location: str, agent: str, intent: str) → str¶ Return a fully-qualified intent string.
-
async
list_pages
(request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesAsyncPager[source]¶ Returns the list of all pages in the specified flow.
- Parameters
request (
ListPagesRequest
) – The request object. The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].parent (
str
) – Required. The flow to list all pages for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListPagesAsyncPager
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str¶ Return a fully-qualified page string.
-
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_entity_type_path
(path: str) → Dict[str, str]¶ Parse a entity_type path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str]¶ Parse a intent path into its component segments.
-
static
parse_transition_route_group_path
(path: str) → Dict[str, str]¶ Parse a transition_route_group path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str]¶ Parse a webhook path into its component segments.
-
static
transition_route_group_path
(project: str, location: str, agent: str, flow: str, transition_route_group: str) → str¶ Return a fully-qualified transition_route_group string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
PagesTransport
-
async
update_page
(request: google.cloud.dialogflowcx_v3.types.page.UpdatePageRequest = None, *, page: google.cloud.dialogflowcx_v3.types.page.Page = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Updates the specified page.
- Parameters
request (
UpdatePageRequest
) – The request object. The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].page (
Page
) – Required. The page to update. This corresponds to thepage
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
class
google.cloud.dialogflowcx_v3.services.pages.
PagesClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport]] = 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>)[source]¶ Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].
Instantiate the pages 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 (Union[str, PagesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_page
(request: google.cloud.dialogflowcx_v3.types.page.CreatePageRequest = None, *, parent: str = None, page: google.cloud.dialogflowcx_v3.types.page.Page = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Creates a page in the specified flow.
- Parameters
request (
CreatePageRequest
) – The request object. The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].parent (
str
) – Required. The flow to create a page for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.page (
Page
) – Required. The page to create. This corresponds to thepage
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
delete_page
(request: google.cloud.dialogflowcx_v3.types.page.DeletePageRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified page.
- Parameters
request (
DeletePageRequest
) – The request object. The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].name (
str
) – Required. The name of the page to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str[source]¶ Return a fully-qualified entity_type string.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str[source]¶ Return a fully-qualified flow 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
-
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
-
get_page
(request: google.cloud.dialogflowcx_v3.types.page.GetPageRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Retrieves the specified page.
- Parameters
request (
GetPageRequest
) – The request object. The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].name (
str
) – Required. The name of the page. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
static
intent_path
(project: str, location: str, agent: str, intent: str) → str[source]¶ Return a fully-qualified intent string.
-
list_pages
(request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesPager[source]¶ Returns the list of all pages in the specified flow.
- Parameters
request (
ListPagesRequest
) – The request object. The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].parent (
str
) – Required. The flow to list all pages for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListPagesPager
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str[source]¶ Return a fully-qualified page string.
-
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_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a entity_type path into its component segments.
-
static
parse_flow_path
(path: str) → Dict[str, str][source]¶ Parse a flow path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str][source]¶ Parse a intent path into its component segments.
-
static
parse_page_path
(path: str) → Dict[str, str][source]¶ Parse a page path into its component segments.
-
static
parse_transition_route_group_path
(path: str) → Dict[str, str][source]¶ Parse a transition_route_group path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str][source]¶ Parse a webhook path into its component segments.
-
static
transition_route_group_path
(project: str, location: str, agent: str, flow: str, transition_route_group: str) → str[source]¶ Return a fully-qualified transition_route_group string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
PagesTransport
-
update_page
(request: google.cloud.dialogflowcx_v3.types.page.UpdatePageRequest = None, *, page: google.cloud.dialogflowcx_v3.types.page.Page = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.page.Page[source]¶ Updates the specified page.
- Parameters
request (
UpdatePageRequest
) – The request object. The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].page (
Page
) – Required. The page to update. This corresponds to thepage
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.
For more information, see the Page guide.
- Return type
Page
-
class
google.cloud.dialogflowcx_v3.services.security_settings_service.
SecuritySettingsServiceAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing security settings for Dialogflow.
Instantiate the security settings service 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 (Union[str, SecuritySettingsServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.CreateSecuritySettingsRequest = None, *, parent: str = None, security_settings: google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Create security settings in the specified location.
- Parameters
request (
CreateSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.CreateSecuritySettings][].parent (
str
) – Required. The location to create an [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.security_settings (
SecuritySettings
) – Required. The security settings to create. This corresponds to thesecurity_settings
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
async
delete_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.DeleteSecuritySettingsRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
- Parameters
request (
DeleteSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.DeleteSecuritySettings][].name (
str
) – Required. The name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format:projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.GetSecuritySettingsRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The returned settings may be stale by up to 1 minute.
- Parameters
request (
GetSecuritySettingsRequest
) – The request object. The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].name (
str
) – Required. Resource name of the settings. Format:projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport]¶ Return 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.
-
async
list_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.ListSecuritySettingsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.security_settings_service.pagers.ListSecuritySettingsAsyncPager[source]¶ Returns the list of all security settings in the specified location.
- Parameters
request (
ListSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.ListSecuritySettings][].parent (
str
) – Required. The location to list all security settings for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [SecuritySettings.ListSecuritySettings][].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListSecuritySettingsAsyncPager
-
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_security_settings_path
(path: str) → Dict[str, str]¶ Parse a security_settings path into its component segments.
-
static
security_settings_path
(project: str, location: str, security_settings: str) → str¶ Return a fully-qualified security_settings string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SecuritySettingsServiceTransport
-
async
update_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.UpdateSecuritySettingsRequest = None, *, security_settings: google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
- Parameters
request (
UpdateSecuritySettingsRequest
) – The request object. The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].security_settings (
SecuritySettings
) – Required. [SecuritySettings] object that contains values for each of the fields to update. This corresponds to thesecurity_settings
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
class
google.cloud.dialogflowcx_v3.services.security_settings_service.
SecuritySettingsServiceClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport]] = 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>)[source]¶ Service for managing security settings for Dialogflow.
Instantiate the security settings service 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 (Union[str, SecuritySettingsServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.CreateSecuritySettingsRequest = None, *, parent: str = None, security_settings: google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Create security settings in the specified location.
- Parameters
request (
CreateSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.CreateSecuritySettings][].parent (
str
) – Required. The location to create an [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.security_settings (
SecuritySettings
) – Required. The security settings to create. This corresponds to thesecurity_settings
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
delete_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.DeleteSecuritySettingsRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
- Parameters
request (
DeleteSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.DeleteSecuritySettings][].name (
str
) – Required. The name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format:projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
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
-
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
-
get_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.GetSecuritySettingsRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The returned settings may be stale by up to 1 minute.
- Parameters
request (
GetSecuritySettingsRequest
) – The request object. The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].name (
str
) – Required. Resource name of the settings. Format:projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
list_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.ListSecuritySettingsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.security_settings_service.pagers.ListSecuritySettingsPager[source]¶ Returns the list of all security settings in the specified location.
- Parameters
request (
ListSecuritySettingsRequest
) – The request object. The request message for [SecuritySettings.ListSecuritySettings][].parent (
str
) – Required. The location to list all security settings for. Format:projects/<Project ID>/locations/<Location ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [SecuritySettings.ListSecuritySettings][].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListSecuritySettingsPager
-
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_security_settings_path
(path: str) → Dict[str, str][source]¶ Parse a security_settings path into its component segments.
-
static
security_settings_path
(project: str, location: str, security_settings: str) → str[source]¶ Return a fully-qualified security_settings string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SecuritySettingsServiceTransport
-
update_security_settings
(request: google.cloud.dialogflowcx_v3.types.security_settings.UpdateSecuritySettingsRequest = None, *, security_settings: google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.security_settings.SecuritySettings[source]¶ Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
- Parameters
request (
UpdateSecuritySettingsRequest
) – The request object. The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].security_settings (
SecuritySettings
) – Required. [SecuritySettings] object that contains values for each of the fields to update. This corresponds to thesecurity_settings
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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 the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
- Return type
SecuritySettings
-
class
google.cloud.dialogflowcx_v3.services.session_entity_types.
SessionEntityTypesAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.session_entity_types.transports.base.SessionEntityTypesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
Instantiate the session entity types 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 (Union[str, SessionEntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.CreateSessionEntityTypeRequest = None, *, parent: str = None, session_entity_type: google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.
- Parameters
request (
CreateSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].parent (
str
) – Required. The session to create a session entity type for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.session_entity_type (
SessionEntityType
) – Required. The session entity type to create. This corresponds to thesession_entity_type
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
async
delete_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.DeleteSessionEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified session entity type.
- Parameters
request (
DeleteSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].name (
str
) – Required. The name of the session entity type to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.GetSessionEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Retrieves the specified session entity type.
- Parameters
request (
GetSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].name (
str
) – Required. The name of the session entity type. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thename
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.session_entity_types.transports.base.SessionEntityTypesTransport]¶ Return 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.
-
async
list_session_entity_types
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager[source]¶ Returns the list of all session entity types in the specified session.
- Parameters
request (
ListSessionEntityTypesRequest
) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].parent (
str
) – Required. The session to list all session entity types from. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to theparent
field on therequest
instance; ifrequest
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 [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListSessionEntityTypesAsyncPager
-
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_session_entity_type_path
(path: str) → Dict[str, str]¶ Parse a session_entity_type path into its component segments.
-
static
session_entity_type_path
(project: str, location: str, agent: str, session: str, entity_type: str) → str¶ Return a fully-qualified session_entity_type string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SessionEntityTypesTransport
-
async
update_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.UpdateSessionEntityTypeRequest = None, *, session_entity_type: google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Updates the specified session entity type.
- Parameters
request (
UpdateSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].session_entity_type (
SessionEntityType
) – Required. The session entity type to update. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thesession_entity_type
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
class
google.cloud.dialogflowcx_v3.services.session_entity_types.
SessionEntityTypesClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.session_entity_types.transports.base.SessionEntityTypesTransport]] = 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>)[source]¶ Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
Instantiate the session entity types 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 (Union[str, SessionEntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.CreateSessionEntityTypeRequest = None, *, parent: str = None, session_entity_type: google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.
- Parameters
request (
CreateSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].parent (
str
) – Required. The session to create a session entity type for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.session_entity_type (
SessionEntityType
) – Required. The session entity type to create. This corresponds to thesession_entity_type
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
delete_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.DeleteSessionEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified session entity type.
- Parameters
request (
DeleteSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].name (
str
) – Required. The name of the session entity type to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
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
-
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
-
get_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.GetSessionEntityTypeRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Retrieves the specified session entity type.
- Parameters
request (
GetSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].name (
str
) – Required. The name of the session entity type. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thename
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
list_session_entity_types
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesPager[source]¶ Returns the list of all session entity types in the specified session.
- Parameters
request (
ListSessionEntityTypesRequest
) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].parent (
str
) – Required. The session to list all session entity types from. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to theparent
field on therequest
instance; ifrequest
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 [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListSessionEntityTypesPager
-
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_session_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a session_entity_type path into its component segments.
-
static
session_entity_type_path
(project: str, location: str, agent: str, session: str, entity_type: str) → str[source]¶ Return a fully-qualified session_entity_type string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SessionEntityTypesTransport
-
update_session_entity_type
(request: google.cloud.dialogflowcx_v3.types.session_entity_type.UpdateSessionEntityTypeRequest = None, *, session_entity_type: google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]¶ Updates the specified session entity type.
- Parameters
request (
UpdateSessionEntityTypeRequest
) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].session_entity_type (
SessionEntityType
) – Required. The session entity type to update. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
orprojects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>
. IfEnvironment ID
is not specified, we assume default ‘draft’ environment. This corresponds to thesession_entity_type
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow documentation.
- Return type
SessionEntityType
-
class
google.cloud.dialogflowcx_v3.services.sessions.
SessionsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to determine user intent and respond.
Instantiate the sessions 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 (Union[str, SessionsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
detect_intent
(request: google.cloud.dialogflowcx_v3.types.session.DetectIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.DetectIntentResponse[source]¶ Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.
- Parameters
request (
DetectIntentRequest
) – The request object. The request to detect user’s intent.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 message returned from the DetectIntent method.
- Return type
DetectIntentResponse
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str¶ Return a fully-qualified entity_type string.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str¶ Return a fully-qualified flow string.
-
classmethod
from_service_account_file
(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
-
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
-
async
fulfill_intent
(request: google.cloud.dialogflowcx_v3.types.session.FulfillIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.FulfillIntentResponse[source]¶ Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.
- Parameters
request (
FulfillIntentRequest
) – The request object. Request of [FulfillIntent][]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 of [FulfillIntent][]
- Return type
FulfillIntentResponse
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport]¶ Return 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, location: str, agent: str, intent: str) → str¶ Return a fully-qualified intent string.
-
async
match_intent
(request: google.cloud.dialogflowcx_v3.types.session.MatchIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.MatchIntentResponse[source]¶ Returns preliminary intent match results, doesn’t change the session status.
- Parameters
request (
MatchIntentRequest
) – The request object. Request of [MatchIntent][].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 of [MatchIntent][].
- Return type
MatchIntentResponse
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str¶ Return a fully-qualified page string.
-
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_entity_type_path
(path: str) → Dict[str, str]¶ Parse a entity_type path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str]¶ Parse a intent path into its component segments.
-
static
parse_session_entity_type_path
(path: str) → Dict[str, str]¶ Parse a session_entity_type path into its component segments.
-
static
parse_session_path
(path: str) → Dict[str, str]¶ Parse a session path into its component segments.
-
static
parse_transition_route_group_path
(path: str) → Dict[str, str]¶ Parse a transition_route_group path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str]¶ Parse a webhook path into its component segments.
-
static
session_entity_type_path
(project: str, location: str, agent: str, session: str, entity_type: str) → str¶ Return a fully-qualified session_entity_type string.
-
static
session_path
(project: str, location: str, agent: str, session: str) → str¶ Return a fully-qualified session string.
-
streaming_detect_intent
(requests: AsyncIterator[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → Awaitable[AsyncIterable[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentResponse]][source]¶ Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
- Parameters
requests (AsyncIterator[~.session.StreamingDetectIntentRequest]) –
The request object AsyncIterator. The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method. Multiple request messages should be sent in order:
1. The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config]. 2. If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.audio] to continue with Speech recognition.
If you decide to rather detect an intent from text
input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.cx.v3.QueryInput.text].
However, note that:
Dialogflow will bill you for the audio duration so
far. * Dialogflow discards all Speech recognition results in favor of the input text.
Dialogflow will use the language code from the
first message. 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
StreamingDetectIntent
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
. Eachrecognition_result
represents a more complete transcript of what the user said. The lastrecognition_result
hasis_final
set totrue
.The last message contains
detect_intent_response
.
- Return type
AsyncIterable[StreamingDetectIntentResponse]
-
static
transition_route_group_path
(project: str, location: str, agent: str, flow: str, transition_route_group: str) → str¶ Return a fully-qualified transition_route_group string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SessionsTransport
-
class
google.cloud.dialogflowcx_v3.services.sessions.
SessionsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport]] = 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>)[source]¶ A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to determine user intent and respond.
Instantiate the sessions 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 (Union[str, SessionsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
detect_intent
(request: google.cloud.dialogflowcx_v3.types.session.DetectIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.DetectIntentResponse[source]¶ Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.
- Parameters
request (
DetectIntentRequest
) – The request object. The request to detect user’s intent.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 message returned from the DetectIntent method.
- Return type
DetectIntentResponse
-
static
entity_type_path
(project: str, location: str, agent: str, entity_type: str) → str[source]¶ Return a fully-qualified entity_type string.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str[source]¶ Return a fully-qualified flow 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
-
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
-
fulfill_intent
(request: google.cloud.dialogflowcx_v3.types.session.FulfillIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.FulfillIntentResponse[source]¶ Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.
- Parameters
request (
FulfillIntentRequest
) – The request object. Request of [FulfillIntent][]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 of [FulfillIntent][]
- Return type
FulfillIntentResponse
-
static
intent_path
(project: str, location: str, agent: str, intent: str) → str[source]¶ Return a fully-qualified intent string.
-
match_intent
(request: google.cloud.dialogflowcx_v3.types.session.MatchIntentRequest = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.session.MatchIntentResponse[source]¶ Returns preliminary intent match results, doesn’t change the session status.
- Parameters
request (
MatchIntentRequest
) – The request object. Request of [MatchIntent][].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 of [MatchIntent][].
- Return type
MatchIntentResponse
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str[source]¶ Return a fully-qualified page string.
-
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_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a entity_type path into its component segments.
-
static
parse_flow_path
(path: str) → Dict[str, str][source]¶ Parse a flow path into its component segments.
-
static
parse_intent_path
(path: str) → Dict[str, str][source]¶ Parse a intent path into its component segments.
-
static
parse_page_path
(path: str) → Dict[str, str][source]¶ Parse a page path into its component segments.
-
static
parse_session_entity_type_path
(path: str) → Dict[str, str][source]¶ Parse a session_entity_type path into its component segments.
-
static
parse_session_path
(path: str) → Dict[str, str][source]¶ Parse a session path into its component segments.
-
static
parse_transition_route_group_path
(path: str) → Dict[str, str][source]¶ Parse a transition_route_group path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str][source]¶ Parse a webhook path into its component segments.
-
static
session_entity_type_path
(project: str, location: str, agent: str, session: str, entity_type: str) → str[source]¶ Return a fully-qualified session_entity_type string.
-
static
session_path
(project: str, location: str, agent: str, session: str) → str[source]¶ Return a fully-qualified session string.
-
streaming_detect_intent
(requests: Iterator[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → Iterable[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentResponse][source]¶ Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
- Parameters
requests (Iterator[~.session.StreamingDetectIntentRequest]) –
The request object iterator. The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method. Multiple request messages should be sent in order:
1. The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config]. 2. If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.audio] to continue with Speech recognition.
If you decide to rather detect an intent from text
input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.cx.v3.QueryInput.text].
However, note that:
Dialogflow will bill you for the audio duration so
far. * Dialogflow discards all Speech recognition results in favor of the input text.
Dialogflow will use the language code from the
first message. 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
StreamingDetectIntent
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
. Eachrecognition_result
represents a more complete transcript of what the user said. The lastrecognition_result
hasis_final
set totrue
.The last message contains
detect_intent_response
.
- Return type
Iterable[StreamingDetectIntentResponse]
-
static
transition_route_group_path
(project: str, location: str, agent: str, flow: str, transition_route_group: str) → str[source]¶ Return a fully-qualified transition_route_group string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SessionsTransport
-
class
google.cloud.dialogflowcx_v3.services.transition_route_groups.
TransitionRouteGroupsAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ Service for managing [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
Instantiate the transition route groups 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 (Union[str, TransitionRouteGroupsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.CreateTransitionRouteGroupRequest = None, *, parent: str = None, transition_route_group: google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup[source]¶ Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] in the specified flow.
- Parameters
request (
CreateTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].parent (
str
) – Required. The flow to create an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.transition_route_group (
TransitionRouteGroup
) – Required. The transition route group to create. This corresponds to thetransition_route_group
field on therequest
instance; ifrequest
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
An TransitionRouteGroup represents a group of [
TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].- Return type
TransitionRouteGroup
-
async
delete_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.DeleteTransitionRouteGroupRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
- Parameters
request (
DeleteTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].name (
str
) – Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str¶ Return a fully-qualified flow string.
-
classmethod
from_service_account_file
(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
-
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
-
async
get_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.GetTransitionRouteGroupRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup[source]¶ Retrieves the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
- Parameters
request (
GetTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].name (
str
) – Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An TransitionRouteGroup represents a group of [
TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].- Return type
TransitionRouteGroup
-
get_transport_class
() → Type[google.cloud.dialogflowcx_v3.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport]¶ Return 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, location: str, agent: str, intent: str) → str¶ Return a fully-qualified intent string.
-
async
list_transition_route_groups
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.ListTransitionRouteGroupsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.transition_route_groups.pagers.ListTransitionRouteGroupsAsyncPager[source]¶ Returns the list of all transition route groups in the specified flow.
- Parameters
request (
ListTransitionRouteGroupsRequest
) – The request object. The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].parent (
str
) – Required. The flow to list all transition route groups for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
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 [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListTransitionRouteGroupsAsyncPager
-
static
page_path
(project: str, location: str, agent: str, flow: str, page: str) → str¶ Return a fully-qualified page string.
-
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_intent_path
(path: str) → Dict[str, str]¶ Parse a intent path into its component segments.
-
static
parse_transition_route_group_path
(path: str) → Dict[str, str]¶ Parse a transition_route_group path into its component segments.
-
static
parse_webhook_path
(path: str) → Dict[str, str]¶ Parse a webhook path into its component segments.
-
static
transition_route_group_path
(project: str, location: str, agent: str, flow: str, transition_route_group: str) → str¶ Return a fully-qualified transition_route_group string.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
TransitionRouteGroupsTransport
-
async
update_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.UpdateTransitionRouteGroupRequest = None, *, transition_route_group: google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup = None, update_mask: google.protobuf.field_mask_pb2.FieldMask = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup[source]¶ Updates the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
- Parameters
request (
UpdateTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.UpdateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.UpdateTransitionRouteGroup].transition_route_group (
TransitionRouteGroup
) – Required. The transition route group to update. This corresponds to thetransition_route_group
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
FieldMask
) – The mask to control which fields get updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
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
An TransitionRouteGroup represents a group of [
TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].- Return type
TransitionRouteGroup
-
class
google.cloud.dialogflowcx_v3.services.transition_route_groups.
TransitionRouteGroupsClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.transition_route_groups.transports.base.TransitionRouteGroupsTransport]] = 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>)[source]¶ Service for managing [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
Instantiate the transition route groups 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 (Union[str, TransitionRouteGroupsTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.CreateTransitionRouteGroupRequest = None, *, parent: str = None, transition_route_group: google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup[source]¶ Creates an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] in the specified flow.
- Parameters
request (
CreateTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].parent (
str
) – Required. The flow to create an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.transition_route_group (
TransitionRouteGroup
) – Required. The transition route group to create. This corresponds to thetransition_route_group
field on therequest
instance; ifrequest
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
An TransitionRouteGroup represents a group of [
TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].- Return type
TransitionRouteGroup
-
delete_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.DeleteTransitionRouteGroupRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
- Parameters
request (
DeleteTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].name (
str
) – Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] to delete. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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.
-
static
flow_path
(project: str, location: str, agent: str, flow: str) → str[source]¶ Return a fully-qualified flow 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
-
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
-
get_transition_route_group
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.GetTransitionRouteGroupRequest = None, *, name: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.types.transition_route_group.TransitionRouteGroup[source]¶ Retrieves the specified [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
- Parameters
request (
GetTransitionRouteGroupRequest
) – The request object. The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].name (
str
) – Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>
. This corresponds to thename
field on therequest
instance; ifrequest
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
An TransitionRouteGroup represents a group of [
TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].- Return type
TransitionRouteGroup
-
static
intent_path
(project: str, location: str, agent: str, intent: str) → str[source]¶ Return a fully-qualified intent string.
-
list_transition_route_groups
(request: google.cloud.dialogflowcx_v3.types.transition_route_group.ListTransitionRouteGroupsRequest = None, *, parent: str = None, retry: google.api_core.retry.Retry = <object object>, timeout: float = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3.services.transition_route_groups.pagers.ListTransitionRouteGroupsPager[source]¶ Returns the list of all transition route groups in the specified flow.
- Parameters
request (
ListTransitionRouteGroupsRequest
) – The request object. The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].parent (
str
) – Required. The flow to list all transition route groups for. Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>
. This corresponds to theparent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Re