Skip to content
AgentsKit

@agentskit/rag β€” Interfaces

API interfaces for @agentskit/rag.

#Interface: BM25Options

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

Tuning parameters for BM25 lexical relevance scoring.

#Properties

#b?

optional b?: number

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

Length-normalization weight in [0, 1]. Default 0.75; invalid β†’ default.


#k1?

optional k1?: number

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

Term-frequency saturation (k1 β‰₯ 0). Default 1.5; invalid β†’ default.


#Interface: ChunkOptions

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

Options for splitting text into chunks.

#Properties

#chunkOverlap

chunkOverlap: number

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


#chunkSize

chunkSize: number

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


#split?

optional split?: (text) => string[]

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

#Parameters

text

string

#Returns

string[]


#Interface: ConfluenceLoaderOptions

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

Options for loading a Confluence page.

#Extends

#Properties

#authorization?

optional authorization?: string

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


#baseUrl

baseUrl: string

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


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#token?

optional token?: string

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

Basic auth token &lt;email:api-token> in base64, OR pass authorization header directly.


#Interface: DriveLoaderOptions

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

Options for loading a Google Drive file.

#Extends

#Properties

#accessToken

accessToken: string

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


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: DropboxLoaderOptions

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

Options for loading files from Dropbox.

#Extends

#Properties

#accessToken

accessToken: string

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

Dropbox OAuth2 access token.


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#filter?

optional filter?: (path) => boolean

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

#Parameters

path

string

#Returns

boolean


#maxFiles?

optional maxFiles?: number

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


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#path?

optional path?: string

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

Folder path, e.g. /team-docs. Empty string = root.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: GcsLoaderOptions

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

Options for loading objects from a Google Cloud Storage bucket.

#Extends

#Properties

#accessToken

accessToken: string | (() => string | Promise<string>)

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

OAuth2 access token. Mint via google-auth-library or workload identity.


#bucket

bucket: string

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


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#filter?

optional filter?: (name) => boolean

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

#Parameters

name

string

#Returns

boolean


#maxFiles?

optional maxFiles?: number

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


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#prefix?

optional prefix?: string

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


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: GitHubLoaderOptions

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

Options for loading a file from a GitHub repository.

#Extends

#Extended by

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#ref?

optional ref?: string

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

Branch / tag / sha. Default 'HEAD'.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#token?

optional token?: string

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


#Interface: GitHubTreeOptions

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

Options for loading eligible files from a GitHub repository tree.

#Extends

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

GitHubLoaderOptions.fetch


#filter?

optional filter?: (path) => boolean

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

Only include files matching this regex / test.

#Parameters

path

string

#Returns

boolean


#maxFiles?

optional maxFiles?: number

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

Max files to load. Default 100.


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

GitHubLoaderOptions.maxResponseBytes


#ref?

optional ref?: string

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

Branch / tag / sha. Default 'HEAD'.

#Inherited from

GitHubLoaderOptions.ref


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

GitHubLoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

GitHubLoaderOptions.timeoutMs


#token?

optional token?: string

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

#Inherited from

GitHubLoaderOptions.token


#Interface: HybridRetrieverOptions

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

Options for combining vector search with BM25 lexical ranking.

#Properties

#bm25Weight?

optional bm25Weight?: number

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

Relative weight of the BM25 score. Default 0.4.


#candidatePool?

optional candidatePool?: number

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

Candidate pool to pull from the base retriever. Default 20.


#topK?

optional topK?: number

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

topK emitted after merging. Default 5.


#vectorWeight?

optional vectorWeight?: number

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

Relative weight of the vector score in the final ranking. Default 0.6.


#Interface: InputDocument

Defined in: packages/rag/src/types.ts:10

A source document supplied to or returned from a RAG pipeline.

#Properties

#content

content: string

Defined in: packages/rag/src/types.ts:12


#id?

optional id?: string

Defined in: packages/rag/src/types.ts:11


#metadata?

optional metadata?: Record<string, unknown>

Defined in: packages/rag/src/types.ts:14


#source?

optional source?: string

Defined in: packages/rag/src/types.ts:13


#Interface: JinaRerankerOptions

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

Credentials and request settings for the Jina reranker.

#Properties

#apiKey

apiKey: string

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


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

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

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>


#maxResponseBytes?

optional maxResponseBytes?: number

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


#model?

optional model?: string

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

Default jina-reranker-v2-base-multilingual.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to the underlying HTTP request.


#timeoutMs?

optional timeoutMs?: number

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


#Interface: LoaderOptions

Defined in: packages/rag/src/loaders/shared.ts:24

Shared options for remote document loaders.

#Extended by

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.


#Interface: NotionLoaderOptions

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

Options for loading a Notion page and its child blocks.

#Extends

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#token

token: string

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


#version?

optional version?: string

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


#Interface: OneDriveLoaderOptions

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

Options for loading files from a OneDrive folder tree.

#Extends

#Properties

#accessToken

accessToken: string | (() => string | Promise<string>)

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

Microsoft Graph access token (mint via MSAL).


#driveId?

optional driveId?: string

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

Drive id. Defaults to me/drive (the signed-in user's OneDrive).


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#filter?

optional filter?: (name) => boolean

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

#Parameters

name

string

#Returns

boolean


#folderItemId?

optional folderItemId?: string

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

Item id (folder) to walk. Defaults to root.


#maxFiles?

optional maxFiles?: number

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


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: PartitionedRAGConfig

Defined in: packages/rag/src/partitioned.ts:17

Construction-bound partition and mandatory reporting of bounded retrieval.

#Extends

#Properties

#chunkOverlap?

optional chunkOverlap?: number

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

#Inherited from

RAGConfig.chunkOverlap


#chunkSize?

optional chunkSize?: number

Defined in: packages/rag/src/types.ts:21

#Inherited from

RAGConfig.chunkSize


#embed

embed: EmbedFn

Defined in: packages/rag/src/types.ts:19

#Inherited from

RAGConfig.embed


#onDiagnostics

onDiagnostics: (diagnostics) => void

Defined in: packages/rag/src/partitioned.ts:21

#Parameters

diagnostics

PartitionSearchDiagnostics

#Returns

void


#overfetchFactor?

optional overfetchFactor?: number

Defined in: packages/rag/src/partitioned.ts:20

Integer from 1 to 16, default 4. Applies even if the store ignores filters.


#partition

partition: string

Defined in: packages/rag/src/partitioned.ts:18


#split?

optional split?: (text) => string[]

Defined in: packages/rag/src/types.ts:23

#Parameters

text

string

#Returns

string[]

#Inherited from

RAGConfig.split


#store

store: VectorMemory

Defined in: packages/rag/src/types.ts:20

#Inherited from

RAGConfig.store


#threshold?

optional threshold?: number

Defined in: packages/rag/src/types.ts:25

#Inherited from

RAGConfig.threshold


#topK?

optional topK?: number

Defined in: packages/rag/src/types.ts:24

#Inherited from

RAGConfig.topK


#Interface: PartitionSearchDiagnostics

Defined in: packages/rag/src/partitioned.ts:6

Search evidence; bounded candidate retrieval can reduce recall even with store filters.

#Properties

#candidateLimit

candidateLimit: number

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


#examined

examined: number

Defined in: packages/rag/src/partitioned.ts:10


#partition

partition: string

Defined in: packages/rag/src/partitioned.ts:7


#recall

recall: "potentially-reduced"

Defined in: packages/rag/src/partitioned.ts:13


#rejected

rejected: number

Defined in: packages/rag/src/partitioned.ts:11


#requestedTopK

requestedTopK: number

Defined in: packages/rag/src/partitioned.ts:8


#returned

returned: number

Defined in: packages/rag/src/partitioned.ts:12


#Interface: PdfLoaderOptions

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

Options for fetching and extracting text from a PDF.

#Extends

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#parsePdf

parsePdf: (bytes) => Promise<{ pages?: number; text: string; }> | { pages?: number; text: string; }

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

#Parameters

bytes

Uint8Array

#Returns

Promise<{ pages?: number; text: string; }> | { pages?: number; text: string; }


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: RAG

Defined in: packages/rag/src/types.ts:29

A retriever that can ingest documents into its configured vector store.

#Extends

  • Retriever

#Properties

#ingest

ingest: (documents) => Promise<void>

Defined in: packages/rag/src/types.ts:30

#Parameters

documents

InputDocument[]

#Returns

Promise<void>


#retrieve

retrieve: (request) => Promise<RetrievedDocument[]>

Defined in: packages/rag/src/types.ts:31

#Parameters

request

RetrieverRequest

#Returns

Promise<RetrievedDocument[]>

#Overrides

Retriever.retrieve


search: (query, options?) => Promise<RetrievedDocument[]>

Defined in: packages/rag/src/types.ts:32

#Parameters

query

string

options?
threshold?

number

topK?

number

#Returns

Promise<RetrievedDocument[]>


#Interface: RAGConfig

Defined in: packages/rag/src/types.ts:18

Configuration for a store-backed retrieval-augmented generation pipeline.

#Extended by

#Properties

#chunkOverlap?

optional chunkOverlap?: number

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


#chunkSize?

optional chunkSize?: number

Defined in: packages/rag/src/types.ts:21


#embed

embed: EmbedFn

Defined in: packages/rag/src/types.ts:19


#split?

optional split?: (text) => string[]

Defined in: packages/rag/src/types.ts:23

#Parameters

text

string

#Returns

string[]


#store

store: VectorMemory

Defined in: packages/rag/src/types.ts:20


#threshold?

optional threshold?: number

Defined in: packages/rag/src/types.ts:25


#topK?

optional topK?: number

Defined in: packages/rag/src/types.ts:24


#Interface: RerankedRetrieverOptions

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

Options for wrapping a retriever with a reranking function.

#Properties

#candidatePool?

optional candidatePool?: number

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

Pull N candidates from the base retriever before reranking. Default 20.


#rerank?

optional rerank?: RerankFn

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

Reranker implementation. Default: the built-in bm25Rerank.


#topK?

optional topK?: number

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

Return top-K after reranking. Default 5.


#Interface: S3LikeClient

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

Minimal S3 client surface accepted by the S3 loader.

#Methods

#send()

send(command, options?): Promise<unknown>

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

SDK-compatible send method; abortSignal is passed to SDK requests.

#Parameters

command
input

Record<string, unknown>

options?
abortSignal?

AbortSignal

#Returns

Promise<unknown>


#Interface: S3LoaderOptions

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

Options for listing and loading objects from an S3-compatible bucket.

#Extends

#Properties

#bucket

bucket: string

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


#client

client: S3LikeClient

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

AWS SDK v3 S3Client-shaped client. Bring your own to keep the bundle lean. Works with R2 / MinIO / etc. by configuring the client's endpoint.


#commands?

optional commands?: object

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

AWS SDK v3 commands. Pass them in to skip the dynamic import: \{ ListObjectsV2Command, GetObjectCommand \} from @aws-sdk/client-s3. Optional in Node, where the loader resolves them lazily. Required in browser, Expo/Metro, and React Native universal bundles.

#GetObjectCommand

GetObjectCommand: new (input) => object

Parameters
input

Record<string, unknown>

Returns

object

input

input: Record<string, unknown>

#ListObjectsV2Command

ListObjectsV2Command: new (input) => object

Parameters
input

Record<string, unknown>

Returns

object

input

input: Record<string, unknown>


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#filter?

optional filter?: (key) => boolean

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

Include only keys matching this predicate after listing.

#Parameters

key

string

#Returns

boolean


#maxFiles?

optional maxFiles?: number

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

Cap on number of objects to load. Default 100.


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#prefix?

optional prefix?: string

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

Limit to keys under this prefix.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: UrlLoaderOptions

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

Options for fetching and converting a URL into a document.

#Extends

#Properties

#allowedOrigins?

optional allowedOrigins?: readonly string[]

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

Explicit egress allowlist for arbitrary URLs. Required for loadUrl.


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/rag/src/loaders/shared.ts:25

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

LoaderOptions.fetch


#headers?

optional headers?: Record<string, string>

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


#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to HTTP and SDK calls when supported.

#Inherited from

LoaderOptions.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/rag/src/loaders/shared.ts:29

Deadline for each remote request/body read. Default 15 seconds; valid range 1–2,147,483,647ms.

#Inherited from

LoaderOptions.timeoutMs


#Interface: VoyageRerankerOptions

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

Credentials and request settings for the Voyage reranker.

#Properties

#apiKey

apiKey: string

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


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

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

Override fetch (mainly for tests).

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>


#maxResponseBytes?

optional maxResponseBytes?: number

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


#model?

optional model?: string

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

Default rerank-2. Pass rerank-2-lite for cheaper / faster runs.


#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to the underlying HTTP request.


#timeoutMs?

optional timeoutMs?: number

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

Explore nearby

On this page

Interface: BM25OptionsPropertiesb?k1?Interface: ChunkOptionsPropertieschunkOverlapchunkSizesplit?ParameterstextReturnsInterface: ConfluenceLoaderOptionsExtendsPropertiesauthorization?baseUrlfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited frommaxResponseBytes?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromtoken?Interface: DriveLoaderOptionsExtendsPropertiesaccessTokenfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited frommaxResponseBytes?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromInterface: DropboxLoaderOptionsExtendsPropertiesaccessTokenfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromfilter?ParameterspathReturnsmaxFiles?maxResponseBytes?Inherited frompath?signal?Inherited fromtimeoutMs?Inherited fromInterface: GcsLoaderOptionsExtendsPropertiesaccessTokenbucketfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromfilter?ParametersnameReturnsmaxFiles?maxResponseBytes?Inherited fromprefix?signal?Inherited fromtimeoutMs?Inherited fromInterface: GitHubLoaderOptionsExtendsExtended byPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited frommaxResponseBytes?Inherited fromref?signal?Inherited fromtimeoutMs?Inherited fromtoken?Interface: GitHubTreeOptionsExtendsPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromfilter?ParameterspathReturnsmaxFiles?maxResponseBytes?Inherited fromref?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromtoken?Inherited fromInterface: HybridRetrieverOptionsPropertiesbm25Weight?candidatePool?topK?vectorWeight?Interface: InputDocumentPropertiescontentid?metadata?source?Interface: JinaRerankerOptionsPropertiesapiKeyfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsmaxResponseBytes?model?signal?timeoutMs?Interface: LoaderOptionsExtended byPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsmaxResponseBytes?signal?timeoutMs?Interface: NotionLoaderOptionsExtendsPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited frommaxResponseBytes?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromtokenversion?Interface: OneDriveLoaderOptionsExtendsPropertiesaccessTokendriveId?fetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromfilter?ParametersnameReturnsfolderItemId?maxFiles?maxResponseBytes?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromInterface: PartitionedRAGConfigExtendsPropertieschunkOverlap?Inherited fromchunkSize?Inherited fromembedInherited fromonDiagnosticsParametersdiagnosticsReturnsoverfetchFactor?partitionsplit?ParameterstextReturnsInherited fromstoreInherited fromthreshold?Inherited fromtopK?Inherited fromInterface: PartitionSearchDiagnosticsPropertiescandidateLimitexaminedpartitionrecallrejectedrequestedTopKreturnedInterface: PdfLoaderOptionsExtendsPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited frommaxResponseBytes?Inherited fromparsePdfParametersbytesReturnssignal?Inherited fromtimeoutMs?Inherited fromInterface: RAGExtendsPropertiesingestParametersdocumentsReturnsretrieveParametersrequestReturnsOverridessearchParametersqueryoptions?threshold?topK?ReturnsInterface: RAGConfigExtended byPropertieschunkOverlap?chunkSize?embedsplit?ParameterstextReturnsstorethreshold?topK?Interface: RerankedRetrieverOptionsPropertiescandidatePool?rerank?topK?Interface: S3LikeClientMethodssend()Parameterscommandinputoptions?abortSignal?ReturnsInterface: S3LoaderOptionsExtendsPropertiesbucketclientcommands?GetObjectCommandParametersinputReturnsinputListObjectsV2CommandParametersinputReturnsinputfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromfilter?ParameterskeyReturnsmaxFiles?maxResponseBytes?Inherited fromprefix?signal?Inherited fromtimeoutMs?Inherited fromInterface: UrlLoaderOptionsExtendsPropertiesallowedOrigins?fetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?maxResponseBytes?Inherited fromsignal?Inherited fromtimeoutMs?Inherited fromInterface: VoyageRerankerOptionsPropertiesapiKeyfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsmaxResponseBytes?model?signal?timeoutMs?