schema

package

Go to main page

Versions in this module

v0

v0.19.2

May 1, 2026

v0.19.1

Apr 30, 2026

Changes in this version

type ImportContext

+ func (ctx *ImportContext) IsTypedDict(name string) bool

+ func (ctx *ImportContext) IsTypedDictFieldQualifier(name string) bool

+ func (ctx *ImportContext) ResolveQualifiedName(name string) (string, ImportEntry, bool)

type ModelField

+ KeyRequired *bool

v0.19.0

Apr 24, 2026

v0.18.0

Apr 15, 2026

Changes in this version

type Repetition

+ const OptionalRepeated

v0.17.2

Apr 1, 2026

Changes in this version

type SchemaTypeKind

+ func (k SchemaTypeKind) String() string

v0.17.1

Mar 27, 2026

v0.17.0

Mar 25, 2026

Changes in this version

+ func Generate(predictRef string, sourceDir string, mode Mode, parse Parser) ([]byte, error)

+ func GenerateCombined(sourceDir string, predictRef string, trainRef string, parse Parser) ([]byte, error)

+ func GenerateFromSource(source []byte, predictRef string, mode Mode, parse Parser, sourceDir string) ([]byte, error)

+ func GenerateOpenAPISchema(info *PredictorInfo) ([]byte, error)

+ func MergeSchemas(predict, train map[string]any) map[string]any

+ func TitleCase(s string) string

+ func TitleCaseSingle(s string) string

+ type DefaultKind int

+ const DefaultBool

+ const DefaultDict

+ const DefaultFloat

+ const DefaultInt

+ const DefaultList

+ const DefaultNone

+ const DefaultSet

+ const DefaultString

+ type DefaultValue struct

+ Bool bool

+ DictKeys []DefaultValue

+ DictVals []DefaultValue

+ Float float64

+ Int int64

+ Kind DefaultKind

+ List []DefaultValue

+ Str string

+ func (d DefaultValue) MarshalJSON() ([]byte, error)

+ func (d DefaultValue) ToJSON() any

+ type FieldType struct

+ Primitive PrimitiveType

+ Repetition Repetition

+ func ResolveFieldType(ann TypeAnnotation, ctx *ImportContext) (FieldType, error)

+ func (ft FieldType) JSONType() map[string]any

+ type ImportContext struct

+ Names *OrderedMap[string, ImportEntry]

+ func NewImportContext() *ImportContext

+ func (ctx *ImportContext) IsBaseModel(name string) bool

+ func (ctx *ImportContext) IsBasePredictor(name string) bool

+ func (ctx *ImportContext) IsCogType(name string) bool

+ func (ctx *ImportContext) IsTypingType(name string) bool

+ type ImportEntry struct

+ Module string

+ Original string

+ type InputField struct

+ Choices []DefaultValue

+ Default *DefaultValue

+ Deprecated *bool

+ Description *string

+ FieldType FieldType

+ GE *float64

+ LE *float64

+ MaxLength *uint64

+ MinLength *uint64

+ Name string

+ Order int

+ Regex *string

+ func (f *InputField) IsRequired() bool

+ type Mode int

+ const ModePredict

+ const ModeTrain

+ type ModelClassMap = *OrderedMap[string, []ModelField]

+ type ModelField struct

+ Default *DefaultValue

+ Name string

+ Type TypeAnnotation

+ type OrderedMap struct

+ func NewOrderedMap[K comparable, V any]() *OrderedMap[K, V]

+ func (m *OrderedMap[K, V]) Entries(fn func(key K, value V))

+ func (m *OrderedMap[K, V]) Get(key K) (V, bool)

+ func (m *OrderedMap[K, V]) Keys() []K

+ func (m *OrderedMap[K, V]) Len() int

+ func (m *OrderedMap[K, V]) Set(key K, value V)

+ type Parser func(source []byte, predictRef string, mode Mode, sourceDir string) (*PredictorInfo, error)

+ type PredictorInfo struct

+ Inputs *OrderedMap[string, InputField]

+ Mode Mode

+ Output SchemaType

+ type PrimitiveType int

+ const TypeAny

+ const TypeBool

+ const TypeFile

+ const TypeFloat

+ const TypeInteger

+ const TypePath

+ const TypeSecret

+ const TypeString

+ func PrimitiveFromName(name string) (PrimitiveType, bool)

+ func (p PrimitiveType) JSONType() map[string]any

+ func (p PrimitiveType) String() string

+ type Repetition int

+ const Optional

+ const Repeated

+ const Required

+ type SchemaError struct

+ Kind SchemaErrorKind

+ Message string

+ func NewError(kind SchemaErrorKind, msg string) *SchemaError

+ func WrapError(kind SchemaErrorKind, msg string, inner error) *SchemaError

+ func (e *SchemaError) Error() string

+ type SchemaErrorKind int

+ const ErrChoicesNotResolvable

+ const ErrConcatIteratorNotStr

+ const ErrDefaultFactoryNotSupported

+ const ErrDefaultNotResolvable

+ const ErrInvalidConstraint

+ const ErrInvalidPredictRef

+ const ErrMethodNotFound

+ const ErrMissingReturnType

+ const ErrMissingTypeAnnotation

+ const ErrOptionalOutput

+ const ErrOther

+ const ErrParse

+ const ErrPredictorNotFound

+ const ErrUnresolvableType

+ const ErrUnsupportedType

+ type SchemaField struct

+ Default *DefaultValue

+ Required bool

+ Type SchemaType

+ type SchemaType struct

+ Elem *SchemaType

+ Fields *OrderedMap[string, SchemaField]

+ Items *SchemaType

+ KeyType *SchemaType

+ Kind SchemaTypeKind

+ Nullable bool

+ Primitive PrimitiveType

+ ValueType *SchemaType

+ func ResolveSchemaType(ann TypeAnnotation, ctx *ImportContext, models ModelClassMap) (SchemaType, error)

+ func SchemaAnyType() SchemaType

+ func SchemaArrayOf(elem SchemaType) SchemaType

+ func SchemaConcatIteratorOf() SchemaType

+ func SchemaDictOf(value SchemaType) SchemaType

+ func SchemaIteratorOf(elem SchemaType) SchemaType

+ func SchemaObjectOf(fields *OrderedMap[string, SchemaField]) SchemaType

+ func SchemaPrim(p PrimitiveType) SchemaType

+ func (s SchemaType) JSONSchema() map[string]any

+ type SchemaTypeKind int

+ const SchemaAny

+ const SchemaArray

+ const SchemaConcatIterator

+ const SchemaDict

+ const SchemaIterator

+ const SchemaObject

+ const SchemaPrimitive

+ type TypeAnnotation struct

+ Args []TypeAnnotation

+ Kind TypeAnnotationKind

+ Name string

+ func UnwrapOptional(ann TypeAnnotation) (TypeAnnotation, bool)

+ type TypeAnnotationKind int

+ const TypeAnnotGeneric

+ const TypeAnnotSimple

+ const TypeAnnotUnion

v0.17.0-rc.4

Mar 24, 2026

v0.17.0-rc.3

Mar 23, 2026

v0.17.0-rc.2

Mar 12, 2026

v0.17.0-rc.1

Feb 28, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL