Defined in: packages/components/src/agents/StreamingAgent.ts:131
Agent that reports its progress as a stream of StreamingChunk events.
It follows the same loop as Agent. When the model implements
streamChatCompletion, assistant text is streamed token by token; otherwise each
reply arrives as one assistant_message.
Ports: in receives a string or an AgentInput; out sends every StreamingChunk.
Extends
Component
Constructors
Constructor
new StreamingAgent(config): StreamingAgent;
Defined in: packages/components/src/agents/StreamingAgent.ts:134
Parameters
| Parameter | Type |
|---|---|
config |
AgentConfig |
Returns
StreamingAgent
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/agents/StreamingAgent.ts:173
Streams every event of a run to out. A failed run ends with one error event.
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
reset()
reset(): void;
Defined in: packages/components/src/agents/StreamingAgent.ts:190
Clears the memory and stores the system prompt again.
Returns
void
run()
run(input): Promise<AgentOutput>;
Defined in: packages/components/src/agents/StreamingAgent.ts:160
Runs the agent to completion and returns the final output.
Parameters
| Parameter | Type |
|---|---|
input |
string | AgentInput |
Returns
Promise<AgentOutput>
Overrides
Component.run
runStream()
runStream(input): AsyncGenerator<StreamingChunk, AgentOutput>;
Defined in: packages/components/src/agents/StreamingAgent.ts:144
Runs the agent and yields progress events. The generator returns the final output.
On failure it yields one error event and rethrows.
Parameters
| Parameter | Type |
|---|---|
input |
string | AgentInput |
Returns
AsyncGenerator<StreamingChunk, AgentOutput>
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