IntentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.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>)
Service for managing Intents.
Inheritance
builtins.object > IntentsClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
IntentsTransport | The transport used by the client instance. |
Methods
IntentsClient
IntentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.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>)
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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
batch_delete_intents
batch_delete_intents(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.BatchDeleteIntentsRequest, dict]] = None, *, parent: Optional[str] = None, intents: Optional[Sequence[google.cloud.dialogflow_v2.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]] = ())
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>
__.
from google.cloud import dialogflow_v2
def sample_batch_delete_intents():
# Create a client
client = dialogflow_v2.IntentsClient()
# 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 = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.BatchDeleteIntentsRequest, dict]
The request object. The request message for Intents.BatchDeleteIntents. |
parent |
str
Required. The name of the agent to delete all entities types for. Format: |
intents |
Sequence[google.cloud.dialogflow_v2.types.Intent]
Required. The collection of intents to delete. Only 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. |
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
batch_update_intents
batch_update_intents(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.BatchUpdateIntentsRequest, dict]] = None, *, parent: Optional[str] = None, intent_batch_uri: Optional[str] = None, intent_batch_inline: Optional[google.cloud.dialogflow_v2.types.intent.IntentBatch] = 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/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>
__.
from google.cloud import dialogflow_v2
def sample_batch_update_intents():
# Create a client
client = dialogflow_v2.IntentsClient()
# 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 = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.BatchUpdateIntentsRequest, dict]
The request object. |
parent |
str
Required. The name of the agent to update or create intents in. Format: |
intent_batch_uri |
str
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 |
google.cloud.dialogflow_v2.types.IntentBatch
The collection of intents to update or 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.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be BatchUpdateIntentsResponse The response message for Intents.BatchUpdateIntents. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
context_path
context_path(project: str, session: str, context: str)
Returns a fully-qualified context string.
create_intent
create_intent(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.CreateIntentRequest, dict]] = None, *, parent: Optional[str] = None, intent: Optional[google.cloud.dialogflow_v2.types.intent.Intent] = None, language_code: 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]] = ())
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>
__.
from google.cloud import dialogflow_v2
def sample_create_intent():
# Create a client
client = dialogflow_v2.IntentsClient()
# 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 = client.create_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.CreateIntentRequest, dict]
The request object. The request message for Intents.CreateIntent. |
parent |
str
Required. The agent to create a intent for. Format: |
intent |
google.cloud.dialogflow_v2.types.Intent
Required. The intent to create. This corresponds to the |
language_code |
str
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.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.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: Optional[Union[google.cloud.dialogflow_v2.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 and its direct or indirect followup intents.
Note: You should always train an agent prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/es/docs/training>
__.
from google.cloud import dialogflow_v2
def sample_delete_intent():
# Create a client
client = dialogflow_v2.IntentsClient()
# Initialize request argument(s)
request = dialogflow_v2.DeleteIntentRequest(
name="name_value",
)
# Make the request
client.delete_intent(request=request)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.DeleteIntentRequest, dict]
The request object. The request message for Intents.DeleteIntent. |
name |
str
Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. 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. |
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 |
IntentsClient | 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 |
IntentsClient | 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 |
IntentsClient | The constructed client. |
get_intent
get_intent(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.GetIntentRequest, dict]] = None, *, name: Optional[str] = None, language_code: 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 dialogflow_v2
def sample_get_intent():
# Create a client
client = dialogflow_v2.IntentsClient()
# Initialize request argument(s)
request = dialogflow_v2.GetIntentRequest(
name="name_value",
)
# Make the request
response = client.get_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.GetIntentRequest, dict]
The request object. The request message for Intents.GetIntent. |
name |
str
Required. The name of the intent. Format: |
language_code |
str
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.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.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). |
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. |
intent_path
intent_path(project: str, intent: str)
Returns a fully-qualified intent string.
list_intents
list_intents(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.ListIntentsRequest, dict]] = None, *, parent: Optional[str] = None, language_code: 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 dialogflow_v2
def sample_list_intents():
# Create a client
client = dialogflow_v2.IntentsClient()
# Initialize request argument(s)
request = dialogflow_v2.ListIntentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_intents(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.ListIntentsRequest, dict]
The request object. The request message for Intents.ListIntents. |
parent |
str
Required. The agent to list all intents from. Format: |
language_code |
str
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.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.dialogflow_v2.services.intents.pagers.ListIntentsPager | 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_context_path
parse_context_path(path: str)
Parses a context path into its component segments.
parse_intent_path
parse_intent_path(path: str)
Parses a intent path into its component segments.
update_intent
update_intent(request: Optional[Union[google.cloud.dialogflow_v2.types.intent.UpdateIntentRequest, dict]] = None, *, intent: Optional[google.cloud.dialogflow_v2.types.intent.Intent] = None, language_code: Optional[str] = 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 an agent prior to sending it
queries. See the training
documentation <https://cloud.google.com/dialogflow/es/docs/training>
__.
from google.cloud import dialogflow_v2
def sample_update_intent():
# Create a client
client = dialogflow_v2.IntentsClient()
# Initialize request argument(s)
intent = dialogflow_v2.Intent()
intent.display_name = "display_name_value"
request = dialogflow_v2.UpdateIntentRequest(
intent=intent,
)
# Make the request
response = client.update_intent(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2.types.UpdateIntentRequest, dict]
The request object. The request message for Intents.UpdateIntent. |
intent |
google.cloud.dialogflow_v2.types.Intent
Required. The intent to update. This corresponds to the |
language_code |
str
Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. The mask to control which fields get 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.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). |