UseCompletionOptions

Defined in: types.ts:250

Completion hook options.

Extended by

• UseNextCompletionOptions

Properties

api?

optional api: string

Defined in: types.ts:258

API endpoint

---

body?

optional body: Record<string, unknown>

Defined in: types.ts:262

Request body extras

---

headers?

optional headers: Record<string, string>

Defined in: types.ts:260

Request headers

---

id?

optional id: string

Defined in: types.ts:256

Completion ID

---

initialCompletion?

optional initialCompletion: string

Defined in: types.ts:254

Initial completion

---

initialInput?

optional initialInput: string

Defined in: types.ts:252

Initial prompt

---

onError()?

optional onError: (error) => void

Defined in: types.ts:266

Called on error

Parameters

error

Error

Returns

void

---

onFinish()?

optional onFinish: (prompt, completion) => void

Defined in: types.ts:264

Called when completion finishes

Parameters

prompt

string

completion

string

Returns

void

---

onResponse()?

optional onResponse: (response) => void

Defined in: types.ts:268

Called for each response chunk

Parameters

response

Response

Returns

void

---

streamProtocol?

optional streamProtocol: "text" | "data"

Defined in: types.ts:270

Stream protocol