ContextConfigApi<TMemory, Schema, Ctx, Actions, Events>

Type Parameters

Schema

Schema extends z.ZodTypeAny | ZodRawShape = z.ZodTypeAny

Actions

Actions extends AnyAction[] = AnyAction[]

Events

Events extends Record<string, z.ZodTypeAny | ZodRawShape> = Record<string, z.ZodTypeAny | ZodRawShape>

Properties

__composers?

optional __composers: BaseContextComposer<Context<TMemory, Schema, Ctx, Actions, Events>>[]

Defined in: packages/core/src/types.ts:1191

__templateResolvers?

optional __templateResolvers: Record<string, TemplateResolver<AgentContext<Context<TMemory, Schema, Ctx, Actions, Events>> & ContextStateApi<Context<TMemory, Schema, Ctx, Actions, Events>>>>

Defined in: packages/core/src/types.ts:1193

actions?

optional actions: Resolver<Action<ActionSchema, any, unknown, AnyContext, AnyAgent, ActionState>[], ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1165

create()?

optional create: (params, agent) => TMemory | Promise<TMemory>

Defined in: packages/core/src/types.ts:1102

Optional function to create new memory for this context

Parameters

params

description?

optional description: Resolver<string | string[], ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1117

Optional description of this context

episodeHooks?

optional episodeHooks: EpisodeHooks<Context<TMemory, Schema, Ctx, Actions, Events>>

Defined in: packages/core/src/types.ts:1163

Episode detection and creation hooks for this context

events?

optional events: Resolver<Events, ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1167

inputs?

optional inputs: Resolver<Record<string, InputConfig<any, any, AnyAgent>>, ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1172

A record of input configurations for the context.

instructions?

optional instructions: Resolver<Instruction, ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1114

Optional instructions for this context

key()?

optional key: (args) => string

Defined in: packages/core/src/types.ts:1092

Function to generate a unique key from context arguments

load()?

optional load: (id, params) => Promise<null | TMemory>

Defined in: packages/core/src/types.ts:1120

Optional function to load existing memory

loader()?

optional loader: (state, agent) => Promise<void>

Defined in: packages/core/src/types.ts:1156

Parameters

state

ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>

maxSteps?

optional maxSteps: number

Defined in: packages/core/src/types.ts:1158

maxWorkingMemorySize?

optional maxWorkingMemorySize: number

Defined in: packages/core/src/types.ts:1160

model?

optional model: LanguageModel

Defined in: packages/core/src/types.ts:1132

modelSettings?

optional modelSettings: object

Defined in: packages/core/src/types.ts:1134

providerOptions?

optional providerOptions: Record<string, any>

stopSequences?

optional stopSequences: string[]

onError()?

optional onError: (error, ctx, agent) => Promise<void>

Defined in: packages/core/src/types.ts:1150

Parameters

ctx

AgentContext<Context<TMemory, Schema, Ctx, Actions, Events>>

onRun()?

optional onRun: (ctx, agent) => Promise<void>

Defined in: packages/core/src/types.ts:1144

Parameters

ctx

AgentContext<Context<TMemory, Schema, Ctx, Actions, Events>>

onStep()?

optional onStep: (ctx, agent) => Promise<void>

Defined in: packages/core/src/types.ts:1146

Parameters

ctx

AgentContext<Context<TMemory, Schema, Ctx, Actions, Events>>

outputs?

optional outputs: Resolver<Record<string, Omit<Output<any, any, AnyContext, any>, "name">>, ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1180

A record of output configurations for the context.

render()?

optional render: (state) => string | string[] | XMLElement | XMLElement[] | (string | XMLElement)[]

Defined in: packages/core/src/types.ts:1128

Optional function to render memory state

Parameters

state

ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>

Returns

retrieval?

optional retrieval: Resolver<RetrievalPolicy, ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>>

Defined in: packages/core/src/types.ts:1189

Retrieval configuration to adapt memory recall per-context. Can be a static object or a function of the current context state.

save()?

optional save: (state) => Promise<void>

Defined in: packages/core/src/types.ts:1125

Optional function to save memory state

Parameters

state

ContextState<Context<TMemory, Schema, Ctx, Actions, Events>>

schema?

optional schema: Schema

Defined in: packages/core/src/types.ts:1090

Zod schema for validating context arguments

setup()?

optional setup: (args, settings, agent) => Ctx | Promise<Ctx>

Defined in: packages/core/src/types.ts:1095

Setup function to initialize context data

Parameters

shouldContinue()?

optional shouldContinue: (ctx) => boolean

Defined in: packages/core/src/types.ts:1148

Parameters

ctx

AgentContext<Context<TMemory, Schema, Ctx, Actions, Events>>

type

type: string

Defined in: packages/core/src/types.ts:1088

Unique type identifier for this context

Methods

setActions()

setActions<TActions>(actions): Context<TMemory, Schema, Ctx, TActions, Events>

Defined in: packages/core/src/types.ts:992

Type Parameters

TActions

TActions extends AnyActionWithContext<Context<TMemory, Schema, Ctx, any, Events>>[]

Returns

Context<TMemory, Schema, Ctx, TActions, Events>

setInputs()

setInputs<TSchemas>(inputs): Context<TMemory, Schema, Ctx, Actions, Events>

Defined in: packages/core/src/types.ts:999

TSchemas extends Record<string, Readonly<{[k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>; }> | ZodString | ZodObject<$ZodLooseShape, $strip>>

Parameters

inputs

{ [K in string | number | symbol]: InputConfig<TSchemas[K], Context<TMemory, Schema, Ctx, Actions, Events>, AnyAgent> }

Returns

Context<TMemory, Schema, Ctx, Actions, Events>

Inherited from

ContextConfigApi.setInputs

setOutputs()

setOutputs<TSchemas>(outputs): Context<TMemory, Schema, Ctx, Actions, Events>

Defined in: packages/core/src/types.ts:1008

use<Refs>(composer): Context<TMemory, Schema, Ctx, Actions, Events>

Defined in: packages/core/src/types.ts:1019

Context

On this page