entity_types

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

Overview

Name	entity_types
Type	Resource
Id	google.dialogflow.entity_types

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_environments_sessions_entity_types_get

Name	Datatype	Description
name	string
entities	array
entityOverrideMode	string	(ENTITY_OVERRIDE_MODE_UNSPECIFIED, ENTITY_OVERRIDE_MODE_OVERRIDE, ENTITY_OVERRIDE_MODE_SUPPLEMENT)

projects_locations_agents_sessions_entity_types_get

Name	Datatype	Description
name	string
entities	array
entityOverrideMode	string	(ENTITY_OVERRIDE_MODE_UNSPECIFIED, ENTITY_OVERRIDE_MODE_OVERRIDE, ENTITY_OVERRIDE_MODE_SUPPLEMENT)

projects_locations_agents_environments_sessions_entity_types_list

Name	Datatype	Description
name	string
entities	array
entityOverrideMode	string	(ENTITY_OVERRIDE_MODE_UNSPECIFIED, ENTITY_OVERRIDE_MODE_OVERRIDE, ENTITY_OVERRIDE_MODE_SUPPLEMENT)

projects_locations_agents_entity_types_get

Name	Datatype	Description
name	string
autoExpansionMode	string	(AUTO_EXPANSION_MODE_UNSPECIFIED, AUTO_EXPANSION_MODE_DEFAULT)
displayName	string
enableFuzzyExtraction	boolean
entities	array
excludedPhrases	array
kind	string	(KIND_UNSPECIFIED, KIND_MAP, KIND_LIST, KIND_REGEXP)
redact	boolean

projects_locations_agents_sessions_entity_types_list

Name	Datatype	Description
name	string
entities	array
entityOverrideMode	string	(ENTITY_OVERRIDE_MODE_UNSPECIFIED, ENTITY_OVERRIDE_MODE_OVERRIDE, ENTITY_OVERRIDE_MODE_SUPPLEMENT)

projects_locations_agents_entity_types_list

Name	Datatype	Description
name	string
autoExpansionMode	string	(AUTO_EXPANSION_MODE_UNSPECIFIED, AUTO_EXPANSION_MODE_DEFAULT)
displayName	string
enableFuzzyExtraction	boolean
entities	array
excludedPhrases	array
kind	string	(KIND_UNSPECIFIED, KIND_MAP, KIND_LIST, KIND_REGEXP)
redact	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_environments_sessions_entity_types_get	select	projectsId, locationsId, agentsId, environmentsId, sessionsId, entityTypesId
projects_locations_agents_sessions_entity_types_get	select	projectsId, locationsId, agentsId, sessionsId, entityTypesId
projects_locations_agents_environments_sessions_entity_types_list	select	projectsId, locationsId, agentsId, environmentsId, sessionsId	pageToken, pageSize
projects_locations_agents_entity_types_get	select	projectsId, locationsId, agentsId, entityTypesId	languageCode
projects_locations_agents_sessions_entity_types_list	select	projectsId, locationsId, agentsId, sessionsId	pageSize, pageToken
projects_locations_agents_entity_types_list	select	projectsId, locationsId, agentsId	pageToken, languageCode, pageSize
projects_locations_agents_environments_sessions_entity_types_create	insert	projectsId, locationsId, agentsId, environmentsId, sessionsId
projects_locations_agents_sessions_entity_types_create	insert	projectsId, locationsId, agentsId, sessionsId
projects_locations_agents_entity_types_create	insert	projectsId, locationsId, agentsId	languageCode
projects_locations_agents_environments_sessions_entity_types_patch	update	projectsId, locationsId, agentsId, environmentsId, sessionsId, entityTypesId	updateMask
projects_locations_agents_sessions_entity_types_patch	update	projectsId, locationsId, agentsId, sessionsId, entityTypesId	updateMask
projects_locations_agents_entity_types_patch	update	projectsId, locationsId, agentsId, entityTypesId	languageCode, updateMask
projects_locations_agents_environments_sessions_entity_types_delete	delete	projectsId, locationsId, agentsId, environmentsId, sessionsId, entityTypesId
projects_locations_agents_sessions_entity_types_delete	delete	projectsId, locationsId, agentsId, sessionsId, entityTypesId
projects_locations_agents_entity_types_delete	delete	projectsId, locationsId, agentsId, entityTypesId	force
projects_locations_agents_entity_types_export	exec	projectsId, locationsId, agentsId
projects_locations_agents_entity_types_import	exec	projectsId, locationsId, agentsId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
entityTypesId	string
environmentsId	string
locationsId	string
projectsId	string
sessionsId	string
force	boolean
languageCode	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_environments_sessions_entity_types_get

Successful response

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

projects_locations_agents_sessions_entity_types_get

Successful response

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

projects_locations_agents_environments_sessions_entity_types_list

Successful response

SELECT
name,
entities,
entityOverrideMode
FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND sessionsId = '{{ sessionsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_agents_entity_types_get

Successful response

SELECT
name,
autoExpansionMode,
displayName,
enableFuzzyExtraction,
entities,
excludedPhrases,
kind,
redact
FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND entityTypesId = '{{ entityTypesId }}' -- required
AND languageCode = '{{ languageCode }}'
;

projects_locations_agents_sessions_entity_types_list

Successful response

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

projects_locations_agents_entity_types_list

Successful response

SELECT
name,
autoExpansionMode,
displayName,
enableFuzzyExtraction,
entities,
excludedPhrases,
kind,
redact
FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND languageCode = '{{ languageCode }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_agents_environments_sessions_entity_types_create

No description available.

INSERT INTO google.dialogflow.entity_types (
data__name,
data__entityOverrideMode,
data__entities,
projectsId,
locationsId,
agentsId,
environmentsId,
sessionsId
)
SELECT 
'{{ name }}',
'{{ entityOverrideMode }}',
'{{ entities }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ environmentsId }}',
'{{ sessionsId }}'
RETURNING
name,
entities,
entityOverrideMode
;

projects_locations_agents_sessions_entity_types_create

No description available.

INSERT INTO google.dialogflow.entity_types (
data__name,
data__entityOverrideMode,
data__entities,
projectsId,
locationsId,
agentsId,
sessionsId
)
SELECT 
'{{ name }}',
'{{ entityOverrideMode }}',
'{{ entities }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ sessionsId }}'
RETURNING
name,
entities,
entityOverrideMode
;

projects_locations_agents_entity_types_create

No description available.

INSERT INTO google.dialogflow.entity_types (
data__entities,
data__excludedPhrases,
data__redact,
data__displayName,
data__kind,
data__autoExpansionMode,
data__enableFuzzyExtraction,
data__name,
projectsId,
locationsId,
agentsId,
languageCode
)
SELECT 
'{{ entities }}',
'{{ excludedPhrases }}',
{{ redact }},
'{{ displayName }}',
'{{ kind }}',
'{{ autoExpansionMode }}',
{{ enableFuzzyExtraction }},
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ languageCode }}'
RETURNING
name,
autoExpansionMode,
displayName,
enableFuzzyExtraction,
entities,
excludedPhrases,
kind,
redact
;

Manifest

# Description fields are for documentation purposes
- name: entity_types
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the entity_types resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the entity_types resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the entity_types resource.
  - name: environmentsId
    value: "{{ environmentsId }}"
    description: Required parameter for the entity_types resource.
  - name: sessionsId
    value: "{{ sessionsId }}"
    description: Required parameter for the entity_types resource.
  - name: name
    value: "{{ name }}"
  - name: entityOverrideMode
    value: "{{ entityOverrideMode }}"
    valid_values: ['ENTITY_OVERRIDE_MODE_UNSPECIFIED', 'ENTITY_OVERRIDE_MODE_OVERRIDE', 'ENTITY_OVERRIDE_MODE_SUPPLEMENT']
  - name: entities
    value:
      - value: "{{ value }}"
        synonyms: "{{ synonyms }}"
  - name: excludedPhrases
    value:
      - value: "{{ value }}"
  - name: redact
    value: {{ redact }}
  - name: displayName
    value: "{{ displayName }}"
  - name: kind
    value: "{{ kind }}"
    valid_values: ['KIND_UNSPECIFIED', 'KIND_MAP', 'KIND_LIST', 'KIND_REGEXP']
  - name: autoExpansionMode
    value: "{{ autoExpansionMode }}"
    valid_values: ['AUTO_EXPANSION_MODE_UNSPECIFIED', 'AUTO_EXPANSION_MODE_DEFAULT']
  - name: enableFuzzyExtraction
    value: {{ enableFuzzyExtraction }}
  - name: languageCode
    value: "{{ languageCode }}"

UPDATE examples

projects_locations_agents_environments_sessions_entity_types_patch

No description available.

UPDATE google.dialogflow.entity_types
SET 
data__name = '{{ name }}',
data__entityOverrideMode = '{{ entityOverrideMode }}',
data__entities = '{{ entities }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND sessionsId = '{{ sessionsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
entities,
entityOverrideMode;

projects_locations_agents_sessions_entity_types_patch

No description available.

UPDATE google.dialogflow.entity_types
SET 
data__name = '{{ name }}',
data__entityOverrideMode = '{{ entityOverrideMode }}',
data__entities = '{{ entities }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND sessionsId = '{{ sessionsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
entities,
entityOverrideMode;

projects_locations_agents_entity_types_patch

No description available.

UPDATE google.dialogflow.entity_types
SET 
data__entities = '{{ entities }}',
data__excludedPhrases = '{{ excludedPhrases }}',
data__redact = {{ redact }},
data__displayName = '{{ displayName }}',
data__kind = '{{ kind }}',
data__autoExpansionMode = '{{ autoExpansionMode }}',
data__enableFuzzyExtraction = {{ enableFuzzyExtraction }},
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
AND languageCode = '{{ languageCode}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
autoExpansionMode,
displayName,
enableFuzzyExtraction,
entities,
excludedPhrases,
kind,
redact;

DELETE examples

projects_locations_agents_environments_sessions_entity_types_delete

No description available.

DELETE FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND sessionsId = '{{ sessionsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
;

projects_locations_agents_sessions_entity_types_delete

No description available.

DELETE FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND sessionsId = '{{ sessionsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
;

projects_locations_agents_entity_types_delete

No description available.

DELETE FROM google.dialogflow.entity_types
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND entityTypesId = '{{ entityTypesId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

projects_locations_agents_entity_types_export

Successful response

EXEC google.dialogflow.entity_types.projects_locations_agents_entity_types_export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"languageCode": "{{ languageCode }}", 
"entityTypesUri": "{{ entityTypesUri }}", 
"entityTypes": "{{ entityTypes }}", 
"entityTypesContentInline": {{ entityTypesContentInline }}, 
"dataFormat": "{{ dataFormat }}"
}'
;

projects_locations_agents_entity_types_import

Successful response

EXEC google.dialogflow.entity_types.projects_locations_agents_entity_types_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"entityTypesUri": "{{ entityTypesUri }}", 
"entityTypesContent": "{{ entityTypesContent }}", 
"mergeOption": "{{ mergeOption }}", 
"targetEntityType": "{{ targetEntityType }}"
}'
;