Struct RetrievalEntity 

pub struct RetrievalEntity {
    pub surface: String,
    pub canonical: Option<String>,
}

An entity the plan wants memories about.

Fields

surface: String

The surface form as spoken (“my wife”, “Rhea”).

canonical: Option<String>

A canonical form when one is known.

Implementations

impl RetrievalEntity

pub fn surface(surface: impl Into<String>) -> Self

An entity known only by how the user said it.

pub fn resolved( surface: impl Into<String>, canonical: impl Into<String>, ) -> Self

An entity resolved to a canonical name.

pub fn forms(&self) -> Vec<String>

Every form this entity should be matched by.

Trait Implementations

impl Clone for RetrievalEntity

fn clone(&self) -> RetrievalEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrievalEntity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RetrievalEntity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RetrievalEntity

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for RetrievalEntity

fn eq(&self, other: &RetrievalEntity) -> 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 Serialize for RetrievalEntity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RetrievalEntity