Class: LlamaJsonSchemaGrammar<T, Defs>

Defined in: evaluator/LlamaJsonSchemaGrammar.ts:13

See

• Using a JSON Schema Grammar tutorial
• Reducing Hallucinations When Using JSON Schema Grammar tutorial

Extends

• LlamaGrammar

Type Parameters

Type Parameter	Default type
T extends GbnfJsonSchema<Defs>	-
Defs extends GbnfJsonDefList<Defs>	Record<any, any>

Constructors

Constructor

new LlamaJsonSchemaGrammar<T, Defs>(llama: Llama, schema: Readonly<T> & GbnfJsonSchema<Defs>): LlamaJsonSchemaGrammar<T, Defs>;

Defined in: evaluator/LlamaJsonSchemaGrammar.ts:23

Prefer to create a new instance of this class by using llama.createGrammarForJsonSchema(...).

Parameters

Parameter	Type
llama	Llama
schema	Readonly<T> & GbnfJsonSchema<Defs>

Returns

LlamaJsonSchemaGrammar<T, Defs>

Deprecated

Use llama.createGrammarForJsonSchema(...) instead.

Overrides

LlamaGrammar.constructor

Accessors

grammar

Get Signature

get grammar(): string;

Defined in: evaluator/LlamaGrammar.ts:64

Returns

string

Inherited from

LlamaGrammar.grammar

---

rootRuleName

Get Signature

get rootRuleName(): string;

Defined in: evaluator/LlamaGrammar.ts:68

Returns

string

Inherited from

LlamaGrammar.rootRuleName

---

stopGenerationTriggers

Get Signature

get stopGenerationTriggers(): readonly (
  | string
  | LlamaText
  | readonly (string | Token)[])[];

Defined in: evaluator/LlamaGrammar.ts:72

Returns

readonly ( | string | LlamaText | readonly (string | Token)[])[]

Inherited from

LlamaGrammar.stopGenerationTriggers

---

trimWhitespaceSuffix

Get Signature

get trimWhitespaceSuffix(): boolean;

Defined in: evaluator/LlamaGrammar.ts:76

Returns

boolean

Inherited from

LlamaGrammar.trimWhitespaceSuffix

---

schema

Get Signature

get schema(): Readonly<T>;

Defined in: evaluator/LlamaJsonSchemaGrammar.ts:35

Returns

Readonly<T>

Methods

getFor()

static getFor(llama: Llama, type: 
  | "json"
  | "json_arr"
  | "english"
  | "list"
  | "c"
  | "arithmetic"
  | "japanese"
  | "chess"): Promise<LlamaGrammar>;

Defined in: evaluator/LlamaGrammar.ts:88

Parameters

Parameter	Type
llama	Llama
type	| "json" | "json_arr" | "english" | "list" | "c" | "arithmetic" | "japanese" | "chess"

Returns

Promise<LlamaGrammar>

Inherited from

LlamaGrammar.getFor

---

parse()

parse(json: string): GbnfJsonSchemaToType<T>;

Defined in: evaluator/LlamaJsonSchemaGrammar.ts:39

Parameters

Parameter	Type
json	string

Returns

GbnfJsonSchemaToType<T>