Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#auto_expansion_mode ⇒ String
Indicates whether the entity type can be automatically expanded.
-
#display_name ⇒ String
Required.
-
#enable_fuzzy_extraction ⇒ Boolean
(also: #enable_fuzzy_extraction?)
Enables fuzzy entity extraction during classification.
-
#entities ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityTypeEntity>
The collection of entity entries associated with the entity type.
-
#excluded_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase>
Collection of exceptional words and phrases that shouldn't be matched.
-
#kind ⇒ String
Required.
-
#name ⇒ String
The unique identifier of the entity type.
-
#redact ⇒ Boolean
(also: #redact?)
Indicates whether parameters of the entity type should be redacted in log.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3EntityType
constructor
A new instance of GoogleCloudDialogflowCxV3EntityType.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3EntityType
Returns a new instance of GoogleCloudDialogflowCxV3EntityType.
1517 1518 1519 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1517 def initialize(**args) update!(**args) end |
Instance Attribute Details
#auto_expansion_mode ⇒ String
Indicates whether the entity type can be automatically expanded.
Corresponds to the JSON property autoExpansionMode
1471 1472 1473 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1471 def auto_expansion_mode @auto_expansion_mode end |
#display_name ⇒ String
Required. The human-readable name of the entity type, unique within the agent.
Corresponds to the JSON property displayName
1476 1477 1478 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1476 def display_name @display_name end |
#enable_fuzzy_extraction ⇒ Boolean Also known as: enable_fuzzy_extraction?
Enables fuzzy entity extraction during classification.
Corresponds to the JSON property enableFuzzyExtraction
1481 1482 1483 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1481 def enable_fuzzy_extraction @enable_fuzzy_extraction end |
#entities ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityTypeEntity>
The collection of entity entries associated with the entity type.
Corresponds to the JSON property entities
1487 1488 1489 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1487 def entities @entities end |
#excluded_phrases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase>
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.
Corresponds to the JSON property excludedPhrases
1496 1497 1498 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1496 def excluded_phrases @excluded_phrases end |
#kind ⇒ String
Required. Indicates the kind of entity type.
Corresponds to the JSON property kind
1501 1502 1503 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1501 def kind @kind end |
#name ⇒ String
The unique identifier of the entity type. Required for EntityTypes.
UpdateEntityType. Format: projects//locations//agents//entityTypes/
.
Corresponds to the JSON property name
1507 1508 1509 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1507 def name @name end |
#redact ⇒ Boolean Also known as: redact?
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.
Corresponds to the JSON property redact
1514 1515 1516 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1514 def redact @redact end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1522 def update!(**args) @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) @display_name = args[:display_name] if args.key?(:display_name) @enable_fuzzy_extraction = args[:enable_fuzzy_extraction] if args.key?(:enable_fuzzy_extraction) @entities = args[:entities] if args.key?(:entities) @excluded_phrases = args[:excluded_phrases] if args.key?(:excluded_phrases) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @redact = args[:redact] if args.key?(:redact) end |