Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.SessionEntityType
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The unique identifier of the session entity type. Format: |
↳ entity_override_mode |
int
Required. Indicates whether the additional data should override or supplement the custom entity type definition. |
↳ entities |
array<Google\Cloud\Dialogflow\Cx\V3\EntityType\Entity>
Required. The collection of entities to override or supplement the custom entity type. |
getName
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>. If Environment ID is not specified, we assume default 'draft'
environment.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>. If Environment ID is not specified, we assume default 'draft'
environment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntityOverrideMode
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
| Returns | |
|---|---|
| Type | Description |
int | |
setEntityOverrideMode
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntities
Required. The collection of entities to override or supplement the custom entity type.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEntities
Required. The collection of entities to override or supplement the custom entity type.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\EntityType\Entity>
|
| Returns | |
|---|---|
| Type | Description |
$this | |