Skip to main content

DocumentChunk

Struct DocumentChunk 

Source
pub struct DocumentChunk {
    pub base: DataPoint,
    pub text: String,
    pub chunk_size: usize,
    pub chunk_index: usize,
    pub cut_type: String,
    pub document_id: Uuid,
    pub is_part_of: Option<Uuid>,
    pub contains: Vec<Value>,
}
Expand description

A chunk of text extracted from a document during the cognify pipeline.

Extends DataPoint (via #[serde(flatten)]) following the same pattern used by Entity, EntityType, and EdgeType.

Python equivalent: cognee.infrastructure.engine.models.DataPoint subclass DocumentChunk with metadata = {"index_fields": ["text"]}.

Fields§

§base: DataPoint

Base data point fields (id, timestamps, metadata, type, etc.)

§text: String

The chunk text content.

§chunk_size: usize

Token count (word count by default).

§chunk_index: usize

Sequential index within the parent document, starting at 0.

§cut_type: String

How the chunk boundary was determined (e.g. “paragraph_end”, “sentence_end”).

§document_id: Uuid

ID of the parent document this chunk belongs to (convenience field).

§is_part_of: Option<Uuid>

Document ID for graph edge (mirrors Python’s is_part_of relationship).

§contains: Vec<Value>

Entity refs populated during graph extraction (mirrors Python’s contains list).

Implementations§

Source§

impl DocumentChunk

Source

pub fn new( id: Uuid, text: String, chunk_size: usize, chunk_index: usize, cut_type: String, document_id: Uuid, ) -> Self

Create a new DocumentChunk with a deterministic ID.

Sets:

  • base.data_type = "DocumentChunk"
  • base.metadata["index_fields"] = ["text"]
  • base.id = the provided deterministic UUID
  • is_part_of = Some(document_id)
  • contains = empty

Trait Implementations§

Source§

impl Clone for DocumentChunk

Source§

fn clone(&self) -> DocumentChunk

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentChunk

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DocumentChunk

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl HasDataPoint for DocumentChunk

Source§

fn data_point(&self) -> &DataPoint

Borrow the embedded DataPoint of this container.
Source§

fn data_point_mut(&mut self) -> &mut DataPoint

Mutably borrow the embedded DataPoint of this container.
Source§

fn for_each_child_mut(&mut self, _visit: &mut dyn FnMut(&mut dyn HasDataPoint))

Visit every owned child that itself implements HasDataPoint. Default: no children. Override on container types whose fields own (rather than reference by Uuid) another HasDataPoint.
Source§

impl Serialize for DocumentChunk

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.