async def update_session_entity_type(
self,
request: gcdc_session_entity_type.
UpdateSessionEntityTypeRequest = None,
*,
session_entity_type: gcdc_session_entity_type.SessionEntityType = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_session_entity_type.SessionEntityType:
r"""Updates the specified session entity type.
Args:
request (:class:`~.gcdc_session_entity_type.UpdateSessionEntityTypeRequest`):
The request object. The request message for
[SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].
session_entity_type (:class:`~.gcdc_session_entity_type.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 (:class:`~.field_mask.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:
~.gcdc_session_entity_type.SessionEntityType:
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>`__.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([session_entity_type, update_mask])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = gcdc_session_entity_type.UpdateSessionEntityTypeRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if session_entity_type is not None:
request.session_entity_type = session_entity_type
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.update_session_entity_type,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("session_entity_type.name",
request.session_entity_type.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def update_session_entity_type(
self,
request: Union[gcdc_session_entity_type.UpdateSessionEntityTypeRequest,
dict] = None,
*,
session_entity_type: gcdc_session_entity_type.SessionEntityType = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_session_entity_type.SessionEntityType:
r"""Updates the specified session entity type.
.. code-block::
from google.cloud import dialogflowcx_v3
def sample_update_session_entity_type():
# Create a client
client = dialogflowcx_v3.SessionEntityTypesClient()
# Initialize request argument(s)
session_entity_type = dialogflowcx_v3.SessionEntityType()
session_entity_type.name = "name_value"
session_entity_type.entity_override_mode = "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
session_entity_type.entities.value = "value_value"
session_entity_type.entities.synonyms = ['synonyms_value_1', 'synonyms_value_2']
request = dialogflowcx_v3.UpdateSessionEntityTypeRequest(
session_entity_type=session_entity_type,
)
# Make the request
response = client.update_session_entity_type(request=request)
# Handle the response
print(response)
Args:
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:
google.cloud.dialogflowcx_v3.types.SessionEntityType:
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).
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([session_entity_type, update_mask])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a gcdc_session_entity_type.UpdateSessionEntityTypeRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(
request,
gcdc_session_entity_type.UpdateSessionEntityTypeRequest):
request = gcdc_session_entity_type.UpdateSessionEntityTypeRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if session_entity_type is not None:
request.session_entity_type = session_entity_type
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.update_session_entity_type]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("session_entity_type.name",
request.session_entity_type.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response