ChatReturn
Auto-generated API reference for ChatReturn.
Interface: ChatReturn
Defined in: packages/core/src/types/chat.ts:81
#Extends
#Properties
#approve
approve: (
toolCallId) =>Promise<void>
Defined in: packages/core/src/types/chat.ts:89
#Parameters
toolCallId
string
#Returns
Promise<void>
#clear
clear: () =>
Promise<void>
Defined in: packages/core/src/types/chat.ts:88
#Returns
Promise<void>
#deny
deny: (
toolCallId,reason?) =>Promise<void>
Defined in: packages/core/src/types/chat.ts:90
#Parameters
toolCallId
string
reason?
string
#Returns
Promise<void>
#edit
edit: (
messageId,newContent,opts?) =>Promise<void>
Defined in: packages/core/src/types/chat.ts:85
#Parameters
messageId
string
newContent
string
opts?
#Returns
Promise<void>
#error
error:
Error|null
Defined in: packages/core/src/types/chat.ts:38
#Inherited from
#input
input:
string
Defined in: packages/core/src/types/chat.ts:37
#Inherited from
#messages
messages:
Message[]
Defined in: packages/core/src/types/chat.ts:35
#Inherited from
#regenerate
regenerate: (
messageId?) =>Promise<void>
Defined in: packages/core/src/types/chat.ts:86
#Parameters
messageId?
string
#Returns
Promise<void>
#retry
retry: () =>
Promise<void>
Defined in: packages/core/src/types/chat.ts:84
#Returns
Promise<void>
#send
send: (
text) =>Promise<void>
Defined in: packages/core/src/types/chat.ts:82
#Parameters
text
string
#Returns
Promise<void>
#setInput
setInput: (
value) =>void
Defined in: packages/core/src/types/chat.ts:87
#Parameters
value
string
#Returns
void
#status
status:
StreamStatus
Defined in: packages/core/src/types/chat.ts:36
#Inherited from
#stop
stop: () =>
void
Defined in: packages/core/src/types/chat.ts:83
#Returns
void
#usage
usage:
TokenUsage
Defined in: packages/core/src/types/chat.ts:44
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().