Struct rig::embeddings::DocumentEmbeddings

pub struct DocumentEmbeddings {
    pub id: String,
    pub document: Value,
    pub embeddings: Vec<Embedding>,
}

Struct that holds a document and its embeddings.

The struct is designed to model any kind of documents that can be serialized to JSON (including a simple string).

Moreover, it can hold multiple embeddings for the same document, thus allowing a large document to be retrieved from a query that matches multiple smaller and distinct text documents. For example, if the document is a textbook, a summary of each chapter could serve as the book’s embeddings.

Fields

id: String

document: Value

embeddings: Vec<Embedding>

Trait Implementations

impl Clone for DocumentEmbeddings

fn clone(&self) -> DocumentEmbeddings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for DocumentEmbeddings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocumentEmbeddings

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocumentEmbeddings

impl StructuralPartialEq for DocumentEmbeddings