async def create_session_entity_type( self, request: gcdc_session_entity_type.CreateSessionEntityTypeRequest = None, *, parent: str = None, session_entity_type: gcdc_session_entity_type.SessionEntityType = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> gcdc_session_entity_type.SessionEntityType: r"""Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. Args: request (:class:`~.gcdc_session_entity_type.CreateSessionEntityTypeRequest`): The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3beta1.SessionEntityTypes.CreateSessionEntityType]. parent (:class:`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 (:class:`~.gcdc_session_entity_type.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: ~.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.v3beta1.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. if request is not None and any([parent, session_entity_type]): raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) request = gcdc_session_entity_type.CreateSessionEntityTypeRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent if session_entity_type is not None: request.session_entity_type = session_entity_type # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.create_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((("parent", request.parent),)), ) # Send the request. response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) # Done; return the response. return response
def create_session_entity_type( self, request: Union[gcdc_session_entity_type.CreateSessionEntityTypeRequest, dict] = None, *, parent: str = None, session_entity_type: gcdc_session_entity_type.SessionEntityType = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> gcdc_session_entity_type.SessionEntityType: r"""Creates a session entity type. .. code-block:: from google.cloud import dialogflowcx_v3beta1 def sample_create_session_entity_type(): # Create a client client = dialogflowcx_v3beta1.SessionEntityTypesClient() # Initialize request argument(s) session_entity_type = dialogflowcx_v3beta1.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_v3beta1.CreateSessionEntityTypeRequest( parent="parent_value", session_entity_type=session_entity_type, ) # Make the request response = client.create_session_entity_type(request=request) # Handle the response print(response) Args: request (Union[google.cloud.dialogflowcx_v3beta1.types.CreateSessionEntityTypeRequest, dict]): The request object. The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3beta1.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_v3beta1.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: google.cloud.dialogflowcx_v3beta1.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.v3beta1.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([parent, session_entity_type]) 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.CreateSessionEntityTypeRequest. # 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.CreateSessionEntityTypeRequest): request = gcdc_session_entity_type.CreateSessionEntityTypeRequest( request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent if session_entity_type is not None: request.session_entity_type = session_entity_type # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.create_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( (("parent", request.parent), )), ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response