Kikoyu Core API Reference

Kikoyu Core API Reference / Runner

Class: Runner

Constructors

new Runner()

new Runner(): Runner

Returns

Runner

Methods

run()

run<TStructured, TContext>(agent, input, options?): Promise<RunResult<TStructured>>

Type Parameters

• TStructured = unknown

• TContext = Record<string, unknown>

Parameters

agent

Agent

input

string | ModelMessage[]

options?

RunOptions<TContext>

Returns

Promise<RunResult<TStructured>>

Defined in

runner.ts:434

stream()

stream<TStructured, TContext>(agent, input, options?): AsyncGenerator<StreamEvent, RunResult<TStructured>, void>

Type Parameters

• TStructured = unknown

• TContext = Record<string, unknown>

Parameters

agent

Agent

input

string | ModelMessage[]

options?

RunOptions<TContext>

Returns

AsyncGenerator<StreamEvent, RunResult<TStructured>, void>

Defined in

runner.ts:26