Class IntentsClient (0.1.1)

Stay organized with collections Save and categorize content based on your preferences.
IntentsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.intents.transports.base.IntentsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/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>)

Service for managing Intents.

Inheritance

builtins.object > IntentsClient

Methods

IntentsClient

IntentsClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.intents.transports.base.IntentsTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/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>)

Instantiate the intents client.

Parameters
NameDescription
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) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

create_intent

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

Creates an intent in the specified agent.

Parameters
NameDescription
request `.gcdc_intent.CreateIntentRequest`

The request object. The request message for 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 the parent field on the request instance; if request is provided, this should not be set.

intent `.gcdc_intent.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.

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
TypeDescription
`.gcdc_intent.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[google.cloud.dialogflowcx_v3beta1.types.intent.DeleteIntentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified intent.

Parameters
NameDescription
request `.intent.DeleteIntentRequest`

The request object. The request message for 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 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_intent

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

Retrieves the specified intent.

Parameters
NameDescription
request `.intent.GetIntentRequest`

The request object. The request message for 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 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.

Returns
TypeDescription
`.intent.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.

intent_path

intent_path(project: str, location: str, agent: str, intent: str)

Return a fully-qualified intent string.

list_intents

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

Returns the list of all intents in the specified agent.

Parameters
NameDescription
request `.intent.ListIntentsRequest`

The request object. The request message for 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 the parent 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
TypeDescription
`.pagers.ListIntentsPager`The response message for Intents.ListIntents. Iterating over this object will yield results and resolve additional pages automatically.

parse_intent_path

parse_intent_path(path: str)

Parse a intent path into its component segments.

update_intent

update_intent(request: Optional[google.cloud.dialogflowcx_v3beta1.types.intent.UpdateIntentRequest] = None, *, intent: Optional[google.cloud.dialogflowcx_v3beta1.types.intent.Intent] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified intent.

Parameters
NameDescription
request `.gcdc_intent.UpdateIntentRequest`

The request object. The request message for Intents.UpdateIntent.

intent `.gcdc_intent.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.

update_mask `.field_mask.FieldMask`

The mask to control which fields get updated. If the mask is not present, all fields will be 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
TypeDescription
`.gcdc_intent.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.