Struct Chunk

pub struct Chunk { /* private fields */ }

Chunk

A chunk is a piece of text with associated metadata. This is type uses Arc<T> to hold references to the internal values. so it is cheap to Clone and Copy.

Implementations

impl Chunk

pub fn new(chunk: impl Into<Arc<str>>) -> Self

Chunk::new

This is the constructor to use when we have some text with no metadata that we wish to include with it.

Arguments

• content: Into<Arc<str>> - this is the text content of the chunk

Returns

• Chunk - a new Chunk with no metadata

pub fn new_with_metadata(content: impl Into<Arc<str>>, metadata: Value) -> Self

Chunk::new_with_metadata

This is the constructor to use when we have some text with metadata. Note the metadata does not influence any generated embeddings. It can just be kept with the text and embedding in whatever vector store you choose to use.

Arguments

• content: Into<Arc<str>> - pointer to the chunk str
• metadata: serde_json::Value - metadata associated with the chunk

Returns

• Chunk - a new Chunk

pub fn content(&self) -> &str

Chunk::content

Getter for the text content.

Returns

• &str - reference to the chunk str

pub fn metadata(&self) -> &Value

Chunk::metadata

Getter for the metadata

Returns

• &serde_json::Value - reference to metadata associated with the chunk

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Chunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Chunk

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

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 Chunk

impl StructuralPartialEq for Chunk