Struct anchor_chain::vector::document::Document

pub struct Document {
    pub id: String,
    pub text: String,
    pub embedding: Option<Vec<f32>>,
    pub embedding_name: Option<String>,
    pub metadata: Option<Value>,
}

Document structure for serializing and deserializing when working with vector databases.

The id field is a unique identifier for the document. If not provided, it will be generated using a hash of the text field. The text field is the main content of the document. The embedding field is an optional field that can be used to store a vector embedding of the document. The embedding_name field is the name of the field that the embedding is stored in. The metadata field is an optional field that can be used to store additional metadata about the document.

Fields

id: String

text: String

embedding: Option<Vec<f32>>

embedding_name: Option<String>

metadata: Option<Value>

Implementations

impl Document

pub fn new(text: String) -> Self

Create a new document with the given text.

pub fn new_with_id(id: String, text: String) -> Self

Create a new document with the given id and text.

pub fn new_with_embedding( text: String, embedding: Vec<f32>, embedding_name: String ) -> Self

Create a new document with the given text and embedding.

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<'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 From<&str> for Document

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for Document

fn from(text: String) -> Self

Converts to this type from the input type.

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.