Struct RecallHit 

pub struct RecallHit {
    pub key: String,
    pub label: String,
    pub summary: Option<String>,
    pub covered: usize,
    pub score: f64,
}

One node a topic matched.

key, label and summary are stored content, unsanitized: only recall_digest passes them through sanitize. A caller rendering them into an assistant’s context owes core_api::digest::sanitize.

Fields

key: String

label: String

The node’s label, or empty if it vanished between the search and here.

summary: Option<String>

The first of text, summary or name the node carries, as GraphDb::node_summary_line cuts it.

covered: usize

How many of the topic’s terms this node’s own text holds. 0 when the topic was all stopwords and its words were searched as one AND-group, where every hit holds all of them.

score: f64

The fused score. Rank-derived, so nearly flat across hits: order by covered first, as this list already is.

Trait Implementations

impl Clone for RecallHit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecallHit

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

Formats the value using the given formatter.

impl PartialEq for RecallHit

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RecallHit

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 RecallHit