Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class 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 .
Generated from protobuf message google.cloud.dialogflow.v2.SessionEntityType
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
. 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.
↳ entity_override_mode
int
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
↳ entities
array< Google\Cloud\Dialogflow\V2\EntityType\Entity
>
Required. The collection of entities associated with this session entity type.
getName
Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
Display Name>
, or projects/<Project ID>/agent/environments/<Environment
ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
Name>
.
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.
string
setName
Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
Display Name>
, or projects/<Project ID>/agent/environments/<Environment
ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
Name>
.
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.
var
string
$this
getEntityOverrideMode
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
int
setEntityOverrideMode
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
var
int
$this
getEntities
Required. The collection of entities associated with this session entity type.
setEntities
Required. The collection of entities associated with this session entity type.
$this