REST Resource: projects.locations.agent.environments.users.sessions.entityTypes

Resource: SessionEntityType

A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the session entity guide.

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

string

Required. The unique identifier of this session entity type. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>

If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
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 associated with this session entity type.

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.