Struct google_api_proto::google::cloud::dialogflow::cx::v3::EntityType

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,
}

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][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

impl EntityType

pub fn kind(&self) -> Kind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: Kind)

Sets kind to the provided enum value.

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.

pub fn set_auto_expansion_mode(&mut self, value: AutoExpansionMode)

Sets auto_expansion_mode to the provided enum value.

Trait Implementations

impl Clone for EntityType

fn clone(&self) -> EntityType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EntityType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EntityType

fn default() -> Self

Returns the “default value” for a type.

impl Message for EntityType

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for EntityType

fn eq(&self, other: &EntityType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EntityType