Defined in: packages/components/src/agents/Agent.ts:72
Agent that lets a model call tools in a loop until it answers without tool calls
or reaches maxIterations.
Ports: in receives a string or an AgentInput; out sends an AgentOutput.
Extends
Component
Constructors
Constructor
new Agent(config): Agent;
Defined in: packages/components/src/agents/Agent.ts:75
Parameters
| Parameter | Type |
|---|---|
config |
AgentConfig |
Returns
Agent
Overrides
Component.constructor
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
closesWithInputs |
readonly |
boolean |
Whether the node closes its outputs once all its inputs have ended (RFC 0001), so the end of a stream travels on. A node that keeps producing after its inputs end (a timer) overrides it with false and closes its outputs itself. |
Component.closesWithInputs |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:204 |
I |
readonly |
PortAccessor |
Resolves an input port. Bound to the node, so it can be passed around as $i. |
Component.I |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:167 |
id |
readonly |
string |
- | Component.id |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:163 |
identity |
readonly |
symbol |
- | Component.identity |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:164 |
inPort |
protected readonly |
Port |
The default in input port. |
Component.inPort |
packages/core/dist/component/index.d.ts:51 |
O |
readonly |
PortAccessor |
Resolves an output port. Bound to the node, so it can be passed around as $o. |
Component.O |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:169 |
opts |
public |
object |
- | Component.opts |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:165 |
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:53 |
type |
readonly |
typeof TRANSFORM |
- | Component.type |
node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:197 |
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:49 |
Methods
_transform()
_transform($i, $o): void;
Defined in: packages/components/src/agents/Agent.ts:101
Runs the agent for every value on in. A failed run produces an AgentOutput with
error set. Input that is neither a string nor an AgentInput fails the pipeline run
with a TypeError.
Parameters
| Parameter | Type |
|---|---|
$i |
Port |
$o |
Port |
Returns
void
Overrides
Component._transform
E()
E(): Port;
Defined in: node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:208
The error output (@node/error); Readable and Transform nodes have one.
Returns
Port
Inherited from
Component.E
reset()
reset(): void;
Defined in: packages/components/src/agents/Agent.ts:129
Clears the memory and stores the system prompt again.
Returns
void
run()
run(input): Promise<AgentOutput>;
Defined in: packages/components/src/agents/Agent.ts:84
Runs the agent outside a pipeline.
Parameters
| Parameter | Type |
|---|---|
input |
string | AgentInput |
Returns
Promise<AgentOutput>
Overrides
Component.run
throw()
throw(error): void;
Defined in: node_modules/.pnpm/@hlang-org+runtime@2.1.0_rxjs@7.8.2/node_modules/@hlang-org/runtime/lib/index.d.ts:207
Sends error on the error output.
Parameters
| Parameter | Type |
|---|---|
error |
unknown |
Returns
void
Inherited from
Component.throw