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

Interface: SchemaProperty

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:37

Properties

default?

optional default: any

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:41

---

description?

optional description: string

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:40

---

enum?

optional enum: string[]

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:56

---

enumTitles?

optional enumTitles: string[]

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:57

---

items?

optional items: SchemaProperty

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:43

---

maximum?

optional maximum: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:50

---

maxItems?

optional maxItems: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:54

---

maxLength?

optional maxLength: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:46

---

minimum?

optional minimum: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:49

---

minItems?

optional minItems: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:53

---

minLength?

optional minLength: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:45

---

multipleOf?

optional multipleOf: number

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:51

---

pattern?

optional pattern: string

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:47

---

properties?

optional properties: Record<string, SchemaProperty>

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:42

---

required?

optional required: string[]

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:59

---

title?

optional title: string

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:39

---

type?

optional type: string

Defined in: packages/fireflow-types/src/tool/schema-extraction.ts:38