Type Alias DefineModelOptions<CustomOptionsSchema>

Options for defining a new model via defineModel or model.

type DefineModelOptions<CustomOptionsSchema extends z.ZodTypeAny = z.ZodTypeAny> = {
    configSchema?: CustomOptionsSchema;
    label?: string;
    name: string;
    supports?: ModelInfo["supports"];
    use?: ModelMiddlewareArgument[];
    versions?: string[];
}

Type Parameters

CustomOptionsSchema extends z.ZodTypeAny = z.ZodTypeAny

Index

Properties

configSchema? label? name supports? use? versions?

Properties

`Optional`configSchema

configSchema?: CustomOptionsSchema

Custom options schema for this model.

`Optional`label

label?: string

Descriptive name for this model e.g. 'Google AI - Gemini Pro'.

name

name: string

`Optional`supports

supports?: ModelInfo["supports"]

Capabilities this model supports.

`Optional`use

use?: ModelMiddlewareArgument[]

Middleware to be used with this model.

`Optional`versions

versions?: string[]

Known version names for this model, e.g. gemini-1.0-pro-001.