Skip to main content

Interface: ChatFunctionProperty

Schema fragment representing a property definition within ChatFunctionParameters.

Properties​

description?​

optional description: string;

Human-readable description exposed to the model.

enum?​

optional enum: (string | number | boolean)[];

Enumerated accepted values, if applicable.

items?​

optional items: ChatFunctionProperty;

Nested schema for array item validation.

maximum?​

optional maximum: number;

Maximum numeric value when type is numeric.

minimum?​

optional minimum: number;

Minimum numeric value when type is numeric.

type​

type: 
  | "string"
  | "number"
  | "boolean"
  | "array"
  | "integer";

Primitive JSON schema type.