REST Resource: projects.locations.agents.environments.sessions.entityTypes

Resource: 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 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.

JSON representation 
{
  "name": string,
  "entityOverrideMode": enum (EntityOverrideMode),
  "entities": [
    {
      object (Entity)
    }
  ]
}
Fields
name

string

Required. The unique identifier of the session entity type. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>. If Environment ID is not specified, we assume default 'draft' environment.
entityOverrideMode

enum (EntityOverrideMode)

Required. Indicates whether the additional data should override or supplement the custom entity type definition.
entities[]

object (Entity)

Required. The collection of entities to override or supplement the custom entity type.

EntityOverrideMode

The types of modifications for the session entity type.

Enums
ENTITY_OVERRIDE_MODE_UNSPECIFIED Not specified. This value should be never used.
ENTITY_OVERRIDE_MODE_OVERRIDE The collection of session entities overrides the collection of entities in the corresponding custom entity type.
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding custom entity type.

Note: Even in this override mode calls to entityTypes.list, entityTypes.get, entityTypes.create and entityTypes.patch only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.

Methods

create

 Creates a session entity type.

delete

 Deletes the specified session entity type.

get

 Retrieves the specified session entity type.

list

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

patch

 Updates the specified session entity type.