Version: 0.0.4
agrag.retrieval.retrievers.chunk.ChunkRetriever
ChunkRetriever(*, graph_store:GraphStore, embedder:Embedder, vector_store:VectorStore | None = None, settings:RetrievalSettings | None = None, tracer:Tracer | None = None) -> None
Bases: Retriever
Dense chunk search via vector similarity.
Chunks are never tombstoned, so no merged_into resolution is
needed. Embeds the query, searches via the GraphStore-native or
VectorStore path, then hydrates each hit into a Chunk. The native
path searches the Chunk vector index ingestion provisions; the
VectorStore path searches chunk_collection.
Functions:
- retrieve – Run chunk search and return hydrated results.
Attributes:
- name –
Parameters:
- graph_store (
GraphStore) – Backs chunk search when vector_store is absent. - embedder (
Embedder) – Produces query vectors. - vector_store (
VectorStore | None) – Optional VectorStore for hybrid search. - settings (
RetrievalSettings | None) – Retrieval configuration; defaults from environment. - tracer (
Tracer | None) – Opens the retriever and its children's spans. None opens no recorded span.
name
name = 'chunk'
retrieve
retrieve(query:str, *, filters:SearchFilters | None = None, limit:int | None = None) -> list[SearchResult]
Run chunk search and return hydrated results.
Parameters:
- query (
str) – The natural-language query text. - filters (
SearchFilters | None) – Constraints applied to the search. - limit (
int | None) – Maximum results. None uses settings.chunk_top_k. Zero or negative returns no results without searching.
Returns:
list[SearchResult]– Ranked SearchResults with hydrated Chunk items. A child chunk resultlist[SearchResult]– carries its parent chunk inSearchResult.parent.