Struct SearchDocument 

pub struct SearchDocument {
    pub id: String,
    pub title: Option<String>,
    pub body: String,
    pub metadata: BTreeMap<String, String>,
    pub source: Option<TextSourceRef>,
    pub provenance: Vec<TextProvenance>,
    pub annotations: Vec<TextAnnotationSpan>,
}

Data type for search document.

Fields

id: String

Identifier for this value.

title: Option<String>

The title value.

body: String

The body value.

metadata: BTreeMap<String, String>

Metadata associated with this value.

source: Option<TextSourceRef>

Optional rich source reference.

provenance: Vec<TextProvenance>

Provenance records for this document.

annotations: Vec<TextAnnotationSpan>

Annotation spans associated with this document.

Implementations

impl SearchDocument

pub fn new(id: impl Into<String>, body: impl Into<String>) -> Self

Creates a new value.

pub fn from_text_document(document: &TextDocument<'_>) -> Self

Builds this value from text document.

pub fn from_text_document_contract(document: &TextDocumentContract) -> Self

Builds this value from a portable text document contract.

pub fn from_text_segment_contract(segment: &TextSegmentContract) -> Self

Builds this value from a portable text segment contract.

pub fn from_text_corpus_document(document: &TextCorpusDocument) -> Self

Builds this value from a lexical corpus document without losing rich metadata.

pub fn from_text_corpus(corpus: &TextCorpus) -> Vec<Self>

Builds retrieval documents from a lexical corpus.

Trait Implementations

impl Clone for SearchDocument

fn clone(&self) -> SearchDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchDocument

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

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 SearchDocument