Skip to main content

ChatActions

Agent Runtimes

Agent Runtimes / store/chatStore / ChatActions

Interface: ChatActions

Defined in: src/stores/chatStore.ts:140

Chat store actions

Properties​

addMessage​

addMessage: (message) => void

Defined in: src/stores/chatStore.ts:153

Parameters​

message​

ChatMessage

Returns​

void

addMiddleware​

addMiddleware: (middleware) => void

Defined in: src/stores/chatStore.ts:204

Parameters​

middleware​

ChatMiddleware

Returns​

void

appendToStream​

appendToStream: (messageId, content) => void

Defined in: src/stores/chatStore.ts:161

Parameters​

messageId​

string

content​

string

Returns​

void

clearMessages​

clearMessages: () => void

Defined in: src/stores/chatStore.ts:157

Returns​

void

createThread​

createThread: (title?) => string

Defined in: src/stores/chatStore.ts:170

Parameters​

title?​

string

Returns​

string

deleteMessage​

deleteMessage: (messageId) => void

Defined in: src/stores/chatStore.ts:155

Parameters​

messageId​

string

Returns​

void

deleteThread​

deleteThread: (threadId) => void

Defined in: src/stores/chatStore.ts:171

Parameters​

threadId​

string

Returns​

void

disableExtension​

disableExtension: (name) => void

Defined in: src/stores/chatStore.ts:200

Parameters​

name​

string

Returns​

void

enableExtension​

enableExtension: (name) => void

Defined in: src/stores/chatStore.ts:199

Parameters​

name​

string

Returns​

void

getExtensions​

getExtensions: <T>(type?) => T[]

Defined in: src/stores/chatStore.ts:201

Type Parameters​

T​

T extends ChatExtension

Parameters​

type?​

T["type"]

Returns​

T[]

getMiddlewares​

getMiddlewares: () => ChatMiddleware[]

Defined in: src/stores/chatStore.ts:206

Returns​

ChatMiddleware[]

getPendingToolCalls​

getPendingToolCalls: () => ToolCallState[]

Defined in: src/stores/chatStore.ts:191

Returns​

ToolCallState[]

getTool​

getTool: (name) => ToolRegistryEntry | undefined

Defined in: src/stores/chatStore.ts:176

Parameters​

name​

string

Returns​

ToolRegistryEntry | undefined

getTools​

getTools: () => ToolDefinition[]

Defined in: src/stores/chatStore.ts:177

Returns​

ToolDefinition[]

registerExtension​

registerExtension: (extension, options?) => void

Defined in: src/stores/chatStore.ts:194

Parameters​

extension​

ChatExtension

options?​
enabled?​

boolean

Returns​

void

registerTool​

registerTool: (definition) => void

Defined in: src/stores/chatStore.ts:174

Parameters​

definition​

ToolDefinition

Returns​

void

removeMiddleware​

removeMiddleware: (name) => void

Defined in: src/stores/chatStore.ts:205

Parameters​

name​

string

Returns​

void

reset​

reset: () => void

Defined in: src/stores/chatStore.ts:214

Returns​

void

setConfig​

setConfig: (config) => void

Defined in: src/stores/chatStore.ts:142

Parameters​

config​

Partial<ChatConfig>

Returns​

void

setCurrentThread​

setCurrentThread: (threadId) => void

Defined in: src/stores/chatStore.ts:169

Parameters​

threadId​

string | null

Returns​

void

setError​

setError: (error) => void

Defined in: src/stores/chatStore.ts:166

Parameters​

error​

Error | null

Returns​

void

setExtensionRegistry​

setExtensionRegistry: (registry) => void

Defined in: src/stores/chatStore.ts:150

Parameters​

registry​

ExtensionRegistry | null

Returns​

void

setInferenceProvider​

setInferenceProvider: (provider) => void

Defined in: src/stores/chatStore.ts:146

Parameters​

provider​

InferenceProvider | null

Returns​

void

setLoading​

setLoading: (loading) => void

Defined in: src/stores/chatStore.ts:165

Parameters​

loading​

boolean

Returns​

void

setMessages​

setMessages: (messages) => void

Defined in: src/stores/chatStore.ts:156

Parameters​

messages​

ChatMessage[]

Returns​

void

setMiddlewarePipeline​

setMiddlewarePipeline: (pipeline) => void

Defined in: src/stores/chatStore.ts:149

Parameters​

pipeline​

MiddlewarePipeline | null

Returns​

void

setOpen​

setOpen: (open) => void

Defined in: src/stores/chatStore.ts:209

Parameters​

open​

boolean

Returns​

void

setProtocolAdapter​

setProtocolAdapter: (adapter) => void

Defined in: src/stores/chatStore.ts:147

Parameters​

adapter​

ProtocolAdapter | null

Returns​

void

setReady​

setReady: (ready) => void

Defined in: src/stores/chatStore.ts:143

Parameters​

ready​

boolean

Returns​

void

setSuggestions​

setSuggestions: (suggestions) => void

Defined in: src/stores/chatStore.ts:211

Parameters​

suggestions​

string[]

Returns​

void

setToolExecutor​

setToolExecutor: (executor) => void

Defined in: src/stores/chatStore.ts:148

Parameters​

executor​

ToolExecutor | null

Returns​

void

startStreaming​

startStreaming: (messageId) => void

Defined in: src/stores/chatStore.ts:160

Parameters​

messageId​

string

Returns​

void

startToolCall​

startToolCall: (toolCallId, toolName, args) => void

Defined in: src/stores/chatStore.ts:180

Parameters​

toolCallId​

string

toolName​

string

args​

Record<string, unknown>

Returns​

void

stopStreaming​

stopStreaming: () => void

Defined in: src/stores/chatStore.ts:162

Returns​

void

toggleOpen​

toggleOpen: () => void

Defined in: src/stores/chatStore.ts:210

Returns​

void

unregisterExtension​

unregisterExtension: (name) => void

Defined in: src/stores/chatStore.ts:198

Parameters​

name​

string

Returns​

void

unregisterTool​

unregisterTool: (name) => void

Defined in: src/stores/chatStore.ts:175

Parameters​

name​

string

Returns​

void

updateMessage​

updateMessage: (messageId, updates) => void

Defined in: src/stores/chatStore.ts:154

Parameters​

messageId​

string

updates​

Partial<ChatMessage>

Returns​

void

updateToolCallStatus​

updateToolCallStatus: (toolCallId, status, result?, error?) => void

Defined in: src/stores/chatStore.ts:185

Parameters​

toolCallId​

string

status​

ToolCallStatus

result?​

unknown

error?​

string

Returns​

void