Class IntentsClient (2.36.0) 

IntentsClient(*, 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]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

IntentsClient

IntentsClient(*, 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]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates 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 Optional[Union[str,IntentsTransport,Callable[..., IntentsTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. 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 api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

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.Retry,
            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.Operation

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 empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
  • response: An Empty 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

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)
Parameters
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: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
intents MutableSequence[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); }

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.Retry,
            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.Operation

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 empty Struct 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

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)
Parameters
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: 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.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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 .operations_pb2.CancelOperationRequest

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

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.Retry,
            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

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)
Parameters
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: 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: 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.Retry,
            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

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

# 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

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)
Parameters
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: 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: typing.Optional[
        typing.Union[google.cloud.dialogflow_v2.types.intent.GetIntentRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    language_code: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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

Retrieves the specified intent.

# 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

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)
Parameters
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: 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
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_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
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
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 variable 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.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
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
.operations_pb2.Operation An Operation object.

intent_path

intent_path(project: str, intent: str) -> str

Returns a fully-qualified intent string.

list_intents

list_intents(
    request: typing.Optional[
        typing.Union[google.cloud.dialogflow_v2.types.intent.ListIntentsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    language_code: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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.services.intents.pagers.ListIntentsPager

Returns the list of all intents in the specified agent.

# 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

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)
Parameters
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: projects/ or projects/. Alternatively, you can specify the environment to list intents for. Format: projects/ or projects/. Note: training phrases of the intents will not be returned for non-draft environment. 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.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
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
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
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
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_context_path

parse_context_path(path: str) -> typing.Dict[str, str]

Parses a context path into its component segments.

parse_intent_path

parse_intent_path(path: str) -> typing.Dict[str, str]

Parses a intent path into its component segments.

update_intent

update_intent(
    request: typing.Optional[
        typing.Union[google.cloud.dialogflow_v2.types.intent.UpdateIntentRequest, dict]
    ] = None,
    *,
    intent: typing.Optional[google.cloud.dialogflow_v2.types.intent.Intent] = None,
    language_code: typing.Optional[str] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            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

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

# 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

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)
Parameters
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 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
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).