Skip to main content

Interface: PlanRules

Defined in: packages/agentos/src/cognition/library/planEntries.ts:23

The caller's rules. Extensions are written in lower case with their dot, as .md.

Properties​

archiveExtensions?​

optional archiveExtensions: readonly string[]

Defined in: packages/agentos/src/cognition/library/planEntries.ts:31

The extensions of an archive the plan opens.

Default​

['.zip']

documentTypes​

documentTypes: Readonly<Record<string, string>>

Defined in: packages/agentos/src/cognition/library/planEntries.ts:25

A document's extension to its media type.

maxBytes()​

maxBytes: (kind) => number

Defined in: packages/agentos/src/cognition/library/planEntries.ts:38

The most bytes an entry of each kind may hold, and, for archive, the most a nested archive may hold for the plan to open it: 0, any positive number or Infinity. An entry whose size is no byte count (a finite number of 0 or more) is skipped with the reason size; a bound below 0, NaN or no number at all (null, a numeric text such as '5', true, an object) rejects the plan with a RangeError.

Parameters​

kind​

PlannedKind | "archive"

Returns​

number

maxEntries?​

optional maxEntries: number

Defined in: packages/agentos/src/cognition/library/planEntries.ts:50

The most entries planned, skipped ones included: those past it are skipped with the reason count. A count below 0, NaN or no number at all (null, a numeric text such as '5', true, an object) rejects the plan with a RangeError.

Default​

Infinity

openArchive()?​

optional openArchive: (path) => Promise<PlanEntryInput[]>

Defined in: packages/agentos/src/cognition/library/planEntries.ts:43

Lists a nested archive's entries, once its size is within maxBytes('archive'); without it, a nested archive is skipped. What it throws rejects the plan.

Parameters​

path​

string

Returns​

Promise<PlanEntryInput[]>

recordingExtensions​

recordingExtensions: readonly string[]

Defined in: packages/agentos/src/cognition/library/planEntries.ts:29

The extensions read as recordings.

transcriptExtensions​

transcriptExtensions: readonly string[]

Defined in: packages/agentos/src/cognition/library/planEntries.ts:27

The extensions read as transcripts.