API

llama.rn

llama.rn

Table of contents

Classes

• LlamaContext
• SchemaGrammarConverter

Type Aliases

• BenchResult
• CompletionParams
• ContextParams
• TokenData

Functions

• convertJsonSchemaToGrammar
• initLlama
• releaseAllLlama
• setContextLimit

Type Aliases

BenchResult

Ƭ BenchResult: Object

Type declaration

Name	Type
modelDesc	string
modelNParams	number
modelSize	number
ppAvg	number
ppStd	number
tgAvg	number
tgStd	number

Defined in

index.ts:52

---

CompletionParams

Ƭ CompletionParams: Omit<NativeCompletionParams, "emit_partial_completion" | "prompt"> & { messages?: RNLlamaOAICompatibleMessage[] ; prompt?: string }

Defined in

index.ts:44

---

ContextParams

Ƭ ContextParams: NativeContextParams

Defined in

index.ts:42

---

TokenData

Ƭ TokenData: Object

Type declaration

Name	Type
completion_probabilities?	NativeCompletionTokenProb[]
token	string

Defined in

index.ts:32

Functions

convertJsonSchemaToGrammar

▸ convertJsonSchemaToGrammar(«destructured»): string | Promise<string>

Parameters

Name	Type
«destructured»	Object
› allowFetch?	boolean
› dotall?	boolean
› propOrder?	PropOrder
› schema	any

Returns

string | Promise<string>

Defined in

grammar.ts:824

---

initLlama

▸ initLlama(«destructured», onProgress?): Promise<LlamaContext>

Parameters

Name	Type
«destructured»	NativeContextParams
onProgress?	(progress: number) => void

Returns

Promise<LlamaContext>

Defined in

index.ts:196

---

releaseAllLlama

▸ releaseAllLlama(): Promise<void>

Returns

Promise<void>

Defined in

index.ts:233

---

setContextLimit

▸ setContextLimit(limit): Promise<void>

Parameters

Name	Type
limit	number

Returns

Promise<void>

Defined in

index.ts:188