Struct google_cognitive_apis::api::grpc::google::cloud::dialogflow::cx::v3beta1::EntityType
source · [−]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.v3beta1.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.v3beta1.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 during logging.
Implementations
sourceimpl EntityType
impl EntityType
sourcepub fn kind(&self) -> Kind
pub fn kind(&self) -> Kind
Returns the enum value of kind
, or the default if the field is set to an invalid enum value.
sourcepub fn auto_expansion_mode(&self) -> AutoExpansionMode
pub fn auto_expansion_mode(&self) -> AutoExpansionMode
Returns the enum value of auto_expansion_mode
, or the default if the field is set to an invalid enum value.
sourcepub fn set_auto_expansion_mode(&mut self, value: AutoExpansionMode)
pub fn set_auto_expansion_mode(&mut self, value: AutoExpansionMode)
Sets auto_expansion_mode
to the provided enum value.
Trait Implementations
sourceimpl Clone for EntityType
impl Clone for EntityType
sourcefn clone(&self) -> EntityType
fn clone(&self) -> EntityType
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for EntityType
impl Debug for EntityType
sourceimpl Default for EntityType
impl Default for EntityType
sourceimpl Message for EntityType
impl Message for EntityType
sourcefn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Returns the encoded length of the message without a length delimiter.
sourcefn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
Encodes the message to a buffer. Read more
sourcefn encode_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn encode_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Encodes the message to a newly allocated buffer.
sourcefn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
Encodes the message with a length-delimiter to a buffer. Read more
sourcefn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Encodes the message with a length-delimiter to a newly allocated buffer.
sourcefn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
sourcefn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: Buf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
sourcefn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
Decodes an instance of the message from a buffer, and merges it into self
. Read more
sourcefn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: Buf,
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
sourceimpl PartialEq<EntityType> for EntityType
impl PartialEq<EntityType> for EntityType
sourcefn eq(&self, other: &EntityType) -> bool
fn eq(&self, other: &EntityType) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for EntityType
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
sourcefn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message T
in a tonic::Request