Defined in: packages/components/src/tool-invoker/index.ts:67
Runs the tool calls found in a list of messages and returns one tool message per call.
A failed, timed-out or unknown tool produces an error text in its tool message, so the model can see the failure and other calls in the batch still complete.
Extends
Component
Constructors
Constructor
new ToolInvoker(config): ToolInvoker;
Defined in: packages/components/src/tool-invoker/index.ts:73
Parameters
| Parameter | Type |
|---|---|
config |
ToolInvokerConfig |
Returns
ToolInvoker
Overrides
Component.constructor
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
flow |
public |
Flow | null |
- | Component.flow |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:24 |
I |
public |
(name) => Port |
- | Component.I |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:26 |
id |
public |
string |
- | Component.id |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:18 |
identity |
public |
Symbol |
- | Component.identity |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:25 |
inPort |
protected readonly |
Port |
The default in input port. |
Component.inPort |
packages/core/dist/component/index.d.ts:49 |
isRunning |
public |
boolean |
- | Component.isRunning |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:23 |
O |
public |
(name) => Port |
- | Component.O |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:27 |
opts |
public |
object |
- | Component.opts |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:19 |
outPort |
protected readonly |
Port |
The default out output port. A pipeline uses it to infer the endpoint. |
Component.outPort |
packages/core/dist/component/index.d.ts:51 |
portMap |
public |
PortMap |
- | Component.portMap |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:22 |
type |
public |
Symbol |
- | Component.type |
node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:17 |
Port |
static |
typeof Port |
Port factory from the HLang runtime. Component.Port.I(name) and Component.Port.O(name) create input and output ports; call .attach(this) in the constructor. |
Component.Port |
packages/core/dist/component/index.d.ts:47 |
Methods
_transform()
_transform($i, $o): void;
Defined in: packages/components/src/tool-invoker/index.ts:112
Reads ToolInvokerInput from the in port and sends ToolInvokerOutput to out.
Invalid input produces an empty tool_messages array.
Parameters
| Parameter | Type |
|---|---|
$i |
Port |
$o |
Port |
Returns
void
Overrides
Component._transform
attach()
attach(flow): void;
Defined in: node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:31
Parameters
| Parameter | Type |
|---|---|
flow |
any |
Returns
void
Inherited from
Component.attach
attachPort()
attachPort(port): void;
Defined in: node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:32
Parameters
| Parameter | Type |
|---|---|
port |
any |
Returns
void
Inherited from
Component.attachPort
E()
E(): Port;
Defined in: node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:30
Returns
Port
Inherited from
Component.E
executeOnce()
executeOnce(type, ...args): void;
Defined in: node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/node.d.ts:29
Parameters
| Parameter | Type |
|---|---|
type |
any |
...args |
any[] |
Returns
void
Inherited from
Component.executeOnce
run()
run(input): Promise<ToolInvokerOutput>;
Defined in: packages/components/src/tool-invoker/index.ts:91
Runs every tool call in input.messages.
Parameters
| Parameter | Type |
|---|---|
input |
ToolInvokerInput |
Returns
Promise<ToolInvokerOutput>
Overrides
Component.run
throw()
throw(error): void;
Defined in: node_modules/.pnpm/@hlang-org+runtime@1.0.5/node_modules/@hlang-org/runtime/lib/node/transform.d.ts:4
Parameters
| Parameter | Type |
|---|---|
error |
any |
Returns
void
Inherited from
Component.throw