AxField Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxField.md interface AxField

AxField

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L1337

Properties

PropertyTypeDescription
description?string-
isCached?boolean-
isInternal?boolean-
isOptional?boolean-
namestring-
schema?StandardSchemaV1<unknown, unknown>Original Standard Schema (zod/valibot/arktype) stored so custom refinements and transforms run at parse time.
title?string-
type?object-
type.description?string-
type.fields?Record<string, AxFieldType>-
type.format?string-
type.isArray?boolean-
type.maximum?number-
type.maxLength?number-
type.minimum?number-
type.minLength?number-
type.name| "string" | "number" | "boolean" | "object" | "url" | "json" | "audio" | "image" | "file" | "date" | "dateRange" | "datetime" | "datetimeRange" | "class" | "code"-
type.options?string[]-
type.pattern?string-
type.patternDescription?string-
Docs