Struct TopicNamedEntity 

#[non_exhaustive]
pub struct TopicNamedEntity {
    pub entity_name: String,
    pub entity_description: Option<String>,
    pub entity_synonyms: Option<Vec<String>>,
    pub semantic_entity_type: Option<SemanticEntityType>,
    pub definition: Option<Vec<NamedEntityDefinition>>,
}

A structure that represents a named entity.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity_name: String

The name of the named entity.

entity_description: Option<String>

The description of the named entity.

entity_synonyms: Option<Vec<String>>

The other names or aliases for the named entity.

semantic_entity_type: Option<SemanticEntityType>

The type of named entity that a topic represents.

definition: Option<Vec<NamedEntityDefinition>>

The definition of a named entity.

Implementations

impl TopicNamedEntity

pub fn entity_name(&self) -> &str

The name of the named entity.

pub fn entity_description(&self) -> Option<&str>

The description of the named entity.

pub fn entity_synonyms(&self) -> &[String]

The other names or aliases for the named entity.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entity_synonyms.is_none().

pub fn semantic_entity_type(&self) -> Option<&SemanticEntityType>

The type of named entity that a topic represents.

pub fn definition(&self) -> &[NamedEntityDefinition]

The definition of a named entity.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .definition.is_none().

impl TopicNamedEntity

pub fn builder() -> TopicNamedEntityBuilder

Creates a new builder-style object to manufacture TopicNamedEntity.

Trait Implementations

impl Clone for TopicNamedEntity

fn clone(&self) -> TopicNamedEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicNamedEntity

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

Formats the value using the given formatter.

impl PartialEq for TopicNamedEntity

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for TopicNamedEntity