Class IntentsClient (2.1.2)

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.

Properties

transport

Return the transport used by the client instance.

Returns
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>)

Instantiate the intents client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, 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 `transport` instance is provided. (1) The `api_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, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

batch_delete_intents

batch_delete_intents(request: Optional[google.cloud.dialogflow_v2.types.intent.BatchDeleteIntentsRequest] = None, *, parent: Optional[str] = None, intents: Optional[Sequence[google.cloud.dialogflow_v2.types.intent.Intent]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes intents in the specified agent.

Operation <response: google.protobuf.Empty][google.protobuf.Empty]>

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.BatchDeleteIntentsRequest` The request object. The request message for Intents.BatchDeleteIntents.
`parent`	`str` Required. The name of the agent to delete all entities types for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`intents`	`Sequence[google.cloud.dialogflow_v2.types.Intent]` Required. The collection of intents to delete. Only intent `name` must be filled in. This corresponds to the `intents` field on the `request` instance; if `request` 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

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[google.cloud.dialogflow_v2.types.intent.BatchUpdateIntentsRequest] = None, *, parent: Optional[str] = None, intent_batch_uri: Optional[str] = None, intent_batch_inline: Optional[google.cloud.dialogflow_v2.types.intent.IntentBatch] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates/Creates multiple intents in the specified agent.

Operation <response: xref_BatchUpdateIntentsResponse>

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.BatchUpdateIntentsRequest` The request object.
`parent`	`str` Required. The name of the agent to update or create intents in. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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_uri` field on the `request` instance; if `request` is provided, this should not be set.
`intent_batch_inline`	`google.cloud.dialogflow_v2.types.IntentBatch` The collection of intents to update or create. This corresponds to the `intent_batch_inline` field on the `request` instance; if `request` 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
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)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

context_path

context_path(project: str, session: str, context: str)

Return a fully-qualified context string.

create_intent

create_intent(request: Optional[google.cloud.dialogflow_v2.types.intent.CreateIntentRequest] = None, *, parent: Optional[str] = None, intent: Optional[google.cloud.dialogflow_v2.types.intent.Intent] = None, language_code: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an intent in the specified agent.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.CreateIntentRequest` The request object. The request message for Intents.CreateIntent.
`parent`	`str` Required. The agent to create a intent for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`intent`	`google.cloud.dialogflow_v2.types.Intent` Required. The intent to create. This corresponds to the `intent` field on the `request` instance; if `request` is provided, this should not be set.
`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 `Multilingual intent and entity data https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` 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

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[google.cloud.dialogflow_v2.types.intent.DeleteIntentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.DeleteIntentRequest` 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: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` 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.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`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.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`IntentsClient`	The constructed client.

get_intent

get_intent(request: Optional[google.cloud.dialogflow_v2.types.intent.GetIntentRequest] = None, *, name: Optional[str] = None, language_code: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified intent.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.GetIntentRequest` The request object. The request message for Intents.GetIntent.
`name`	`str` Required. The name of the intent. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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 `Multilingual intent and entity data https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` 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

Type Description

intent_path

intent_path(project: str, intent: str)

Return a fully-qualified intent string.

list_intents

list_intents(request: Optional[google.cloud.dialogflow_v2.types.intent.ListIntentsRequest] = None, *, parent: Optional[str] = None, language_code: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all intents in the specified agent.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.ListIntentsRequest` The request object. The request message for Intents.ListIntents.
`parent`	`str` Required. The agent to list all intents from. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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 `Multilingual intent and entity data https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` 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
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)

Parse a context path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parse a intent path into its component segments.

update_intent

update_intent(request: Optional[google.cloud.dialogflow_v2.types.intent.UpdateIntentRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified intent.

Parameters
Name	Description
`request`	`google.cloud.dialogflow_v2.types.UpdateIntentRequest` 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 `intent` field on the `request` instance; if `request` is provided, this should not be set.
`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 `Multilingual intent and entity data https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. The mask to control which fields get updated. This corresponds to the `update_mask` field on the `request` instance; if `request` 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

Type Description