- 1.37.0 (latest)
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.1
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.0
- 1.14.1
- 1.13.5
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.1
- 1.0.0
- 0.8.2
- 0.7.1
- 0.6.0
- 0.5.0
- 0.4.1
- 0.3.0
- 0.2.0
- 0.1.1
IntentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.intents.transports.base.IntentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for managing Intents.
Inheritance
builtins.object > IntentsAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
IntentsTransport | The transport used by the client instance. |
Methods
IntentsAsyncClient
IntentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.intents.transports.base.IntentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the intents client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.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 |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_intent
create_intent(request: Optional[Union[google.cloud.dialogflowcx_v3.types.intent.CreateIntentRequest, dict]] = None, *, parent: Optional[str] = None, intent: Optional[google.cloud.dialogflowcx_v3.types.intent.Intent] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an intent in the specified agent.
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3
async def sample_create_intent():
# Create a client
client = dialogflowcx_v3.IntentsAsyncClient()
# Initialize request argument(s)
intent = dialogflowcx_v3.Intent()
intent.display_name = "display_name_value"
request = dialogflowcx_v3.CreateIntentRequest(
parent="parent_value",
intent=intent,
)
# Make the request
response = await client.create_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.CreateIntentRequest, dict]
The request object. The request message for Intents.CreateIntent. |
parent |
`str`
Required. The agent to create an intent for. Format: |
intent |
Intent
Required. The intent to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dialogflowcx_v3.types.Intent | 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. |
delete_intent
delete_intent(request: Optional[Union[google.cloud.dialogflowcx_v3.types.intent.DeleteIntentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified intent.
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3
async def sample_delete_intent():
# Create a client
client = dialogflowcx_v3.IntentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3.DeleteIntentRequest(
name="name_value",
)
# Make the request
await client.delete_intent(request=request)
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.DeleteIntentRequest, dict]
The request object. The request message for Intents.DeleteIntent. |
name |
`str`
Required. The name of the intent to delete. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
entity_type_path
entity_type_path(project: str, location: str, agent: str, entity_type: str)
Returns a fully-qualified entity_type string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
IntentsAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
IntentsAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
IntentsAsyncClient | The constructed client. |
get_intent
get_intent(request: Optional[Union[google.cloud.dialogflowcx_v3.types.intent.GetIntentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified intent.
from google.cloud import dialogflowcx_v3
async def sample_get_intent():
# Create a client
client = dialogflowcx_v3.IntentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3.GetIntentRequest(
name="name_value",
)
# Make the request
response = await client.get_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.GetIntentRequest, dict]
The request object. The request message for Intents.GetIntent. |
name |
`str`
Required. The name of the intent. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dialogflowcx_v3.types.Intent | 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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
intent_path
intent_path(project: str, location: str, agent: str, intent: str)
Returns a fully-qualified intent string.
list_intents
list_intents(request: Optional[Union[google.cloud.dialogflowcx_v3.types.intent.ListIntentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all intents in the specified agent.
from google.cloud import dialogflowcx_v3
async def sample_list_intents():
# Create a client
client = dialogflowcx_v3.IntentsAsyncClient()
# Initialize request argument(s)
request = dialogflowcx_v3.ListIntentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_intents(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.ListIntentsRequest, dict]
The request object. The request message for Intents.ListIntents. |
parent |
`str`
Required. The agent to list all intents for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dialogflowcx_v3.services.intents.pagers.ListIntentsAsyncPager | The response message for Intents.ListIntents. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_entity_type_path
parse_entity_type_path(path: str)
Parses a entity_type path into its component segments.
parse_intent_path
parse_intent_path(path: str)
Parses a intent path into its component segments.
update_intent
update_intent(request: Optional[Union[google.cloud.dialogflowcx_v3.types.intent.UpdateIntentRequest, dict]] = None, *, intent: Optional[google.cloud.dialogflowcx_v3.types.intent.Intent] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified intent.
Note: You should always train a flow prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>
__.
from google.cloud import dialogflowcx_v3
async def sample_update_intent():
# Create a client
client = dialogflowcx_v3.IntentsAsyncClient()
# Initialize request argument(s)
intent = dialogflowcx_v3.Intent()
intent.display_name = "display_name_value"
request = dialogflowcx_v3.UpdateIntentRequest(
intent=intent,
)
# Make the request
response = await client.update_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3.types.UpdateIntentRequest, dict]
The request object. The request message for Intents.UpdateIntent. |
intent |
Intent
Required. The intent to update. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dialogflowcx_v3.types.Intent | 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. |