Interface: S3LoaderOptions

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

#Extends

• LoaderOptions

#Properties

#bucket

bucket: string

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

---

#client

client: S3LikeClient

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

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

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

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

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

Cap on number of objects to load. Default 100.

---

#prefix?

optional prefix?: string

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

Limit to keys under this prefix.

---

#signal?

optional signal?: AbortSignal

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

Optional abort signal forwarded to underlying HTTP calls when supported.

#Inherited from

LoaderOptions.signal

Explore nearby

• Peer
  BM25Options

  Auto-generated API reference for BM25Options.

• Peer
  ChunkOptions

  Auto-generated API reference for ChunkOptions.

• Peer
  ConfluenceLoaderOptions

  Auto-generated API reference for ConfluenceLoaderOptions.