Skip to content

Type Alias: GbnfJsonBasicStringSchema

ts
type GbnfJsonBasicStringSchema: {
  type: "string";
  minLength: number;
  maxLength: number;
  description: string;
};

Type declaration

type

ts
readonly type: "string";

minLength?

ts
readonly optional minLength: number;

When using minLength and/or maxLength, ensure to inform the model as part of the prompt what your expectations are regarding the length of the string. Not doing this may lead to hallucinations.

maxLength?

ts
readonly optional maxLength: number;

When using minLength and/or maxLength, ensure to inform the model as part of the prompt what your expectations are regarding the length of the string. Not doing this may lead to hallucinations.

description?

ts
readonly optional description: string;

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.

Defined in

utils/gbnfJson/types.ts:46