ChatReturn
Auto-generated API reference for ChatReturn.
Interface: ChatReturn
Defined in: core/dist/chat-Du42KmMf.d.ts:246
#Extends
#Properties
#approve
approve: (
toolCallId) =>Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:255
#Parameters
toolCallId
string
#Returns
Promise<void>
#clear
clear: () =>
Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:253
#Returns
Promise<void>
#deny
deny: (
toolCallId,reason?) =>Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:256
#Parameters
toolCallId
string
reason?
string
#Returns
Promise<void>
#edit
edit: (
messageId,newContent,opts?) =>Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:250
#Parameters
messageId
string
newContent
string
opts?
EditOptions
#Returns
Promise<void>
#error
error:
Error|null
Defined in: core/dist/chat-Du42KmMf.d.ts:205
#Inherited from
#input
input:
string
Defined in: core/dist/chat-Du42KmMf.d.ts:204
#Inherited from
#messages
messages:
MessageType[]
Defined in: core/dist/chat-Du42KmMf.d.ts:202
#Inherited from
#proposeToolCall
proposeToolCall: (
proposal) =>Promise<ToolCall>
Defined in: core/dist/chat-Du42KmMf.d.ts:254
#Parameters
proposal
Pick<ToolCall, "id" | "name" | "args">
#Returns
Promise<ToolCall>
#regenerate
regenerate: (
messageId?) =>Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:251
#Parameters
messageId?
string
#Returns
Promise<void>
#retry
retry: () =>
Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:249
#Returns
Promise<void>
#send
send: (
text) =>Promise<void>
Defined in: core/dist/chat-Du42KmMf.d.ts:247
#Parameters
text
string
#Returns
Promise<void>
#setInput
setInput: (
value) =>void
Defined in: core/dist/chat-Du42KmMf.d.ts:252
#Parameters
value
string
#Returns
void
#status
status:
StreamStatus
Defined in: core/dist/chat-Du42KmMf.d.ts:203
#Inherited from
#stop
stop: () =>
void
Defined in: core/dist/chat-Du42KmMf.d.ts:248
#Returns
void
#usage
usage:
TokenUsage
Defined in: core/dist/chat-Du42KmMf.d.ts:211
Token usage accumulated across every LLM call in this chat session.
Populated when the adapter surfaces usage (OpenAI, Anthropic, Gemini,
Ollama all do). Zeroed by clear().