Struct Document

pub struct Document {
    pub page_content: String,
    pub metadata: HashMap<String, Value>,
    pub score: f64,
}

The Document struct represents a document with content, metadata, and a score. The page_content field is a string that contains the content of the document. The metadata field is a HashMap where the keys represent metadata properties and the values represent property values. The score field represents a relevance score for the document and is a floating point number.

Usage

let my_doc = Document::new("This is the document content.".to_string())
   .with_metadata({
      let mut metadata = HashMap::new();
      metadata.insert("author".to_string(), json!("John Doe"));
      metadata
  })
   .with_score(0.75);

Fields

page_content: String

metadata: HashMap<String, Value>

score: f64

Implementations

impl Document

pub fn new<S: Into<String>>(page_content: S) -> Self

Constructs a new Document with provided page_content, an empty metadata map and a score of 0.

pub fn with_metadata(self, metadata: HashMap<String, Value>) -> Self

Sets the metadata Map of the Document to the provided HashMap.

pub fn with_score(self, score: f64) -> Self

Sets the score of the Document to the provided float.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Provides a default Document with an empty page_content, an empty metadata map and a score of 0.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.