@agentskit/rag — Functions

#Function: bm25Score()

bm25Score(query, documents, options?): RetrievedDocument[]

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

Score a set of documents against a query using classic BM25. Returns new document objects with a finite .score field, sorted descending. Input documents are never mutated.

#Parameters

#query

string

#documents

RetrievedDocument[]

#options?

BM25Options = \{\}

#Returns

RetrievedDocument[]

---

#Function: chunkText()

chunkText(text, options): string[]

Defined in: packages/rag/src/chunker.ts:22

#Parameters

#text

string

#options

ChunkOptions

#Returns

string[]

---

#Function: createHybridRetriever()

createHybridRetriever(base, options?): Retriever

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

Combine a vector-backed base retriever with a BM25 keyword pass over the same candidate pool. Final score is a weighted sum of the two min-max-normalized scores using a finite relative weight pair that sums to 1 (both zero → 0.5/0.5).

#Parameters

#base

Retriever

#options?

HybridRetrieverOptions = \{\}

#Returns

Retriever

---

#Function: createRAG()

createRAG(config): RAG

Defined in: packages/rag/src/rag.ts:52

#Parameters

#config

RAGConfig

#Returns

RAG

---

#Function: createRerankedRetriever()

createRerankedRetriever(base, options?): Retriever

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

Wrap any base Retriever with a reranker. Typical flow:

1. Vector search returns ~20 candidates (candidatePool)
2. rerank re-scores them with a stronger signal (Cohere Rerank, BGE cross-encoder, or BM25 for keyword-aware hybrid search)
3. Top topK are returned

#Parameters

#base

Retriever

#options?

RerankedRetrieverOptions = \{\}

#Returns

Retriever

---

#Function: jinaReranker()

jinaReranker(options): RerankFn

Defined in: packages/rag/src/rerankers/jina.ts:34

Jina AI cross-encoder reranker. Drop-in RerankFn for createRerankedRetriever.

#Parameters

#options

JinaRerankerOptions

#Returns

RerankFn

---

#Function: loadConfluencePage()

loadConfluencePage(pageId, options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:200

#Parameters

#pageId

string

#options

ConfluenceLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadDropbox()

loadDropbox(options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/cloud.ts:98

#Parameters

#options

DropboxLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadGcs()

loadGcs(options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/cloud.ts:27

#Parameters

#options

GcsLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadGitHubFile()

loadGitHubFile(owner, repo, path, options?): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:50

#Parameters

#owner

string

#repo

string

#path

string

#options?

GitHubLoaderOptions = \{\}

#Returns

Promise<InputDocument[]>

---

#Function: loadGitHubTree()

loadGitHubTree(owner, repo, options?): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:80

#Parameters

#owner

string

#repo

string

#options?

GitHubTreeOptions = \{\}

#Returns

Promise<InputDocument[]>

---

#Function: loadGoogleDriveFile()

loadGoogleDriveFile(fileId, options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:226

#Parameters

#fileId

string

#options

DriveLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadNotionPage()

loadNotionPage(pageId, options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:142

#Parameters

#pageId

string

#options

NotionLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadOneDrive()

loadOneDrive(options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/cloud.ts:179

#Parameters

#options

OneDriveLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadPdf()

loadPdf(url, options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:249

PDF loader — parser is BYO so native deps stay out of the bundle. Fetch bytes at url, hand to parsePdf, wrap in InputDocument.

#Parameters

#url

string

#options

PdfLoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadS3()

loadS3(options): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/s3.ts:50

#Parameters

#options

S3LoaderOptions

#Returns

Promise<InputDocument[]>

---

#Function: loadUrl()

loadUrl(url, options?): Promise<InputDocument[]>

Defined in: packages/rag/src/loaders/documents.ts:31

#Parameters

#url

string

#options?

UrlLoaderOptions = \{\}

#Returns

Promise<InputDocument[]>

---

#Function: voyageReranker()

voyageReranker(options): RerankFn

Defined in: packages/rag/src/rerankers/voyage.ts:35

Voyage AI cross-encoder reranker. Drop-in RerankFn for createRerankedRetriever.

#Parameters

#options

VoyageRerankerOptions

#Returns

RerankFn

Explore nearby

• Peer
  @agentskit/rag — Classes

  API classes for @agentskit/rag.

• Peer
  @agentskit/rag — Interfaces

  API interfaces for @agentskit/rag.

• Peer
  @agentskit/rag — Type Aliases

  API type aliases for @agentskit/rag.