Interface: EntityExtractionOptions

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:451

Options for entity extraction from text.

Properties

entitySchema

entitySchema: JSONSchema

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:456

Schema defining the entities to extract

---

examples?

optional examples: object[]

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:465

Examples of expected extractions

input

input: string

output

output: unknown

---

extractAll?

optional extractAll: boolean

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:474

Whether to extract all occurrences or just first

---

instructions?

optional instructions: string

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:462

Additional context or instructions

---

modelId?

optional modelId: string

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:471

Model ID to use

---

providerId?

optional providerId: string

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:468

LLM provider to use

---

taskName

taskName: string

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:459

Name for the extraction task

---

text

text: string

Defined in: packages/agentos/src/api/structured/output/IStructuredOutputManager.ts:453

Text to extract entities from