Class SessionEntityTypesClient (1.0.0) 

SessionEntityTypesClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level.

Session entity methods do not work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

For more information about entity types, see the Dialogflow documentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.

Methods

SessionEntityTypesClient

SessionEntityTypesClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
NameDescription
channel grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

credentials google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

client_config dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

create_session_entity_type

create_session_entity_type(parent, session_entity_type, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.SessionEntityTypesClient()

parent = client.session_path('[PROJECT]', '[SESSION]')

TODO: Initialize session_entity_type:

session_entity_type = {}

response = client.create_session_entity_type(parent, session_entity_type)

Parameters
NameDescription
parent str

Required. The session to create a session entity type for. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

session_entity_type Union[dict, SessionEntityType]

Required. The session entity type to create. If a dict is provided, it must be of the same form as the protobuf message SessionEntityType

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

delete_session_entity_type

delete_session_entity_type(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.SessionEntityTypesClient()

name = client.session_entity_type_path('[PROJECT]', '[SESSION]', '[ENTITY_TYPE]')

client.delete_session_entity_type(name)

Parameters
NameDescription
name str

Required. The name of the entity type to delete. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
dialogflow_v2.SessionEntityTypesClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
dialogflow_v2.SessionEntityTypesClientThe constructed client.

get_session_entity_type

get_session_entity_type(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.SessionEntityTypesClient()

name = client.session_entity_type_path('[PROJECT]', '[SESSION]', '[ENTITY_TYPE]')

response = client.get_session_entity_type(name)

Parameters
NameDescription
name str

Required. The name of the session entity type. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

list_session_entity_types

list_session_entity_types(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.SessionEntityTypesClient()

parent = client.session_path('[PROJECT]', '[SESSION]')

Iterate over all results

for element in client.list_session_entity_types(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_session_entity_types(parent).pages: ... for element in page: ... # process element ... pass

Parameters
NameDescription
parent str

Required. The session to list all session entity types from. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

page_size int

The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

session_entity_type_path

session_entity_type_path(project, session, entity_type)

Return a fully-qualified session_entity_type string.

session_path

session_path(project, session)

Return a fully-qualified session string.

update_session_entity_type

update_session_entity_type(session_entity_type, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

import dialogflow_v2

client = dialogflow_v2.SessionEntityTypesClient()

TODO: Initialize session_entity_type:

session_entity_type = {}

response = client.update_session_entity_type(session_entity_type)

Parameters
NameDescription
session_entity_type Union[dict, SessionEntityType]

Required. The session entity type to update. If a dict is provided, it must be of the same form as the protobuf message SessionEntityType

update_mask Union[dict, FieldMask]

Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.