@agentskit/rag — Interfaces

#Interface: BM25Options

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

#Properties

#b?

optional b?: number

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

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

---

#k1?

optional k1?: number

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

Term-frequency saturation (k1 ≥ 0). Default 1.5; invalid → default.

---

#Interface: ChunkOptions

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

#Properties

#chunkOverlap

chunkOverlap: number

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

---

#chunkSize

chunkSize: number

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

---

#split?

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

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

#Parameters

text

string

#Returns

string[]

---

#Interface: ConfluenceLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#authorization?

optional authorization?: string

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

---

#baseUrl

baseUrl: string

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

---

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#token?

optional token?: string

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

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

---

#Interface: DriveLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#accessToken

accessToken: string

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

---

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: DropboxLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#accessToken

accessToken: string

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

Dropbox OAuth2 access token.

---

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#filter?

optional filter?: (path) => boolean

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

#Parameters

path

string

#Returns

boolean

---

#maxFiles?

optional maxFiles?: number

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

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#path?

optional path?: string

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

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

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: GcsLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#accessToken

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

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

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

---

#bucket

bucket: string

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

---

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#filter?

optional filter?: (name) => boolean

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

#Parameters

name

string

#Returns

boolean

---

#maxFiles?

optional maxFiles?: number

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

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#prefix?

optional prefix?: string

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

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: GitHubLoaderOptions

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

#Extends

• LoaderOptions

#Extended by

• GitHubTreeOptions

#Properties

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#ref?

optional ref?: string

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

Branch / tag / sha. Default 'HEAD'.

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#token?

optional token?: string

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

---

#Interface: GitHubTreeOptions

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

#Extends

• GitHubLoaderOptions

#Properties

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

GitHubLoaderOptions.fetch

---

#filter?

optional filter?: (path) => boolean

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

Only include files matching this regex / test.

#Parameters

path

string

#Returns

boolean

---

#maxFiles?

optional maxFiles?: number

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

Max files to load. Default 100.

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

GitHubLoaderOptions.maxResponseBytes

---

#ref?

optional ref?: string

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

Branch / tag / sha. Default 'HEAD'.

#Inherited from

GitHubLoaderOptions.ref

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

GitHubLoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

GitHubLoaderOptions.timeoutMs

---

#token?

optional token?: string

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

#Inherited from

GitHubLoaderOptions.token

---

#Interface: HybridRetrieverOptions

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

#Properties

#bm25Weight?

optional bm25Weight?: number

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

Relative weight of the BM25 score. Default 0.4.

---

#candidatePool?

optional candidatePool?: number

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

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

---

#topK?

optional topK?: number

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

topK emitted after merging. Default 5.

---

#vectorWeight?

optional vectorWeight?: number

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

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

---

#Interface: InputDocument

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

#Properties

#content

content: string

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

---

#id?

optional id?: string

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

---

#metadata?

optional metadata?: Record<string, unknown>

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

---

#source?

optional source?: string

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

---

#Interface: JinaRerankerOptions

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

#Properties

#apiKey

apiKey: string

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

---

#fetch?

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

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

#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:14

---

#model?

optional model?: string

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

Default jina-reranker-v2-base-multilingual.

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to the underlying HTTP request.

---

#timeoutMs?

optional timeoutMs?: number

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

---

#Interface: LoaderOptions

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

#Extended by

• UrlLoaderOptions
• GitHubLoaderOptions
• NotionLoaderOptions
• ConfluenceLoaderOptions
• DriveLoaderOptions
• PdfLoaderOptions
• S3LoaderOptions
• GcsLoaderOptions
• DropboxLoaderOptions
• OneDriveLoaderOptions

#Properties

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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/loaders/shared.ts:17

Maximum response size in bytes. Default 10 MiB.

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

---

#Interface: NotionLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#token

token: string

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

---

#version?

optional version?: string

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

---

#Interface: OneDriveLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#accessToken

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

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

Microsoft Graph access token (mint via MSAL).

---

#driveId?

optional driveId?: string

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

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: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>

#Inherited from

LoaderOptions.fetch

---

#filter?

optional filter?: (name) => boolean

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

#Parameters

name

string

#Returns

boolean

---

#folderItemId?

optional folderItemId?: string

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

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

---

#maxFiles?

optional maxFiles?: number

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

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: PdfLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#fetch?

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

Defined in: packages/rag/src/loaders/shared.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>

#Inherited from

LoaderOptions.fetch

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

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:242

#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:13

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: RAG

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

#Extends

• Retriever

#Properties

#ingest

ingest: (documents) => Promise<void>

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

#Parameters

documents

InputDocument[]

#Returns

Promise<void>

---

#retrieve

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

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

#Parameters

request

RetrieverRequest

#Returns

Promise<RetrievedDocument[]>

#Overrides

Retriever.retrieve

---

#search

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

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

#Parameters

query

string

options?

threshold?

number

topK?

number

#Returns

Promise<RetrievedDocument[]>

---

#Interface: RAGConfig

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

#Properties

#chunkOverlap?

optional chunkOverlap?: number

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

---

#chunkSize?

optional chunkSize?: number

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

---

#embed

embed: EmbedFn

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

---

#split?

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

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

#Parameters

text

string

#Returns

string[]

---

#store

store: VectorMemory

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

---

#threshold?

optional threshold?: number

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

---

#topK?

optional topK?: number

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

---

#Interface: RerankedRetrieverOptions

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

#Properties

#candidatePool?

optional candidatePool?: number

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

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

---

#rerank?

optional rerank?: RerankFn

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

Reranker implementation. Default: the built-in bm25Rerank.

---

#topK?

optional topK?: number

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

Return top-K after reranking. Default 5.

---

#Interface: S3LikeClient

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

#Methods

#send()

send(command): Promise<unknown>

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

#Parameters

command

input

Record<string, unknown>

#Returns

Promise<unknown>

---

#Interface: S3LoaderOptions

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

#Extends

• LoaderOptions

#Properties

#bucket

bucket: string

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

---

#client

client: S3LikeClient

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

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:38

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: (input) => object

Parameters

input

Record<string, unknown>

Returns

object

input

input: Record<string, unknown>

#ListObjectsV2Command

ListObjectsV2Command: (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: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>

#Inherited from

LoaderOptions.fetch

---

#filter?

optional filter?: (key) => boolean

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

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:47

Cap on number of objects to load. Default 100.

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#prefix?

optional prefix?: string

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

Limit to keys under this prefix.

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: UrlLoaderOptions

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

#Extends

• LoaderOptions

#Properties

#allowedOrigins?

optional allowedOrigins?: readonly string[]

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

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: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>

#Inherited from

LoaderOptions.fetch

---

#headers?

optional headers?: Record<string, string>

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

---

#maxResponseBytes?

optional maxResponseBytes?: number

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

Maximum response size in bytes. Default 10 MiB.

#Inherited from

LoaderOptions.maxResponseBytes

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

---

#timeoutMs?

optional timeoutMs?: number

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

Finite deadline for each remote operation. Default 15 seconds.

#Inherited from

LoaderOptions.timeoutMs

---

#Interface: VoyageRerankerOptions

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

#Properties

#apiKey

apiKey: string

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

---

#fetch?

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

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

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:15

---

#model?

optional model?: string

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

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

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to the underlying HTTP request.

---

#timeoutMs?

optional timeoutMs?: number

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

Explore nearby

• Peer
  @agentskit/rag — Classes

  API classes for @agentskit/rag.

• Peer
  @agentskit/rag — Functions

  API functions for @agentskit/rag.

• Peer
  @agentskit/rag — Type Aliases

  API type aliases for @agentskit/rag.