Skip to content

Type Alias: GbnfJsonOneOfSchema<Defs>

ts
type GbnfJsonOneOfSchema<Defs> = {
  oneOf: readonly GbnfJsonSchema<NoInfer<Defs>>[];
  description?: string;
  $defs?: Defs;
};

Defined in: utils/gbnfJson/types.ts:47

Type Parameters

Type ParameterDefault type
Defs extends GbnfJsonDefList<NoInfer<Defs>>{ }

Properties

oneOf

ts
readonly oneOf: readonly GbnfJsonSchema<NoInfer<Defs>>[];

Defined in: utils/gbnfJson/types.ts:48


description?

ts
readonly optional description: string;

Defined in: utils/gbnfJson/types.ts:55

A description of what you expect the model to set this value to.

Only passed to the model when using function calling, and has no effect when using JSON Schema grammar directly.


$defs?

ts
readonly optional $defs: Defs;

Defined in: utils/gbnfJson/types.ts:57