entity_types

Creates, updates, deletes, gets or lists a entity_types resource.

Overview

Name	entity_types
Type	Resource
Id	google.dialogflow.entity_types

Fields

Name	Datatype	Description
name	string	Required. The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.
entities	array	Required. The collection of entities to override or supplement the custom entity type.
entityOverrideMode	string	Required. Indicates whether the additional data should override or supplement the custom entity type definition.

Methods

Name	Accessible by	Required Params	Description
projects_locations_agents_entity_types_get	SELECT	agentsId, entityTypesId, locationsId, projectsId	Retrieves the specified entity type.
projects_locations_agents_entity_types_list	SELECT	agentsId, locationsId, projectsId	Returns the list of all entity types in the specified agent.
projects_locations_agents_environments_sessions_entity_types_get	SELECT	agentsId, entityTypesId, environmentsId, locationsId, projectsId, sessionsId	Retrieves the specified session entity type.
projects_locations_agents_environments_sessions_entity_types_list	SELECT	agentsId, environmentsId, locationsId, projectsId, sessionsId	Returns the list of all session entity types in the specified session.
projects_locations_agents_sessions_entity_types_get	SELECT	agentsId, entityTypesId, locationsId, projectsId, sessionsId	Retrieves the specified session entity type.
projects_locations_agents_sessions_entity_types_list	SELECT	agentsId, locationsId, projectsId, sessionsId	Returns the list of all session entity types in the specified session.
projects_locations_agents_entity_types_create	INSERT	agentsId, locationsId, projectsId	Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_environments_sessions_entity_types_create	INSERT	agentsId, environmentsId, locationsId, projectsId, sessionsId	Creates a session entity type.
projects_locations_agents_sessions_entity_types_create	INSERT	agentsId, locationsId, projectsId, sessionsId	Creates a session entity type.
projects_locations_agents_entity_types_delete	DELETE	agentsId, entityTypesId, locationsId, projectsId	Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_environments_sessions_entity_types_delete	DELETE	agentsId, entityTypesId, environmentsId, locationsId, projectsId, sessionsId	Deletes the specified session entity type.
projects_locations_agents_sessions_entity_types_delete	DELETE	agentsId, entityTypesId, locationsId, projectsId, sessionsId	Deletes the specified session entity type.
projects_locations_agents_entity_types_patch	UPDATE	agentsId, entityTypesId, locationsId, projectsId	Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_environments_sessions_entity_types_patch	UPDATE	agentsId, entityTypesId, environmentsId, locationsId, projectsId, sessionsId	Updates the specified session entity type.
projects_locations_agents_sessions_entity_types_patch	UPDATE	agentsId, entityTypesId, locationsId, projectsId, sessionsId	Updates the specified session entity type.
projects_locations_agents_entity_types_export	EXEC	agentsId, locationsId, projectsId	Exports the selected entity types.
projects_locations_agents_entity_types_import	EXEC	agentsId, locationsId, projectsId	Imports the specified entitytypes into the agent.

SELECT examples

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

SELECT
name,
entities,
entityOverrideMode
FROM google.dialogflow.entity_types
WHERE agentsId = '{{ agentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new entity_types resource.

All Properties

/*+ create */
INSERT INTO google.dialogflow.entity_types (
agentsId,
locationsId,
projectsId,
name,
displayName,
autoExpansionMode,
entities,
excludedPhrases,
enableFuzzyExtraction,
redact
)
SELECT 
'{{ agentsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ autoExpansionMode }}',
'{{ entities }}',
'{{ excludedPhrases }}',
{{ enableFuzzyExtraction }},
{{ redact }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: kind
      value: string
    - name: autoExpansionMode
      value: string
    - name: entities
      value:
        - - name: value
            value: string
          - name: synonyms
            value:
              - string
    - name: excludedPhrases
      value:
        - - name: value
            value: string
    - name: enableFuzzyExtraction
      value: boolean
    - name: redact
      value: boolean

UPDATE example

Updates a entity_types resource.

/*+ update */
UPDATE google.dialogflow.entity_types
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
autoExpansionMode = '{{ autoExpansionMode }}',
entities = '{{ entities }}',
excludedPhrases = '{{ excludedPhrases }}',
enableFuzzyExtraction = true|false,
redact = true|false
WHERE 
agentsId = '{{ agentsId }}'
AND entityTypesId = '{{ entityTypesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified entity_types resource.

/*+ delete */
DELETE FROM google.dialogflow.entity_types
WHERE agentsId = '{{ agentsId }}'
AND entityTypesId = '{{ entityTypesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';