def update_entity_type(
self,
request: Union[gcdc_entity_type.UpdateEntityTypeRequest, dict] = None,
*,
entity_type: gcdc_entity_type.EntityType = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_entity_type.EntityType:
r"""Updates the specified entity type.
Note: You should always train a flow prior to sending it
queries. See the `training
documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
.. code-block::
from google.cloud import dialogflowcx_v3beta1
def sample_update_entity_type():
# Create a client
client = dialogflowcx_v3beta1.EntityTypesClient()
# Initialize request argument(s)
entity_type = dialogflowcx_v3beta1.EntityType()
entity_type.display_name = "display_name_value"
entity_type.kind = "KIND_REGEXP"
request = dialogflowcx_v3beta1.UpdateEntityTypeRequest(
entity_type=entity_type,
)
# Make the request
response = client.update_entity_type(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.dialogflowcx_v3beta1.types.UpdateEntityTypeRequest, dict]):
The request object. The request message for
[EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
entity_type (google.cloud.dialogflowcx_v3beta1.types.EntityType):
Required. The entity type to update.
This corresponds to the ``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_v3beta1.types.EntityType:
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.
When you define an entity, you can also include
synonyms that all map to that entity. For example,
"soft drink", "soda", "pop", and so on.
There are three types of entities:
- **System** - entities that are defined by the
Dialogflow API for common data types such as date,
time, currency, and so on. A system entity is
represented by the EntityType type.
- **Custom** - entities that are defined by you that
represent actionable data that is meaningful to
your application. For example, you could define a
pizza.sauce entity for red or white pizza sauce, a
pizza.cheese entity for the different types of
cheese on a pizza, a pizza.topping entity for
different toppings, and so on. A custom entity is
represented by the EntityType type.
- **User** - entities that are built for an
individual user such as favorites, preferences,
playlists, and so on. A user entity is represented
by the
[SessionEntityType][google.cloud.dialogflow.cx.v3beta1.SessionEntityType]
type.
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([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_entity_type.UpdateEntityTypeRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, gcdc_entity_type.UpdateEntityTypeRequest):
request = gcdc_entity_type.UpdateEntityTypeRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if entity_type is not None:
request.entity_type = 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_entity_type]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("entity_type.name", request.entity_type.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def update_entity_type(
self,
request: gcdc_entity_type.UpdateEntityTypeRequest = None,
*,
entity_type: gcdc_entity_type.EntityType = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_entity_type.EntityType:
r"""Updates the specified entity type.
Args:
request (:class:`google.cloud.dialogflowcx_v3beta1.types.UpdateEntityTypeRequest`):
The request object. The request message for
[EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
entity_type (:class:`google.cloud.dialogflowcx_v3beta1.types.EntityType`):
Required. The entity type to update.
This corresponds to the ``entity_type`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`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_v3beta1.types.EntityType:
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.
When you define an entity, you can also include
synonyms that all map to that entity. For example,
"soft drink", "soda", "pop", and so on.
There are three types of entities:
- **System** - entities that are defined by the
Dialogflow API for common data types such as date,
time, currency, and so on. A system entity is
represented by the EntityType type.
- **Custom** - entities that are defined by you that
represent actionable data that is meaningful to
your application. For example, you could define a
pizza.sauce entity for red or white pizza sauce, a
pizza.cheese entity for the different types of
cheese on a pizza, a pizza.topping entity for
different toppings, and so on. A custom entity is
represented by the EntityType type.
- **User** - entities that are built for an
individual user such as favorites, preferences,
playlists, and so on. A user entity is represented
by the
[SessionEntityType][google.cloud.dialogflow.cx.v3beta1.SessionEntityType]
type.
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([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_entity_type.UpdateEntityTypeRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if entity_type is not None:
request.entity_type = 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_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(
(("entity_type.name", request.entity_type.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response