IntentsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2.services.intents.transports.base.IntentsTransport, typing.Callable[[...], google.cloud.dialogflow_v2.services.intents.transports.base.IntentsTransport]]] = 'grpc_asyncio', client_options: typing.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.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
IntentsTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
IntentsAsyncClient
IntentsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2.services.intents.transports.base.IntentsTransport, typing.Callable[[...], google.cloud.dialogflow_v2.services.intents.transports.base.IntentsTransport]]] = 'grpc_asyncio', client_options: typing.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 async client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Optional[Union[str,IntentsTransport,Callable[..., IntentsTransport]]]
The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the IntentsTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
batch_delete_intents
batch_delete_intents(
request: typing.Optional[
typing.Union[
google.cloud.dialogflow_v2.types.intent.BatchDeleteIntentsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
intents: typing.Optional[
typing.MutableSequence[google.cloud.dialogflow_v2.types.intent.Intent]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes intents in the specified agent.
This method is a long-running
operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: An emptyStruct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>
__response
: AnEmpty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>
__
Note: You should always train an agent prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/es/docs/training>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2
async def sample_batch_delete_intents():
# Create a client
client = dialogflow_v2.IntentsAsyncClient()
# Initialize request argument(s)
intents = dialogflow_v2.Intent()
intents.display_name = "display_name_value"
request = dialogflow_v2.BatchDeleteIntentsRequest(
parent="parent_value",
intents=intents,
)
# Make the request
operation = client.batch_delete_intents(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.dialogflow_v2.types.BatchDeleteIntentsRequest, dict]]
The request object. The request message for Intents.BatchDeleteIntents. |
parent |
Required. The name of the agent to delete all entities types for. Format: |
intents |
:class:
Required. The collection of intents to delete. Only intent |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
batch_update_intents
batch_update_intents(
request: typing.Optional[
typing.Union[
google.cloud.dialogflow_v2.types.intent.BatchUpdateIntentsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
intent_batch_uri: typing.Optional[str] = None,
intent_batch_inline: typing.Optional[
google.cloud.dialogflow_v2.types.intent.IntentBatch
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates/Creates multiple intents in the specified agent.
This method is a long-running
operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: An emptyStruct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>
__response
: xref_BatchUpdateIntentsResponse
Note: You should always train an agent prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/es/docs/training>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2
async def sample_batch_update_intents():
# Create a client
client = dialogflow_v2.IntentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2.BatchUpdateIntentsRequest(
intent_batch_uri="intent_batch_uri_value",
parent="parent_value",
)
# Make the request
operation = client.batch_update_intents(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.dialogflow_v2.types.BatchUpdateIntentsRequest, dict]]
The request object. |
parent |
Required. The name of the agent to update or create intents in. Format: |
intent_batch_uri |
The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". This corresponds to the |
intent_batch_inline |
IntentBatch
The collection of intents to update or create. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be BatchUpdateIntentsResponse The response message for Intents.BatchUpdateIntents. |
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
context_path
context_path(project: str, session: str, context: str) -> str
Returns a fully-qualified context string.
create_intent
create_intent(
request: typing.Optional[
typing.Union[google.cloud.dialogflow_v2.types.intent.CreateIntentRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
intent: typing.Optional[google.cloud.dialogflow_v2.types.intent.Intent] = None,
language_code: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflow_v2.types.intent.Intent
Creates an intent in the specified agent.
Note: You should always train an agent prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/es/docs/training>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2
async def sample_create_intent():
# Create a client
client = dialogflow_v2.IntentsAsyncClient()
# Initialize request argument(s)
intent = dialogflow_v2.Intent()
intent.display_name = "display_name_value"
request = dialogflow_v2.CreateIntentRequest(
parent="parent_value",
intent=intent,
)
# Make the request
response = await client.create_intent(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.dialogflow_v2.types.CreateIntentRequest, dict]]
The request object. The request message for Intents.CreateIntent. |
parent |
Required. The agent to create a intent for. Format: |
intent |
Intent
Required. The intent to create. This corresponds to the |
language_code |
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflow_v2.types.Intent |
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](\ https://cloud.google.com/dialogflow/docs/intents-overview). |
delete_intent
delete_intent(
request: typing.Optional[
typing.Union[google.cloud.dialogflow_v2.types.intent.DeleteIntentRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault