@ralphschuler.ai function caller.index.<internal>.JSONSchema

Interface: JSONSchema

index.<internal>.JSONSchema

Table of contents

Properties

• $comment
• $id
• additionalItems
• additionalProperties
• allOf
• anyOf
• const
• contains
• default
• description
• else
• enum
• examples
• exclusiveMaximum
• exclusiveMinimum
• format
• if
• items
• maxItems
• maxLength
• maxProperties
• maximum
• minItems
• minLength
• minProperties
• minimum
• multipleOf
• not
• oneOf
• pattern
• patternProperties
• properties
• propertyNames
• readOnly
• required
• then
• title
• type
• uniqueItems
• writeOnly

Properties

$comment

• Optional $comment: string

Defined in

node_modules/openai/lib/jsonschema.d.ts:35

---

$id

• Optional $id: string

Defined in

node_modules/openai/lib/jsonschema.d.ts:34

---

additionalItems

• Optional additionalItems: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:60

---

additionalProperties

• Optional additionalProperties: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:77

---

allOf

• Optional allOf: JSONSchemaDefinition[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7

Defined in

node_modules/openai/lib/jsonschema.d.ts:88

---

anyOf

• Optional anyOf: JSONSchemaDefinition[]

Defined in

node_modules/openai/lib/jsonschema.d.ts:89

---

const

• Optional const: JSONSchemaType

Defined in

node_modules/openai/lib/jsonschema.d.ts:41

---

contains

• Optional contains: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:64

---

default

• Optional default: JSONSchemaType

Defined in

node_modules/openai/lib/jsonschema.d.ts:101

---

description

• Optional description: string

Defined in

node_modules/openai/lib/jsonschema.d.ts:100

---

else

• Optional else: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:84

---

enum

• Optional enum: JSONSchemaType[]

Defined in

node_modules/openai/lib/jsonschema.d.ts:40

---

examples

• Optional examples: JSONSchemaType

Defined in

node_modules/openai/lib/jsonschema.d.ts:104

---

exclusiveMaximum

• Optional exclusiveMaximum: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:47

---

exclusiveMinimum

• Optional exclusiveMinimum: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:49

---

format

• Optional format: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7

Defined in

node_modules/openai/lib/jsonschema.d.ts:95

---

if

• Optional if: JSONSchemaDefinition

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6

Defined in

node_modules/openai/lib/jsonschema.d.ts:82

---

items

• Optional items: JSONSchemaDefinition | JSONSchemaDefinition[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4

Defined in

node_modules/openai/lib/jsonschema.d.ts:59

---

maxItems

• Optional maxItems: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:61

---

maxLength

• Optional maxLength: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3

Defined in

node_modules/openai/lib/jsonschema.d.ts:53

---

maxProperties

• Optional maxProperties: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5

Defined in

node_modules/openai/lib/jsonschema.d.ts:68

---

maximum

• Optional maximum: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:46

---

minItems

• Optional minItems: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:62

---

minLength

• Optional minLength: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:54

---

minProperties

• Optional minProperties: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:69

---

minimum

• Optional minimum: number

Defined in

node_modules/openai/lib/jsonschema.d.ts:48

---

multipleOf

• Optional multipleOf: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2

Defined in

node_modules/openai/lib/jsonschema.d.ts:45

---

not

• Optional not: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:91

---

oneOf

• Optional oneOf: JSONSchemaDefinition[]

Defined in

node_modules/openai/lib/jsonschema.d.ts:90

---

pattern

• Optional pattern: string

Defined in

node_modules/openai/lib/jsonschema.d.ts:55

---

patternProperties

• Optional patternProperties: Object

Index signature

▪ [key: string]: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:74

---

properties

• Optional properties: Object

Index signature

▪ [key: string]: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:71

---

propertyNames

• Optional propertyNames: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:78

---

readOnly

• Optional readOnly: boolean

Defined in

node_modules/openai/lib/jsonschema.d.ts:102

---

required

• Optional required: string[]

Defined in

node_modules/openai/lib/jsonschema.d.ts:70

---

then

• Optional then: JSONSchemaDefinition

Defined in

node_modules/openai/lib/jsonschema.d.ts:83

---

title

• Optional title: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10

Defined in

node_modules/openai/lib/jsonschema.d.ts:99

---

type

• Optional type: JSONSchemaTypeName | JSONSchemaTypeName[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1

Defined in

node_modules/openai/lib/jsonschema.d.ts:39

---

uniqueItems

• Optional uniqueItems: boolean

Defined in

node_modules/openai/lib/jsonschema.d.ts:63

---

writeOnly

• Optional writeOnly: boolean

Defined in

node_modules/openai/lib/jsonschema.d.ts:103