Google Cloud Dialogflow V2 Client - Class EntityType (1.1.1)

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
NameDescription
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: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

↳ 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>.

Returns
TypeDescription
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>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Required. The name of the entity type.

Returns
TypeDescription
string

setDisplayName

Required. The name of the entity type.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKind

Required. Indicates the kind of entity type.

Returns
TypeDescription
int

setKind

Required. Indicates the kind of entity type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAutoExpansionMode

Optional. Indicates whether the entity type can be automatically expanded.

Returns
TypeDescription
int

setAutoExpansionMode

Optional. Indicates whether the entity type can be automatically expanded.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEntities

Optional. The collection of entity entries associated with the entity type.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEntities

Optional. The collection of entity entries associated with the entity type.

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\V2\EntityType\Entity>
Returns
TypeDescription
$this

getEnableFuzzyExtraction

Optional. Enables fuzzy entity extraction during classification.

Returns
TypeDescription
bool

setEnableFuzzyExtraction

Optional. Enables fuzzy entity extraction during classification.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this