Documentation / @agentick/react / UseChatResult
Interface: UseChatResult<TMode>
Defined in: react/src/hooks/use-chat.ts:19
Type Parameters
TMode
TMode extends string = ChatMode
Properties
abort()
abort: (
reason?) =>void
Defined in: react/src/hooks/use-chat.ts:35
Parameters
reason?
string
Returns
void
addAttachment()
addAttachment: (
input) =>Attachment
Defined in: react/src/hooks/use-chat.ts:42
Parameters
input
Returns
attachments
attachments: readonly
Attachment[]
Defined in: react/src/hooks/use-chat.ts:29
chatMode
chatMode:
TMode
Defined in: react/src/hooks/use-chat.ts:21
clearAttachments()
clearAttachments: () =>
void
Defined in: react/src/hooks/use-chat.ts:44
Returns
void
clearMessages()
clearMessages: () =>
void
Defined in: react/src/hooks/use-chat.ts:41
Returns
void
clearQueued()
clearQueued: () =>
void
Defined in: react/src/hooks/use-chat.ts:38
Returns
void
error
error: {
message:string;name:string; } |null
Defined in: react/src/hooks/use-chat.ts:28
Error from the most recent execution failure (null on success or abort)
flush()
flush: () =>
void
Defined in: react/src/hooks/use-chat.ts:36
Returns
void
interrupt()
interrupt: (
text) =>Promise<ClientExecutionHandle>
Defined in: react/src/hooks/use-chat.ts:34
Parameters
text
string
Returns
Promise<ClientExecutionHandle>
isExecuting
isExecuting:
boolean
Defined in: react/src/hooks/use-chat.ts:25
lastSubmitted
lastSubmitted:
string|null
Defined in: react/src/hooks/use-chat.ts:23
messages
messages: readonly
ChatMessage[]
Defined in: react/src/hooks/use-chat.ts:20
mode
mode:
SteeringMode
Defined in: react/src/hooks/use-chat.ts:26
queue()
queue: (
text) =>void
Defined in: react/src/hooks/use-chat.ts:33
Parameters
text
string
Returns
void
queued
queued: readonly
Message[]
Defined in: react/src/hooks/use-chat.ts:24
removeAttachment()
removeAttachment: (
id) =>void
Defined in: react/src/hooks/use-chat.ts:43
Parameters
id
string
Returns
void
removeQueued()
removeQueued: (
index) =>void
Defined in: react/src/hooks/use-chat.ts:37
Parameters
index
number
Returns
void
respondToConfirmation()
respondToConfirmation: (
response) =>void
Defined in: react/src/hooks/use-chat.ts:40
Parameters
response
Returns
void
setMode()
setMode: (
mode) =>void
Defined in: react/src/hooks/use-chat.ts:39
Parameters
mode
Returns
void
steer()
steer: (
text) =>void
Defined in: react/src/hooks/use-chat.ts:32
Parameters
text
string
Returns
void
submit()
submit: (
text) =>void
Defined in: react/src/hooks/use-chat.ts:31
Parameters
text
string
Returns
void
toolConfirmation
toolConfirmation:
ToolConfirmationState|null
Defined in: react/src/hooks/use-chat.ts:22