ChatReturn
Auto-generated API reference for ChatReturn.
Interface: ChatReturn
Defined in: core/dist/index.d.ts:224
#Extends
#Properties
#approve
approve: (
toolCallId) =>Promise<void>
Defined in: core/dist/index.d.ts:232
#Parameters
toolCallId
string
#Returns
Promise<void>
#clear
clear: () =>
Promise<void>
Defined in: core/dist/index.d.ts:231
#Returns
Promise<void>
#deny
deny: (
toolCallId,reason?) =>Promise<void>
Defined in: core/dist/index.d.ts:233
#Parameters
toolCallId
string
reason?
string
#Returns
Promise<void>
#edit
edit: (
messageId,newContent,opts?) =>Promise<void>
Defined in: core/dist/index.d.ts:228
#Parameters
messageId
string
newContent
string
opts?
EditOptions
#Returns
Promise<void>
#error
error:
Error|null
Defined in: core/dist/index.d.ts:184
#Inherited from
#input
input:
string
Defined in: core/dist/index.d.ts:183
#Inherited from
#messages
messages:
MessageType[]
Defined in: core/dist/index.d.ts:181
#Inherited from
#regenerate
regenerate: (
messageId?) =>Promise<void>
Defined in: core/dist/index.d.ts:229
#Parameters
messageId?
string
#Returns
Promise<void>
#retry
retry: () =>
Promise<void>
Defined in: core/dist/index.d.ts:227
#Returns
Promise<void>
#send
send: (
text) =>Promise<void>
Defined in: core/dist/index.d.ts:225
#Parameters
text
string
#Returns
Promise<void>
#setInput
setInput: (
value) =>void
Defined in: core/dist/index.d.ts:230
#Parameters
value
string
#Returns
void
#status
status:
StreamStatus
Defined in: core/dist/index.d.ts:182
#Inherited from
#stop
stop: () =>
void
Defined in: core/dist/index.d.ts:226
#Returns
void
#usage
usage:
TokenUsage
Defined in: core/dist/index.d.ts:190
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().