Struct googapis::google::cloud::dialogflow::cx::v3::EntityType [−][src]
pub struct EntityType {
pub name: String,
pub display_name: String,
pub kind: i32,
pub auto_expansion_mode: i32,
pub entities: Vec<Entity>,
pub excluded_phrases: Vec<ExcludedPhrase>,
pub enable_fuzzy_extraction: bool,
pub redact: bool,
}
Expand description
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, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
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][google.cloud.dialogflow.cx.v3.SessionEntityType] type.
For more information about entity types, see the Dialogflow documentation.
Fields
name: String
The unique identifier of the entity type.
Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>
.
display_name: String
Required. The human-readable name of the entity type, unique within the agent.
kind: i32
Required. Indicates the kind of entity type.
auto_expansion_mode: i32
Indicates whether the entity type can be automatically expanded.
entities: Vec<Entity>
The collection of entity entries associated with the entity type.
excluded_phrases: Vec<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.
enable_fuzzy_extraction: bool
Enables fuzzy entity extraction during classification.
redact: bool
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.
Implementations
Returns the enum value of kind
, or the default if the field is set to an invalid enum value.
Returns the enum value of auto_expansion_mode
, or the default if the field is set to an invalid enum value.
Sets auto_expansion_mode
to the provided enum value.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for EntityType
impl Send for EntityType
impl Sync for EntityType
impl Unpin for EntityType
impl UnwindSafe for EntityType
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more