Documentation v1.0.0

---

Documentation / @openassistant/utils / OpenAssistantTool

Type Alias: OpenAssistantTool<TArgs, TLlmResult, TAdditionalData, TContext>

OpenAssistantTool<TArgs, TLlmResult, TAdditionalData, TContext> = object

Defined in: packages/utils/src/tool.ts:36

Type Parameters

TArgs

TArgs extends ZodType = ZodType<unknown>

TLlmResult

TLlmResult = unknown

TAdditionalData

TAdditionalData = unknown

TContext

TContext = unknown

Properties

component?

optional component: unknown

Defined in: packages/utils/src/tool.ts:46

---

context?

optional context: TContext

Defined in: packages/utils/src/tool.ts:45

---

description

description: string

Defined in: packages/utils/src/tool.ts:43

---

execute

execute: OpenAssistantExecuteFunction<z.infer<TArgs>, TLlmResult, TAdditionalData, TContext>

Defined in: packages/utils/src/tool.ts:48

---

name

name: string

Defined in: packages/utils/src/tool.ts:42

---

onToolCompleted?

optional onToolCompleted: OpenAssistantOnToolCompleted

Defined in: packages/utils/src/tool.ts:47

---

parameters

parameters: TArgs

Defined in: packages/utils/src/tool.ts:44