Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class EntityType.
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.
Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the Entity guide.
Generated from protobuf message google.cloud.dialogflow.v2.EntityType
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: |
↳ display_name |
string
Required. The name of the entity type. |
↳ kind |
int
Required. Indicates the kind of entity type. |
↳ auto_expansion_mode |
int
Optional. Indicates whether the entity type can be automatically expanded. |
↳ entities |
array<Google\Cloud\Dialogflow\V2\EntityType\Entity>
Optional. The collection of entity entries associated with the entity type. |
↳ enable_fuzzy_extraction |
bool
Optional. Enables fuzzy entity extraction during classification. |
getName
The unique identifier of the entity type.
Required for EntityTypes.UpdateEntityType and
EntityTypes.BatchUpdateEntityTypes methods.
Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The unique identifier of the entity type.
Required for EntityTypes.UpdateEntityType and
EntityTypes.BatchUpdateEntityTypes methods.
Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The name of the entity type.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The name of the entity type.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
Required. Indicates the kind of entity type.
Generated from protobuf field .google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setKind
Required. Indicates the kind of entity type.
Generated from protobuf field .google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutoExpansionMode
Optional. Indicates whether the entity type can be automatically expanded.
Generated from protobuf field .google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setAutoExpansionMode
Optional. Indicates whether the entity type can be automatically expanded.
Generated from protobuf field .google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntities
Optional. The collection of entity entries associated with the entity type.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEntities
Optional. The collection of entity entries associated with the entity type.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\EntityType\Entity>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableFuzzyExtraction
Optional. Enables fuzzy entity extraction during classification.
Generated from protobuf field bool enable_fuzzy_extraction = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableFuzzyExtraction
Optional. Enables fuzzy entity extraction during classification.
Generated from protobuf field bool enable_fuzzy_extraction = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |