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

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

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

  • System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.

  • Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.

  • User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type.

For more information about entity types, see the Dialogflow documentation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_expansion_mode

def auto_expansion_mode() -> ::Google::Cloud::Dialogflow::CX::V3::EntityType::AutoExpansionMode
Returns

#auto_expansion_mode=

def auto_expansion_mode=(value) -> ::Google::Cloud::Dialogflow::CX::V3::EntityType::AutoExpansionMode
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human-readable name of the entity type, unique within the agent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human-readable name of the entity type, unique within the agent.
Returns
  • (::String) — Required. The human-readable name of the entity type, unique within the agent.

#enable_fuzzy_extraction

def enable_fuzzy_extraction() -> ::Boolean
Returns
  • (::Boolean) — Enables fuzzy entity extraction during classification.

#enable_fuzzy_extraction=

def enable_fuzzy_extraction=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Enables fuzzy entity extraction during classification.
Returns
  • (::Boolean) — Enables fuzzy entity extraction during classification.

#entities

def entities() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>
Returns

#entities=

def entities=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>
Parameter
Returns

#excluded_phrases

def excluded_phrases() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>
Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>) — Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

#excluded_phrases=

def excluded_phrases=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>
Parameter
  • value (::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>) — Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.
Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::ExcludedPhrase>) — Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

#kind

def kind() -> ::Google::Cloud::Dialogflow::CX::V3::EntityType::Kind
Returns

#kind=

def kind=(value) -> ::Google::Cloud::Dialogflow::CX::V3::EntityType::Kind
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
Returns
  • (::String) — The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

#redact

def redact() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

#redact=

def redact=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.
Returns
  • (::Boolean) — Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.