PersistentAI API Documentation / @persistent-ai/fireflow-types / ToolSchemaProperty

Interface: ToolSchemaProperty

Defined in: packages/fireflow-types/src/tool/types.ts:16

JSON Schema property (subset of draft 2020-12 for LLM tool calling).

Every field that schemaExtraction can produce must be declared here. Fields NOT present here are silently dropped during serialization round-trips. Note: enumTitles is intentionally absent — it is a FireFlow UI extension, not valid JSON Schema.

Properties

default?

optional default: any

Defined in: packages/fireflow-types/src/tool/types.ts:20

---

description?

optional description: string

Defined in: packages/fireflow-types/src/tool/types.ts:19

---

enum?

optional enum: string[]

Defined in: packages/fireflow-types/src/tool/types.ts:21

---

items?

optional items: ToolSchemaProperty

Defined in: packages/fireflow-types/src/tool/types.ts:22

---

maximum?

optional maximum: number

Defined in: packages/fireflow-types/src/tool/types.ts:31

---

maxItems?

optional maxItems: number

Defined in: packages/fireflow-types/src/tool/types.ts:24

---

maxLength?

optional maxLength: number

Defined in: packages/fireflow-types/src/tool/types.ts:28

---

minimum?

optional minimum: number

Defined in: packages/fireflow-types/src/tool/types.ts:30

---

minItems?

optional minItems: number

Defined in: packages/fireflow-types/src/tool/types.ts:23

---

minLength?

optional minLength: number

Defined in: packages/fireflow-types/src/tool/types.ts:27

---

multipleOf?

optional multipleOf: number

Defined in: packages/fireflow-types/src/tool/types.ts:32

---

pattern?

optional pattern: string

Defined in: packages/fireflow-types/src/tool/types.ts:29

---

properties?

optional properties: Record<string, ToolSchemaProperty>

Defined in: packages/fireflow-types/src/tool/types.ts:25

---

required?

optional required: string[]

Defined in: packages/fireflow-types/src/tool/types.ts:26

---

title?

optional title: string

Defined in: packages/fireflow-types/src/tool/types.ts:18

---

type?

optional type: string

Defined in: packages/fireflow-types/src/tool/types.ts:17