Skip to main content

Interface: IngestOptions

Defined in: packages/agentos/src/memory/facade/types.ts:353

Options controlling a document-ingestion job launched via Memory.ingest().

Properties​

exclude?​

optional exclude: string[]

Defined in: packages/agentos/src/memory/facade/types.ts:370

Glob patterns for paths to exclude.

Example​

['node_modules/**', '**/*.test.*']

format?​

optional format: "markdown" | "auto" | "obsidian"

Defined in: packages/agentos/src/memory/facade/types.ts:379

Format hint for the ingested content.

  • 'auto' – detect from file extension / mime type.
  • 'obsidian' – parse Obsidian wiki-links and front-matter.
  • 'markdown' – treat as plain CommonMark.

Default​

'auto'

include?​

optional include: string[]

Defined in: packages/agentos/src/memory/facade/types.ts:364

Glob patterns for file types to include.

Example​

['**/*.md', '**/*.pdf']

onProgress()?​

optional onProgress: (processed, total, current) => void

Defined in: packages/agentos/src/memory/facade/types.ts:388

Callback invoked as each file is processed. Useful for building progress UI.

Parameters​

processed​

number

number of files completed so far

total​

number

total number of files discovered

current​

string

path of the file currently being processed

Returns​

void

recursive?​

optional recursive: boolean

Defined in: packages/agentos/src/memory/facade/types.ts:358

Whether to recursively scan sub-directories when source is a directory.

Default​

false