chunk.RetrievedChunk

A chunk returned from a retrieval operation with associated metrics.

Usage

Source

chunk.RetrievedChunk(
    text,
    start_index,
    end_index,
    char_count,
    context=None,
    origin=None,
    attributes=None,
    metrics=list(),
    chunk_ids=list()
)

RetrievedChunk extends Chunk with retrieval metrics that indicate how well the chunk matched the query. Common metrics include similarity scores and BM25 scores.

Parameter Attributes

text: str

start_index: int

end_index: int

char_count: int

context: Optional[str] = None

origin: Optional[str] = None

attributes: Optional[dict[str, Any]] = None

metrics: list[Metric] = list()


chunk_ids: list[int] = list()


Attributes

metrics: list[Metric]

List of Metric objects containing retrieval scores.

chunk_ids: list[int]

Backend chunk identifiers represented by this retrieved chunk. For non-deoverlapped results this usually contains one id. For deoverlapped chunks it may include multiple source chunk ids.

Examples

from raghilda.chunk import RetrievedChunk, Metric

chunk = RetrievedChunk(
    text="This is relevant content.",
    start_index=0,
    end_index=25,
    char_count=25,
    metrics=[
        Metric(name="similarity", value=0.92),
        Metric(name="bm25_score", value=15.3),
    ],
)

for metric in chunk.metrics:
    print(f"{metric.name}: {metric.value}")

similarity: 0.92
bm25_score: 15.3