Class: RealtimeAgent<TContext>

Defined in: packages/kernl/src/realtime/agent.ts:14

A realtime agent definition.

Stateless configuration that describes what a realtime voice agent does. Create sessions with new RealtimeSession(agent, options).

Extends

BaseAgent<TContext>

Type Parameters

Type Parameter	Default type
`TContext`	`UnknownContext`

Constructors

Constructor

new RealtimeAgent<TContext>(config: RealtimeAgentConfig<TContext>): RealtimeAgent<TContext>;

Defined in: packages/kernl/src/realtime/agent.ts:19

Parameters

Parameter	Type
`config`	`RealtimeAgentConfig`<`TContext`>

Returns

RealtimeAgent<TContext>

Overrides

BaseAgent<TContext>.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`description?`	`readonly`	`string`	`undefined`	-	`BaseAgent.description`	packages/kernl/src/agent/base.ts:58
`id`	`readonly`	`string`	`undefined`	-	`BaseAgent.id`	packages/kernl/src/agent/base.ts:56
`instructions`	`readonly`	(`context`: `Context`<`TContext`>) => `string` \| `Promise`<`string`>	`undefined`	-	`BaseAgent.instructions`	packages/kernl/src/agent/base.ts:59
`kernl?`	`protected`	`Kernl`	`undefined`	-	`BaseAgent.kernl`	packages/kernl/src/agent/base.ts:51
`kind`	`readonly`	`"realtime"`	`"realtime"`	`BaseAgent.kind`	-	packages/kernl/src/realtime/agent.ts:15
`memory`	`readonly`	`AgentMemoryConfig`	`undefined`	-	`BaseAgent.memory`	packages/kernl/src/agent/base.ts:64
`model`	`readonly`	`RealtimeModel`	`undefined`	`BaseAgent.model`	-	packages/kernl/src/realtime/agent.ts:16
`name`	`readonly`	`string`	`undefined`	-	`BaseAgent.name`	packages/kernl/src/agent/base.ts:57
`systools`	`readonly`	`BaseToolkit`<`TContext`>[]	`undefined`	-	`BaseAgent.systools`	packages/kernl/src/agent/base.ts:63
`toolkits`	`readonly`	`BaseToolkit`<`TContext`>[]	`undefined`	-	`BaseAgent.toolkits`	packages/kernl/src/agent/base.ts:62
`voice?`	`readonly`	`RealtimeAgentVoiceConfig`	`undefined`	-	-	packages/kernl/src/realtime/agent.ts:17

Accessors

memories

Get Signature

get memories(): {
  create: (params: AgentMemoryCreate) => Promise<MemoryRecord>;
  list: (params?: Omit<MemoryListOptions, "filter"> & {
     collection?: string;
     limit?: number;
  }) => Promise<MemoryRecord[]>;
  search: (params: Omit<MemorySearchQuery, "filter"> & {
     filter?: Omit<MemoryFilter, "scope"> & {
        scope?: Omit<Partial<MemoryScope>, "agentId">;
     };
  }) => Promise<SearchHit<IndexMemoryRecord>[]>;
  update: (params: AgentMemoryUpdate) => Promise<MemoryRecord>;
};

Defined in: packages/kernl/src/agent/base.ts:158

Memory management scoped to this agent.

Returns

{
  create: (params: AgentMemoryCreate) => Promise<MemoryRecord>;
  list: (params?: Omit<MemoryListOptions, "filter"> & {
     collection?: string;
     limit?: number;
  }) => Promise<MemoryRecord[]>;
  search: (params: Omit<MemorySearchQuery, "filter"> & {
     filter?: Omit<MemoryFilter, "scope"> & {
        scope?: Omit<Partial<MemoryScope>, "agentId">;
     };
  }) => Promise<SearchHit<IndexMemoryRecord>[]>;
  update: (params: AgentMemoryUpdate) => Promise<MemoryRecord>;
}

Name	Type	Defined in
`create()`	(`params`: `AgentMemoryCreate`) => `Promise`<`MemoryRecord`>	packages/kernl/src/agent/base.ts:183
`list()`	(`params?`: `Omit`<`MemoryListOptions`, `"filter"`> & { `collection?`: `string`; `limit?`: `number`; }) => `Promise`<`MemoryRecord`[]>	packages/kernl/src/agent/base.ts:169
`search()`	(`params`: `Omit`<`MemorySearchQuery`, `"filter"`> & { `filter?`: `Omit`<`MemoryFilter`, `"scope"`> & { `scope?`: `Omit`<`Partial`<`MemoryScope`>, `"agentId"`>; }; }) => `Promise`<`SearchHit`<`IndexMemoryRecord`>[]>	packages/kernl/src/agent/base.ts:210
`update()`	(`params`: `AgentMemoryUpdate`) => `Promise`<`MemoryRecord`>	packages/kernl/src/agent/base.ts:200

Inherited from

BaseAgent.memories

Methods

bind()

bind(kernl: Kernl): void;

Defined in: packages/kernl/src/agent/base.ts:92

Bind this agent to a kernl instance. Called by kernl.register().

Parameters

Parameter	Type
`kernl`	`Kernl`

Returns

void

Inherited from

BaseAgent.bind

emit()

emit<K>(event: K, ...args: AgentHookEvents<TContext, "text">[K]): boolean;

Defined in: packages/kernl/src/agent/base.ts:107

Emit a lifecycle event to agent and kernl listeners.

Type Parameters

Type Parameter
`K` extends keyof `AgentHookEvents`<`TContext`, `TOutput`>

Parameters

Parameter	Type
`event`	`K`
...`args`	`AgentHookEvents`<`TContext`, `"text"`>[`K`]

Returns

boolean

Inherited from

BaseAgent.emit

off()

off<K>(event: K, listener: (...args: AgentHookEvents<TContext, "text">[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:26

Type Parameters

Type Parameter
`K` extends keyof `AgentHookEvents`<`TContext`, `"text"`>

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `AgentHookEvents`<`TContext`, `"text"`>[`K`]) => `void`

Returns

this

Inherited from

BaseAgent.off

on()

on<K>(event: K, listener: (...args: AgentHookEvents<TContext, "text">[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:25

Type Parameters

Type Parameter
`K` extends keyof `AgentHookEvents`<`TContext`, `"text"`>

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `AgentHookEvents`<`TContext`, `"text"`>[`K`]) => `void`

Returns

this

Inherited from

BaseAgent.on

once()

once<K>(event: K, listener: (...args: AgentHookEvents<TContext, "text">[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:27

Type Parameters

Type Parameter
`K` extends keyof `AgentHookEvents`<`TContext`, `"text"`>

Parameters

Parameter	Type
`event`	`K`
`listener`	(...`args`: `AgentHookEvents`<`TContext`, `"text"`>[`K`]) => `void`

Returns

this

Inherited from

BaseAgent.once

tool()

tool(id: string): Tool<TContext> | undefined;

Defined in: packages/kernl/src/agent/base.ts:119

Get a specific tool by ID from systools and toolkits.

Parameters

Parameter	Type
`id`	`string`

Returns

Tool<TContext> | undefined

Inherited from

BaseAgent.tool

tools()

tools(context: Context<TContext>): Promise<Tool<TContext>[]>;

Defined in: packages/kernl/src/agent/base.ts:136

Get all tools available from systools and toolkits for the given context.

Parameters

Parameter	Type
`context`	`Context`<`TContext`>

Returns

Promise<Tool<TContext>[]>

Inherited from

BaseAgent.tools

On this page