Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/lib/jsonschema.ts>JSONSchema

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface JSONSchema
import { type JSONSchema } from "https://deno.land/x/openai@v4.56.0/lib/jsonschema.ts";

Properties

optional
$id: string | undefined
optional
$comment: string | undefined
optional
type: JSONSchemaTypeName | JSONSchemaTypeName[] | undefined
optional
enum: JSONSchemaType[] | undefined
optional
const: JSONSchemaType | undefined
optional
multipleOf: number | undefined
optional
maximum: number | undefined
optional
exclusiveMaximum: number | undefined
optional
minimum: number | undefined
optional
exclusiveMinimum: number | undefined
optional
maxLength: number | undefined
optional
minLength: number | undefined
optional
pattern: string | undefined
optional
items: JSONSchemaDefinition | JSONSchemaDefinition[] | undefined
optional
additionalItems: JSONSchemaDefinition | undefined
optional
maxItems: number | undefined
optional
minItems: number | undefined
optional
uniqueItems: boolean | undefined
optional
contains: JSONSchemaDefinition | undefined
optional
maxProperties: number | undefined
optional
minProperties: number | undefined
optional
required: string[] | undefined
optional
properties: { [key: string]: JSONSchemaDefinition; } | undefined
optional
patternProperties: { [key: string]: JSONSchemaDefinition; } | undefined
optional
additionalProperties: JSONSchemaDefinition | undefined
optional
propertyNames: JSONSchemaDefinition | undefined
optional
if: JSONSchemaDefinition | undefined
optional
then: JSONSchemaDefinition | undefined
optional
else: JSONSchemaDefinition | undefined
optional
allOf: JSONSchemaDefinition[] | undefined
optional
anyOf: JSONSchemaDefinition[] | undefined
optional
oneOf: JSONSchemaDefinition[] | undefined
optional
not: JSONSchemaDefinition | undefined
optional
format: string | undefined
optional
title: string | undefined
optional
description: string | undefined
optional
default: JSONSchemaType | undefined
optional
readOnly: boolean | undefined
optional
writeOnly: boolean | undefined
optional
examples: JSONSchemaType | undefined