Google Cloud Dialogflow Cx V3 Client - Class Entity (0.4.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Entity.

An entity entry for an associated entity type.

Generated from protobuf message google.cloud.dialogflow.cx.v3.EntityType.Entity

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3 \ EntityType

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ value string

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: * A canonical value to be used in place of synonyms. For KIND_LIST entity types: * A string that can contain references to other entity types (with or without aliases).
↳ synonyms array

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: * This collection must contain exactly one synonym equal to value.

getValue

Required. The primary value associated with this entity entry.

For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms. For KIND_LIST entity types:
  • A string that can contain references to other entity types (with or without aliases).
Returns
Type Description
string

setValue

Required. The primary value associated with this entity entry.

For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms. For KIND_LIST entity types:
  • A string that can contain references to other entity types (with or without aliases).
Parameter
Name Description
var string
Returns
Type Description
$this

getSynonyms

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSynonyms

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.
Parameter
Name Description
var string[]
Returns
Type Description
$this