Skip to content
AgentsKit

@agentskit/rag β€” Variables

API variables for @agentskit/rag.

#Variable: bm25Rerank

const bm25Rerank: RerankFn

Defined in: packages/rag/src/rerank.ts:235

RerankFn backed by bm25Score with default tuning parameters.

#Param

input

Query and candidate documents.

#Returns

New documents with finite BM25 scores in descending order.


#Variable: RagErrorCodes

const RagErrorCodes: object

Defined in: packages/rag/src/errors.ts:9

Stable error codes raised by RAG loaders and rerankers. Kept local to the package (rather than in core's ErrorCodes) because they describe RAG ingestion/rerank I/O, not a core contract surface.

#Type Declaration

#AK_RAG_LOAD_FAILED

readonly AK_RAG_LOAD_FAILED: "AK_RAG_LOAD_FAILED" = 'AK_RAG_LOAD_FAILED'

A loader's HTTP fetch returned a non-OK status.

#AK_RAG_PEER_MISSING

readonly AK_RAG_PEER_MISSING: "AK_RAG_PEER_MISSING" = 'AK_RAG_PEER_MISSING'

An optional loader peer SDK (e.g. @aws-sdk/client-s3) is not installed.

#AK_RAG_RERANK_FAILED

readonly AK_RAG_RERANK_FAILED: "AK_RAG_RERANK_FAILED" = 'AK_RAG_RERANK_FAILED'

A reranker provider call failed.

Explore nearby