{[key: string]: any; maxTokens?: number; providerOptions?: Record<string, any>; stopSequences?: string[]; temperature?: number; topK?: number; topP?: number; }

modelSettings.maxTokens?

number

modelSettings.providerOptions?

Record<string, any>

modelSettings.stopSequences?

string[]

modelSettings.temperature?

number

modelSettings.topK?

number

modelSettings.topP?

number

outputs?

Record<string, Omit<Output<any, any, TContext, any>, "type">>

priority?

number

Task priority for execution ordering (higher = more priority)

Returns

Promise<AnyRef[]>

A promise that resolves to an array of logs.

send()

send: <SContext, SubContextRefs>(opts) => Promise<AnyRef[]>

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

Sends an input to the agent with the provided options.

Type Parameters

SContext

SContext extends AnyContext

SubContextRefs

SubContextRefs extends AnyContext[] = AnyContext[]

Parameters

opts

Options for sending input to the agent.

abortSignal?

AbortSignal

actions?

AnyAction[]

args

InferSchemaArguments<SContext["schema"]>

chain?

Log[]

context

SContext

contexts?

ContextRefArray<SubContextRefs>

handlers?

Partial<Handlers>

input

{ data: any; type: string; }

input.data

any

input.type

string

model?

LanguageModel

outputs?

Record<string, Omit<Output<any, any, SContext, any>, "type">>

Returns

Promise<AnyRef[]>

A promise that resolves to an array of logs.

taskRunner

taskRunner: TaskRunner

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

The task runner used by the agent.

Inherited from

AgentDef.taskRunner

tracker

tracker: SimpleTracker

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

Analytics tracker automatically extracts metrics from logger events

Inherited from

AgentDef.tracker

trainingDataPath?

optional trainingDataPath: string

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

Path to save training data

Inherited from

AgentDef.trainingDataPath

Methods

__subscribeChunk()

__subscribeChunk(contextId, handler): () => void

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

Parameters

contextId

string

handler

(log) => void

Returns

(): void

Returns

void

deleteContext()

deleteContext(contextId): Promise<void>

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

Parameters

contextId

string

Returns

Promise<void>

getAgentContext()

getAgentContext(): Promise<undefined | ContextState<TContext>>

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

Returns

Promise<undefined | ContextState<TContext>>

getContext()

getContext<TContext>(params): Promise<ContextState<TContext>>

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

Retrieves the state of a given context and arguments.

Type Parameters

TContext

TContext extends AnyContext

Parameters

params

Parameters for retrieving the context state.

args

InferSchemaArguments<TContext["schema"]>

context

TContext

Returns

Promise<ContextState<TContext>>

A promise that resolves to the context state.

getContextById()

getContextById<TContext>(id): Promise<null | ContextState<TContext>>

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

Type Parameters

TContext

TContext extends AnyContext

Parameters

id

string

Returns

Promise<null | ContextState<TContext>>

getContextId()

getContextId<TContext>(params): string

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

Retrieves the ID for a given context and arguments.

Type Parameters

TContext

TContext extends AnyContext = AnyContext

Parameters

params

Parameters for retrieving the context ID.

args

InferSchemaArguments<TContext["schema"]>

context

TContext

Returns

string

The context ID.

getContexts()

getContexts(): Promise<object[]>

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

Retrieves the contexts managed by the agent.

Returns

Promise<object[]>

A promise that resolves to an array of context objects.

getPriorityLevels()

getPriorityLevels(): object

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

Gets the configured task priority levels

Returns

object

default

default: number

high

high: number

low

low: number

getTaskConfig()

getTaskConfig(): object

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

Gets the current task configuration

Returns

object

concurrency

concurrency: object

concurrency.default

default: number

concurrency.llm

llm: number

priority

priority: object

priority.default

default: number

priority.high?

optional high: number

priority.low?

optional low: number

getWorkingMemory()

getWorkingMemory(contextId): Promise<WorkingMemory>

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

Retrieves the working memory for a given context ID.

Parameters

contextId

string

The ID of the context.

Returns

Promise<WorkingMemory>

A promise that resolves to the working memory.

isBooted()

isBooted(): boolean

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

Returns

boolean

loadContext()

loadContext<TContext>(params): Promise<null | ContextState<TContext>>

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

Type Parameters

TContext

TContext extends AnyContext

Parameters

params

args

InferSchemaArguments<TContext["schema"]>

context

TContext

Returns

Promise<null | ContextState<TContext>>

saveContext()

saveContext(state, workingMemory?): Promise<boolean>

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

Parameters

state

ContextState<AnyContext>

workingMemory?

WorkingMemory

Returns

Promise<boolean>

start()

start(args?): Promise<Agent<TContext>>

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

Starts the agent with the provided arguments.

Parameters

args?

InferSchemaArguments<TContext["schema"]>

Arguments to pass to the agent on start.

Returns

Promise<Agent<TContext>>

A promise that resolves to the agent instance.

stop()

stop(): Promise<void>

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

Stops the agent.

Returns

Promise<void>

A promise that resolves when the agent is stopped.

subscribeContext()

subscribeContext(contextId, handler): () => void

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

Parameters

contextId

string

handler

(log, done) => void

Returns

(): void

Returns

void