Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::EntityType::Entity (v0.24.2)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::EntityType::Entity.

An entity entry for an associated entity type.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#synonyms

def synonyms() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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.

#synonyms=

def synonyms=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    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
  • (::Array<::String>) —

    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.

#value

def value() -> ::String
Returns
  • (::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).

#value=

def value=(value) -> ::String
Parameter
  • 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).
Returns
  • (::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).