@ralphschuler.ai function caller.index.<internal>.ChatCompletionStreamEvents

Interface: ChatCompletionStreamEvents

index.<internal>.ChatCompletionStreamEvents

Hierarchy

• AbstractChatCompletionRunnerEvents

  ↳ ChatCompletionStreamEvents

Table of contents

Properties

• abort
• chatCompletion
• chunk
• connect
• content
• end
• error
• finalChatCompletion
• finalContent
• finalFunctionCall
• finalFunctionCallResult
• finalMessage
• functionCall
• functionCallResult
• message
• totalUsage

Properties

abort

• abort: (error: APIUserAbortError) => void

Type declaration

▸ (error): void

Parameters

Name	Type
error	APIUserAbortError

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.abort

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:109

---

chatCompletion

• chatCompletion: (completion: ChatCompletion) => void

Type declaration

▸ (completion): void

Parameters

Name	Type
completion	ChatCompletion

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.chatCompletion

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:101

---

chunk

• chunk: (chunk: ChatCompletionChunk, snapshot: ChatCompletionSnapshot) => void

Type declaration

▸ (chunk, snapshot): void

Parameters

Name	Type
chunk	ChatCompletionChunk
snapshot	ChatCompletionSnapshot

Returns

void

Defined in

node_modules/openai/lib/ChatCompletionStream.d.ts:7

---

connect

• connect: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.connect

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:98

---

content

• content: (contentDelta: string, contentSnapshot: string) => void

Type declaration

▸ (contentDelta, contentSnapshot): void

Parameters

Name	Type
contentDelta	string
contentSnapshot	string

Returns

void

Defined in

node_modules/openai/lib/ChatCompletionStream.d.ts:6

---

end

• end: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.end

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:110

---

error

• error: (error: OpenAIError) => void

Type declaration

▸ (error): void

Parameters

Name	Type
error	OpenAIError

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.error

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:108

---

finalChatCompletion

• finalChatCompletion: (completion: ChatCompletion) => void

Type declaration

▸ (completion): void

Parameters

Name	Type
completion	ChatCompletion

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.finalChatCompletion

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:104

---

finalContent

• finalContent: (contentSnapshot: string) => void

Type declaration

▸ (contentSnapshot): void

Parameters

Name	Type
contentSnapshot	string

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.finalContent

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:102

---

finalFunctionCall

• finalFunctionCall: (functionCall: FunctionCall) => void

Type declaration

▸ (functionCall): void

Parameters

Name	Type
functionCall	FunctionCall

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.finalFunctionCall

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:105

---

finalFunctionCallResult

• finalFunctionCallResult: (content: string) => void

Type declaration

▸ (content): void

Parameters

Name	Type
content	string

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.finalFunctionCallResult

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:107

---

finalMessage

• finalMessage: (message: ChatCompletionMessageParam) => void

Type declaration

▸ (message): void

Parameters

Name	Type
message	ChatCompletionMessageParam

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.finalMessage

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:103

---

functionCall

• functionCall: (functionCall: FunctionCall) => void

Type declaration

▸ (functionCall): void

Parameters

Name	Type
functionCall	FunctionCall

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.functionCall

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:99

---

functionCallResult

• functionCallResult: (content: string) => void

Type declaration

▸ (content): void

Parameters

Name	Type
content	string

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.functionCallResult

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:106

---

message

• message: (message: ChatCompletionMessageParam) => void

Type declaration

▸ (message): void

Parameters

Name	Type
message	ChatCompletionMessageParam

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.message

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:100

---

totalUsage

• totalUsage: (usage: CompletionUsage) => void

Type declaration

▸ (usage): void

Parameters

Name	Type
usage	CompletionUsage

Returns

void

Inherited from

AbstractChatCompletionRunnerEvents.totalUsage

Defined in

node_modules/openai/lib/AbstractChatCompletionRunner.d.ts:111