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.dialogflowcx_v3.services.session_entity_types.SessionEntityTypesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.session_entity_types.transports.base.SessionEntityTypesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.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 (Union[str, SessionEntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

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

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[google.cloud.dialogflowcx_v3.types.session_entity_type.CreateSessionEntityTypeRequest] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Creates a session entity type.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateSessionEntityTypeRequest) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].

  • parent (str) –

    Required. The session to create a session entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • session_entity_type (google.cloud.dialogflowcx_v3.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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

async delete_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.DeleteSessionEntityTypeRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified session entity type.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteSessionEntityTypeRequest) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].

  • name (str) –

    Required. The name of the session entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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

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_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.GetSessionEntityTypeRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Retrieves the specified session entity type.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetSessionEntityTypeRequest) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].

  • name (str) –

    Required. The name of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

get_transport_class()Type[google.cloud.dialogflowcx_v3.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_session_entity_types(request: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager[source]

Returns the list of all session entity types in the specified session.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListSessionEntityTypesRequest) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

  • parent (str) –

    Required. The session to list all session entity types from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

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

Return type

google.cloud.dialogflowcx_v3.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, location: str, agent: str, session: str, entity_type: str)str

Returns a fully-qualified session_entity_type string.

property transport: google.cloud.dialogflowcx_v3.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

async update_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.UpdateSessionEntityTypeRequest] = None, *, session_entity_type: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Updates the specified session entity type.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdateSessionEntityTypeRequest) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].

  • session_entity_type (google.cloud.dialogflowcx_v3.types.SessionEntityType) –

    Required. The session entity type to update. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

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

    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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

class google.cloud.dialogflowcx_v3.services.session_entity_types.SessionEntityTypesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.session_entity_types.transports.base.SessionEntityTypesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.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 (Union[str, SessionEntityTypesTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

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!

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.dialogflowcx_v3.types.session_entity_type.CreateSessionEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Creates a session entity type.

Parameters
  • request (Union[google.cloud.dialogflowcx_v3.types.CreateSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].

  • parent (str) –

    Required. The session to create a session entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • session_entity_type (google.cloud.dialogflowcx_v3.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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

delete_session_entity_type(request: Optional[Union[google.cloud.dialogflowcx_v3.types.session_entity_type.DeleteSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified session entity type.

Parameters
  • request (Union[google.cloud.dialogflowcx_v3.types.DeleteSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].

  • name (str) –

    Required. The name of the session entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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_session_entity_type(request: Optional[Union[google.cloud.dialogflowcx_v3.types.session_entity_type.GetSessionEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Retrieves the specified session entity type.

Parameters
  • request (Union[google.cloud.dialogflowcx_v3.types.GetSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].

  • name (str) –

    Required. The name of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

list_session_entity_types(request: Optional[Union[google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesPager[source]

Returns the list of all session entity types in the specified session.

Parameters
  • request (Union[google.cloud.dialogflowcx_v3.types.ListSessionEntityTypesRequest, dict]) – The request object. The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

  • parent (str) –

    Required. The session to list all session entity types from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

    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.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

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

Return type

google.cloud.dialogflowcx_v3.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, location: str, agent: str, session: str, entity_type: str)str[source]

Returns a fully-qualified session_entity_type string.

property transport: google.cloud.dialogflowcx_v3.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

update_session_entity_type(request: Optional[Union[google.cloud.dialogflowcx_v3.types.session_entity_type.UpdateSessionEntityTypeRequest, dict]] = None, *, session_entity_type: Optional[google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.session_entity_type.SessionEntityType[source]

Updates the specified session entity type.

Parameters
  • request (Union[google.cloud.dialogflowcx_v3.types.UpdateSessionEntityTypeRequest, dict]) – The request object. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].

  • session_entity_type (google.cloud.dialogflowcx_v3.types.SessionEntityType) –

    Required. The session entity type to update. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

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

    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

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 to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).

Return type

google.cloud.dialogflowcx_v3.types.SessionEntityType

class google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesResponse]], request: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest, response: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.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.dialogflowcx_v3.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
class google.cloud.dialogflowcx_v3.services.session_entity_types.pagers.ListSessionEntityTypesPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesResponse], request: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesRequest, response: google.cloud.dialogflowcx_v3.types.session_entity_type.ListSessionEntityTypesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_session_entity_types requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.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.dialogflowcx_v3.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