As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

SessionEntityTypes¶

class google.cloud.dialogflow_v2beta1.services.session_entity_types.SessionEntityTypesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport, typing.Callable[[...], google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport]]] = '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>)[source]¶

Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType].

Instantiates the session entity types async client.

Parameters

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,SessionEntityTypesTransport,Callable[..., SessionEntityTypesTransport]]]) – 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 SessionEntityTypesTransport 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 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

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

None

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.CreateSessionEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

async def sample_create_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.CreateSessionEntityTypeRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.CreateSessionEntityTypeRequest, dict]]) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.CreateSessionEntityType].
parent (str) –
Required. The session to create a session entity type for. Supported formats:
- `projects//agent/sessions/,
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
- projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
session_entity_type (google.cloud.dialogflow_v2beta1.types.SessionEntityType) –
Required. The session entity type to create.

This corresponds to the session_entity_type field on the request instance; if request is provided, this should not be set.
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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

async delete_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.DeleteSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

async def sample_delete_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.DeleteSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_session_entity_type(request=request)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.DeleteSessionEntityTypeRequest, dict]]) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.DeleteSessionEntityType].
name (str) –
Required. The name of the entity type to delete. Supported formats:
- projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesAsyncClient

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
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

An Operation object.

Return type

Operation

async get_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.GetSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Retrieves the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

async def sample_get_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.GetSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.GetSessionEntityTypeRequest, dict]]) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType].
name (str) –
Required. The name of the session entity type. Supported formats:
- projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
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

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_session_entity_types(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager[source]¶

Returns the list of all session entity types in the specified session. This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

async def sample_list_session_entity_types():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListSessionEntityTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_session_entity_types(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesRequest, dict]]) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].
parent (str) –
Required. The session to list all session entity types from. Supported formats:
- `projects//agent/sessions/,
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
- projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

The response message for: [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_session_entity_type_path(path: str) → Dict[str, str]¶: Parses a session_entity_type path into its component segments.

static session_entity_type_path(project: str, session: str, entity_type: str) → str¶: Returns a fully-qualified session_entity_type string.

property transport: google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: SessionEntityTypesTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.UpdateSessionEntityTypeRequest, dict]] = None, *, session_entity_type: Optional[google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Updates the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

async def sample_update_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.UpdateSessionEntityTypeRequest(
    )

    # Make the request
    response = await client.update_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflow_v2beta1.types.UpdateSessionEntityTypeRequest, dict]]) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.UpdateSessionEntityType].
session_entity_type (google.cloud.dialogflow_v2beta1.types.SessionEntityType) –
Required. The session entity type to update.

This corresponds to the session_entity_type 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_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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

class google.cloud.dialogflow_v2beta1.services.session_entity_types.SessionEntityTypesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport, typing.Callable[[...], google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport]]] = 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>)[source]¶

Service for managing [SessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityType].

Instantiates the session entity types client.

Parameters

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,SessionEntityTypesTransport,Callable[..., SessionEntityTypesTransport]]]) – 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 SessionEntityTypesTransport 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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.

Returns

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.CreateSessionEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

def sample_create_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.CreateSessionEntityTypeRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.CreateSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.CreateSessionEntityType].
parent (str) –
Required. The session to create a session entity type for. Supported formats:
- `projects//agent/sessions/,
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
- projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
session_entity_type (google.cloud.dialogflow_v2beta1.types.SessionEntityType) –
Required. The session entity type to create.

This corresponds to the session_entity_type 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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

delete_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.DeleteSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

def sample_delete_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.DeleteSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    client.delete_session_entity_type(request=request)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.DeleteSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.DeleteSessionEntityType].
name (str) –
Required. The name of the entity type to delete. Supported formats:
- projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SessionEntityTypesClient

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (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

An Operation object.

Return type

Operation

get_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.GetSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Retrieves the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

def sample_get_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.GetSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.GetSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType].
name (str) –
Required. The name of the session entity type. Supported formats:
- projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
- projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (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

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_session_entity_types(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesPager[source]¶

Returns the list of all session entity types in the specified session. This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

def sample_list_session_entity_types():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.ListSessionEntityTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_session_entity_types(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesRequest, dict]) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].
parent (str) –
Required. The session to list all session entity types from. Supported formats:
- `projects//agent/sessions/,
- projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
- projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
- projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-’ user.

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

The response message for: [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_session_entity_type_path(path: str) → Dict[str, str][source]¶: Parses a session_entity_type path into its component segments.

static session_entity_type_path(project: str, session: str, entity_type: str) → str[source]¶: Returns a fully-qualified session_entity_type string.

property transport: google.cloud.dialogflow_v2beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

SessionEntityTypesTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session_entity_type.UpdateSessionEntityTypeRequest, dict]] = None, *, session_entity_type: Optional[google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflow_v2beta1.types.session_entity_type.SessionEntityType[source]¶

Updates the specified session entity type.

This method doesn’t work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

# 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_v2beta1

def sample_update_session_entity_type():
    # Create a client
    client = dialogflow_v2beta1.SessionEntityTypesClient()

    # Initialize request argument(s)
    request = dialogflow_v2beta1.UpdateSessionEntityTypeRequest(
    )

    # Make the request
    response = client.update_session_entity_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflow_v2beta1.types.UpdateSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.UpdateSessionEntityType].
session_entity_type (google.cloud.dialogflow_v2beta1.types.SessionEntityType) –
Required. The session entity type to update.

This corresponds to the session_entity_type 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

A session represents a conversation between a Dialogflow agent and an

end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).

Return type

google.cloud.dialogflow_v2beta1.types.SessionEntityType

class google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesResponse]], request: google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesRequest, response: google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse object, and provides an __aiter__ method to iterate through its session_entity_types field.

If there are more pages, the __aiter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.cloud.dialogflow_v2beta1.services.session_entity_types.pagers.ListSessionEntityTypesPager(method: Callable[[...], google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesResponse], request: google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesRequest, response: google.cloud.dialogflow_v2beta1.types.session_entity_type.ListSessionEntityTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse object, and provides an __iter__ method to iterate through its session_entity_types field.

If there are more pages, the __iter__ method will make additional ListSessionEntityTypes requests and continue to iterate through the session_entity_types field on the corresponding responses.

All the usual google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesRequest) – The initial request object.
response (google.cloud.dialogflow_v2beta1.types.ListSessionEntityTypesResponse) – The initial response object.
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.

SessionEntityTypes¶

google-cloud-dialogflow

Navigation

Related Topics