Types

Enumerations

HandlerRole

Defined in: packages/core/src/core/types/index.ts:505

Enumeration Members

ACTION

ACTION: "action"

Defined in: packages/core/src/core/types/index.ts:508

INPUT

INPUT: "input"

Defined in: packages/core/src/core/types/index.ts:506

OUTPUT

OUTPUT: "output"

Defined in: packages/core/src/core/types/index.ts:507

LogLevel

Defined in: packages/core/src/core/types/index.ts:51

Enumeration Members

DEBUG

DEBUG: 3

Defined in: packages/core/src/core/types/index.ts:55

ERROR

ERROR: 0

Defined in: packages/core/src/core/types/index.ts:52

INFO

INFO: 2

Defined in: packages/core/src/core/types/index.ts:54

TRACE

TRACE: 4

Defined in: packages/core/src/core/types/index.ts:56

WARN

WARN: 1

Defined in: packages/core/src/core/types/index.ts:53

Interfaces

ActionStep

Defined in: packages/core/src/core/types/index.ts:86

Extends

• BaseStep

Properties

actionOutput?

optional actionOutput: any

Defined in: packages/core/src/core/types/index.ts:96

content

content: string

Defined in: packages/core/src/core/types/index.ts:88

Overrides

BaseStep.content

duration?

optional duration: number

Defined in: packages/core/src/core/types/index.ts:97

error?

optional error: Error

Defined in: packages/core/src/core/types/index.ts:94

id

id: string

Defined in: packages/core/src/core/types/index.ts:78

Inherited from

BaseStep.id

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:83

Inherited from

BaseStep.meta

observations?

optional observations: string

Defined in: packages/core/src/core/types/index.ts:95

tags?

optional tags: string[]

Defined in: packages/core/src/core/types/index.ts:82

Inherited from

BaseStep.tags

timestamp

timestamp: number

Defined in: packages/core/src/core/types/index.ts:81

Inherited from

BaseStep.timestamp

toolCall?

optional toolCall: object

Defined in: packages/core/src/core/types/index.ts:89

arguments

arguments: any

id

id: string

name

name: string

type

type: "action"

Defined in: packages/core/src/core/types/index.ts:87

Overrides

BaseStep.type

AnalysisOptions

Defined in: packages/core/src/core/types/index.ts:180

Properties

formatResponse?

optional formatResponse: boolean

Defined in: packages/core/src/core/types/index.ts:185

maxTokens?

optional maxTokens: number

Defined in: packages/core/src/core/types/index.ts:184

role?

optional role: string

Defined in: packages/core/src/core/types/index.ts:182

system?

optional system: string

Defined in: packages/core/src/core/types/index.ts:181

temperature?

optional temperature: number

Defined in: packages/core/src/core/types/index.ts:183

BaseStep

Defined in: packages/core/src/core/types/index.ts:77

Extended by

• ActionStep
• PlanningStep
• SystemStep
• TaskStep

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:80

id

id: string

Defined in: packages/core/src/core/types/index.ts:78

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:83

tags?

optional tags: string[]

Defined in: packages/core/src/core/types/index.ts:82

timestamp

timestamp: number

Defined in: packages/core/src/core/types/index.ts:81

type

type: StepType

Defined in: packages/core/src/core/types/index.ts:79

ChainOfThoughtContext

Defined in: packages/core/src/core/types/index.ts:9

ChainOfThoughtContext can hold any relevant data the LLM or game might need to keep track of during reasoning.

Properties

actionHistory?

optional actionHistory: Record<number, { action: CoTAction; result: string; }>

Defined in: packages/core/src/core/types/index.ts:12

pastExperiences?

optional pastExperiences: EpisodicMemory[]

Defined in: packages/core/src/core/types/index.ts:19

relevantKnowledge?

optional relevantKnowledge: Documentation[]

Defined in: packages/core/src/core/types/index.ts:20

worldState

worldState: string

Defined in: packages/core/src/core/types/index.ts:11

ChainOfThoughtEvents

Defined in: packages/core/src/core/types/index.ts:197

Properties

action

()

action

: (data) => void

Defined in: packages/core/src/core/types/index.ts:200

Parameters

data

action

CoTAction

result

string

Returns

void

action

()

action

: (data) => void

Defined in: packages/core/src/core/types/index.ts:201

Parameters

data

action

CoTAction

error

unknown

Returns

void

action

()

action

: (action) => void

Defined in: packages/core/src/core/types/index.ts:199

Parameters

action

CoTAction

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:214

Parameters

goal

id

string

reason

string

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:211

Parameters

goal

id

string

result

any

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:209

Parameters

goal

description

string

id

string

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:212

Parameters

goal

error

unknown

id

string

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:213

Parameters

goal

description

string

id

string

Returns

void

goal

()

goal

: (goal) => void

Defined in: packages/core/src/core/types/index.ts:210

Parameters

goal

id

string

status

GoalStatus

Returns

void

memory

_retrieved()

memory

_retrieved: (data) => void

Defined in: packages/core/src/core/types/index.ts:217

Parameters

data

experiences

EpisodicMemory[]

Returns

void

memory

_stored()

memory

_stored: (data) => void

Defined in: packages/core/src/core/types/index.ts:215

Parameters

data

experience

EpisodicMemory

Returns

void

memory

_retrieved()

memory

_retrieved: (data) => void

Defined in: packages/core/src/core/types/index.ts:220

Parameters

data

documents

Documentation[]

Returns

void

memory

_stored()

memory

_stored: (data) => void

Defined in: packages/core/src/core/types/index.ts:216

Parameters

data

document

Documentation

Returns

void

step()

step: (step) => void

Defined in: packages/core/src/core/types/index.ts:198

Parameters

step

Step

Returns

void

think

()

think

: (data) => void

Defined in: packages/core/src/core/types/index.ts:206

Parameters

data

query

string

Returns

void

think

()

think

: (data) => void

Defined in: packages/core/src/core/types/index.ts:208

Parameters

data

error

unknown

query

string

Returns

void

think

()

think

: (data) => void

Defined in: packages/core/src/core/types/index.ts:205

Parameters

data

query

string

Returns

void

think

()

think

: (data) => void

Defined in: packages/core/src/core/types/index.ts:207

Parameters

data

query

string

Returns

void

trace

()

trace

: (data) => void

Defined in: packages/core/src/core/types/index.ts:223

Parameters

data

input

number

output

number

Returns

void

Character

Defined in: packages/core/src/core/types/index.ts:267

Properties

bio

bio: string

Defined in: packages/core/src/core/types/index.ts:269

instructions

instructions: CharacterInstructions

Defined in: packages/core/src/core/types/index.ts:272

name

name: string

Defined in: packages/core/src/core/types/index.ts:268

templates?

optional templates: object

Defined in: packages/core/src/core/types/index.ts:274

replyTemplate?

optional replyTemplate: string

thoughtTemplate?

optional thoughtTemplate: string

tweetTemplate?

optional tweetTemplate: string

traits

traits: CharacterTrait[]

Defined in: packages/core/src/core/types/index.ts:270

voice

voice: CharacterVoice

Defined in: packages/core/src/core/types/index.ts:271

CharacterInstructions

Defined in: packages/core/src/core/types/index.ts:259

Properties

constraints

constraints: string[]

Defined in: packages/core/src/core/types/index.ts:261

contextRules

contextRules: string[]

Defined in: packages/core/src/core/types/index.ts:264

goals

goals: string[]

Defined in: packages/core/src/core/types/index.ts:260

responseStyle

responseStyle: string[]

Defined in: packages/core/src/core/types/index.ts:263

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:262

CharacterTrait

Defined in: packages/core/src/core/types/index.ts:244

Properties

description

description: string

Defined in: packages/core/src/core/types/index.ts:246

examples

examples: string[]

Defined in: packages/core/src/core/types/index.ts:248

name

name: string

Defined in: packages/core/src/core/types/index.ts:245

strength

strength: number

Defined in: packages/core/src/core/types/index.ts:247

CharacterVoice

Defined in: packages/core/src/core/types/index.ts:251

Properties

commonPhrases

commonPhrases: string[]

Defined in: packages/core/src/core/types/index.ts:255

emojis

emojis: string[]

Defined in: packages/core/src/core/types/index.ts:256

style

style: string

Defined in: packages/core/src/core/types/index.ts:253

tone

tone: string

Defined in: packages/core/src/core/types/index.ts:252

vocabulary

vocabulary: string[]

Defined in: packages/core/src/core/types/index.ts:254

Cluster

Defined in: packages/core/src/core/types/index.ts:434

Extended by

• HierarchicalCluster

Properties

centroid?

optional centroid: number[]

Defined in: packages/core/src/core/types/index.ts:438

description

description: string

Defined in: packages/core/src/core/types/index.ts:437

documentCount

documentCount: number

Defined in: packages/core/src/core/types/index.ts:440

id

id: string

Defined in: packages/core/src/core/types/index.ts:435

lastUpdated

lastUpdated: Date

Defined in: packages/core/src/core/types/index.ts:441

name

name: string

Defined in: packages/core/src/core/types/index.ts:436

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:439

ClusterMetadata

Defined in: packages/core/src/core/types/index.ts:444

Extended by

• DocumentClusterMetadata
• EpisodeClusterMetadata

Properties

clusterId

clusterId: string

Defined in: packages/core/src/core/types/index.ts:445

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:446

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:447

ClusterStats

Defined in: packages/core/src/core/types/index.ts:450

Properties

averageDistance

averageDistance: number

Defined in: packages/core/src/core/types/index.ts:453

memberCount

memberCount: number

Defined in: packages/core/src/core/types/index.ts:452

variance

variance: number

Defined in: packages/core/src/core/types/index.ts:451

ClusterUpdate

Defined in: packages/core/src/core/types/index.ts:456

Properties

documentCount

documentCount: number

Defined in: packages/core/src/core/types/index.ts:458

newCentroid?

optional newCentroid: number[]

Defined in: packages/core/src/core/types/index.ts:457

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:459

variance?

optional variance: number

Defined in: packages/core/src/core/types/index.ts:460

CoTAction

Defined in: packages/core/src/core/types/index.ts:27

Data necessary for a particular action type. Extend this to fit your actual logic.

Properties

context

context: string

Defined in: packages/core/src/core/types/index.ts:29

payload

payload: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:30

type

type: string

Defined in: packages/core/src/core/types/index.ts:28

Documentation

Defined in: packages/core/src/core/types/index.ts:423

Properties

category

category: string

Defined in: packages/core/src/core/types/index.ts:427

content

content: string

Defined in: packages/core/src/core/types/index.ts:426

id

id: string

Defined in: packages/core/src/core/types/index.ts:424

lastUpdated

lastUpdated: Date

Defined in: packages/core/src/core/types/index.ts:429

relatedIds?

optional relatedIds: string[]

Defined in: packages/core/src/core/types/index.ts:431

source?

optional source: string

Defined in: packages/core/src/core/types/index.ts:430

tags

tags: string[]

Defined in: packages/core/src/core/types/index.ts:428

title

title: string

Defined in: packages/core/src/core/types/index.ts:425

DocumentClusterMetadata

Defined in: packages/core/src/core/types/index.ts:463

Extends

• ClusterMetadata

Properties

category

category: string

Defined in: packages/core/src/core/types/index.ts:464

clusterId

clusterId: string

Defined in: packages/core/src/core/types/index.ts:445

Inherited from

ClusterMetadata.clusterId

commonTags

commonTags: string[]

Defined in: packages/core/src/core/types/index.ts:465

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:446

Inherited from

ClusterMetadata.confidence

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:447

Inherited from

ClusterMetadata.topics

DomainMetadata

Defined in: packages/core/src/core/types/index.ts:481

Properties

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:484

domain

domain: string

Defined in: packages/core/src/core/types/index.ts:482

subDomain?

optional subDomain: string

Defined in: packages/core/src/core/types/index.ts:483

EnrichedContent

Defined in: packages/core/src/core/types/index.ts:316

Properties

context

context: EnrichedContext

Defined in: packages/core/src/core/types/index.ts:319

originalContent

originalContent: string

Defined in: packages/core/src/core/types/index.ts:317

timestamp

timestamp: Date

Defined in: packages/core/src/core/types/index.ts:318

EnrichedContext

Defined in: packages/core/src/core/types/index.ts:303

Properties

availableOutputs?

optional availableOutputs: string[]

Defined in: packages/core/src/core/types/index.ts:313

entities?

optional entities: string[]

Defined in: packages/core/src/core/types/index.ts:309

intent?

optional intent: string

Defined in: packages/core/src/core/types/index.ts:310

metadata?

optional metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:312

relatedMemories

relatedMemories: string[]

Defined in: packages/core/src/core/types/index.ts:307

sentiment?

optional sentiment: string

Defined in: packages/core/src/core/types/index.ts:308

similarMessages?

optional similarMessages: any[]

Defined in: packages/core/src/core/types/index.ts:311

summary

summary: string

Defined in: packages/core/src/core/types/index.ts:305

timeContext

timeContext: string

Defined in: packages/core/src/core/types/index.ts:304

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:306

EpisodeClusterMetadata

Defined in: packages/core/src/core/types/index.ts:468

Extends

• ClusterMetadata

Properties

averageImportance

averageImportance: number

Defined in: packages/core/src/core/types/index.ts:470

clusterId

clusterId: string

Defined in: packages/core/src/core/types/index.ts:445

Inherited from

ClusterMetadata.clusterId

commonEmotions

commonEmotions: string[]

Defined in: packages/core/src/core/types/index.ts:469

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:446

Inherited from

ClusterMetadata.confidence

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:447

Inherited from

ClusterMetadata.topics

EpisodicMemory

Defined in: packages/core/src/core/types/index.ts:413

Properties

action

action: string

Defined in: packages/core/src/core/types/index.ts:416

context?

optional context: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:418

emotions?

optional emotions: string[]

Defined in: packages/core/src/core/types/index.ts:419

id

id: string

Defined in: packages/core/src/core/types/index.ts:414

importance?

optional importance: number

Defined in: packages/core/src/core/types/index.ts:420

outcome

outcome: string

Defined in: packages/core/src/core/types/index.ts:417

timestamp

timestamp: Date

Defined in: packages/core/src/core/types/index.ts:415

Goal

Defined in: packages/core/src/core/types/index.ts:128

Properties

completed_at?

optional completed_at: number

Defined in: packages/core/src/core/types/index.ts:139

created_at

created_at: number

Defined in: packages/core/src/core/types/index.ts:138

dependencies?

optional dependencies: string[]

Defined in: packages/core/src/core/types/index.ts:134

description

description: string

Defined in: packages/core/src/core/types/index.ts:131

horizon

horizon: HorizonType

Defined in: packages/core/src/core/types/index.ts:130

id

id: string

Defined in: packages/core/src/core/types/index.ts:129

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:141

outcomeScore?

optional outcomeScore: number

Defined in: packages/core/src/core/types/index.ts:147

A numeric measure of how successful this goal was completed. You can define any scale you like: e.g. 0-1, or 0-100, or a positive/negative integer.

parentGoal?

optional parentGoal: string

Defined in: packages/core/src/core/types/index.ts:136

priority

priority: number

Defined in: packages/core/src/core/types/index.ts:133

progress?

optional progress: number

Defined in: packages/core/src/core/types/index.ts:140

scoreHistory?

optional scoreHistory: object[]

Defined in: packages/core/src/core/types/index.ts:152

Optional history of scores over time, if you want to track multiple attempts or partial runs.

comment?

optional comment: string

score

score: number

timestamp

timestamp: number

status

status: GoalStatus

Defined in: packages/core/src/core/types/index.ts:132

subgoals?

optional subgoals: string[]

Defined in: packages/core/src/core/types/index.ts:135

success_criteria

success_criteria: string[]

Defined in: packages/core/src/core/types/index.ts:137

HierarchicalCluster

Defined in: packages/core/src/core/types/index.ts:473

Extends

• Cluster

Properties

centroid?

optional centroid: number[]

Defined in: packages/core/src/core/types/index.ts:438

Inherited from

Cluster.centroid

childIds

childIds: string[]

Defined in: packages/core/src/core/types/index.ts:475

description

description: string

Defined in: packages/core/src/core/types/index.ts:437

Inherited from

Cluster.description

documentCount

documentCount: number

Defined in: packages/core/src/core/types/index.ts:440

Inherited from

Cluster.documentCount

domain

domain: string

Defined in: packages/core/src/core/types/index.ts:477

id

id: string

Defined in: packages/core/src/core/types/index.ts:435

Inherited from

Cluster.id

lastUpdated

lastUpdated: Date

Defined in: packages/core/src/core/types/index.ts:441

Inherited from

Cluster.lastUpdated

level

level: number

Defined in: packages/core/src/core/types/index.ts:476

name

name: string

Defined in: packages/core/src/core/types/index.ts:436

Inherited from

Cluster.name

parentId?

optional parentId: string

Defined in: packages/core/src/core/types/index.ts:474

subDomain?

optional subDomain: string

Defined in: packages/core/src/core/types/index.ts:478

topics

topics: string[]

Defined in: packages/core/src/core/types/index.ts:439

Inherited from

Cluster.topics

IChain

Defined in: packages/core/src/core/types/index.ts:487

Properties

chainId

chainId: string

Defined in: packages/core/src/core/types/index.ts:491

A unique identifier for the chain (e.g., "starknet", "ethereum", "solana", etc.)

Methods

read()

read(call): Promise<any>

Defined in: packages/core/src/core/types/index.ts:497

Read (call) a contract or perform a query on this chain. The call parameter can be chain-specific data.

Parameters

call

unknown

Returns

Promise<any>

write()

write(call): Promise<any>

Defined in: packages/core/src/core/types/index.ts:502

Write (execute a transaction) on this chain, typically requiring signatures, etc.

Parameters

call

unknown

Returns

Promise<any>

IOHandler

Defined in: packages/core/src/core/types/index.ts:514

A single interface for all Inputs, Outputs.

Properties

handler()

handler: (payload?) => Promise<unknown>

Defined in: packages/core/src/core/types/index.ts:525

The main function. For inputs, no payload is typically passed. For outputs, pass the data.

Parameters

payload?

unknown

Returns

Promise<unknown>

name

name: string

Defined in: packages/core/src/core/types/index.ts:516

Unique name for this handler

role

role: HandlerRole

Defined in: packages/core/src/core/types/index.ts:519

"input" | "output" | (optionally "action") if you want more roles

schema

schema: ZodType

Defined in: packages/core/src/core/types/index.ts:522

The schema for the input handler

LLMClientConfig

Defined in: packages/core/src/core/types/index.ts:170

Properties

baseDelay?

optional baseDelay: number

Defined in: packages/core/src/core/types/index.ts:176

maxDelay?

optional maxDelay: number

Defined in: packages/core/src/core/types/index.ts:177

maxRetries?

optional maxRetries: number

Defined in: packages/core/src/core/types/index.ts:172

maxTokens?

optional maxTokens: number

Defined in: packages/core/src/core/types/index.ts:175

model?

optional model: string

Defined in: packages/core/src/core/types/index.ts:171

temperature?

optional temperature: number

Defined in: packages/core/src/core/types/index.ts:174

timeout?

optional timeout: number

Defined in: packages/core/src/core/types/index.ts:173

LLMResponse

Defined in: packages/core/src/core/types/index.ts:159

Properties

metadata?

optional metadata: Record<string, unknown>

Defined in: packages/core/src/core/types/index.ts:167

model

model: string

Defined in: packages/core/src/core/types/index.ts:161

text

text: string

Defined in: packages/core/src/core/types/index.ts:160

usage?

optional usage: object

Defined in: packages/core/src/core/types/index.ts:162

completion_tokens

completion_tokens: number

prompt_tokens

prompt_tokens: number

total_tokens

total_tokens: number

LLMStructuredResponse

Defined in: packages/core/src/core/types/index.ts:33

Properties

actions

actions: CoTAction[]

Defined in: packages/core/src/core/types/index.ts:41

meta?

optional meta: object

Defined in: packages/core/src/core/types/index.ts:35

requirements?

optional requirements: object

requirements.population?

optional population: number

requirements.resources?

optional resources: Record<string, number>

plan?

optional plan: string

Defined in: packages/core/src/core/types/index.ts:34

LLMValidationOptions<T>

Defined in: packages/core/src/core/types/index.ts:234

Type Parameters

• T

Properties

llmClient

llmClient: LLMClient

Defined in: packages/core/src/core/types/index.ts:240

logger

logger: Logger

Defined in: packages/core/src/core/types/index.ts:241

maxRetries?

optional maxRetries: number

Defined in: packages/core/src/core/types/index.ts:238

onRetry()?

optional onRetry: (error, attempt) => void

Defined in: packages/core/src/core/types/index.ts:239

Parameters

error

Error

attempt

number

Returns

void

prompt

prompt: string

Defined in: packages/core/src/core/types/index.ts:235

schema

schema: ZodType<T, T>

Defined in: packages/core/src/core/types/index.ts:237

systemPrompt

systemPrompt: string

Defined in: packages/core/src/core/types/index.ts:236

LogEntry

Defined in: packages/core/src/core/types/index.ts:67

Properties

context

context: string

Defined in: packages/core/src/core/types/index.ts:70

data?

optional data: any

Defined in: packages/core/src/core/types/index.ts:72

level

level: LogLevel

Defined in: packages/core/src/core/types/index.ts:68

message

message: string

Defined in: packages/core/src/core/types/index.ts:71

timestamp

timestamp: Date

Defined in: packages/core/src/core/types/index.ts:69

LoggerConfig

Defined in: packages/core/src/core/types/index.ts:59

Properties

enableColors?

optional enableColors: boolean

Defined in: packages/core/src/core/types/index.ts:62

enableTimestamp?

optional enableTimestamp: boolean

Defined in: packages/core/src/core/types/index.ts:61

level

level: LogLevel

Defined in: packages/core/src/core/types/index.ts:60

logPath?

optional logPath: string

Defined in: packages/core/src/core/types/index.ts:64

logToFile?

optional logToFile: boolean

Defined in: packages/core/src/core/types/index.ts:63

Memory

Defined in: packages/core/src/core/types/index.ts:356

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:359

embedding?

optional embedding: number[]

Defined in: packages/core/src/core/types/index.ts:362

id

id: string

Defined in: packages/core/src/core/types/index.ts:357

metadata?

optional metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:361

roomId

roomId: string

Defined in: packages/core/src/core/types/index.ts:358

timestamp

timestamp: Date

Defined in: packages/core/src/core/types/index.ts:360

PlanningStep

Defined in: packages/core/src/core/types/index.ts:100

Extends

• BaseStep

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:80

Inherited from

BaseStep.content

facts

facts: string

Defined in: packages/core/src/core/types/index.ts:103

id

id: string

Defined in: packages/core/src/core/types/index.ts:78

Inherited from

BaseStep.id

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:83

Inherited from

BaseStep.meta

plan

plan: string

Defined in: packages/core/src/core/types/index.ts:102

tags?

optional tags: string[]

Defined in: packages/core/src/core/types/index.ts:82

Inherited from

BaseStep.tags

timestamp

timestamp: number

Defined in: packages/core/src/core/types/index.ts:81

Inherited from

BaseStep.timestamp

type

type: "planning"

Defined in: packages/core/src/core/types/index.ts:101

Overrides

BaseStep.type

ProcessedResult

Defined in: packages/core/src/core/types/index.ts:281

Properties

alreadyProcessed?

optional alreadyProcessed: boolean

Defined in: packages/core/src/core/types/index.ts:287

content

content: any

Defined in: packages/core/src/core/types/index.ts:282

enrichedContext

enrichedContext: EnrichedContext

Defined in: packages/core/src/core/types/index.ts:284

isOutputSuccess?

optional isOutputSuccess: boolean

Defined in: packages/core/src/core/types/index.ts:286

metadata

metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:283

suggestedOutputs

suggestedOutputs: SuggestedOutput<any>[]

Defined in: packages/core/src/core/types/index.ts:285

updateTasks?

optional updateTasks: object[]

Defined in: packages/core/src/core/types/index.ts:288

confidence

confidence: number

data?

optional data: any

intervalMs

intervalMs: number

name

name: string

RefinedGoal

Defined in: packages/core/src/core/types/index.ts:226

Properties

description

description: string

Defined in: packages/core/src/core/types/index.ts:227

horizon

horizon: "short"

Defined in: packages/core/src/core/types/index.ts:230

priority

priority: number

Defined in: packages/core/src/core/types/index.ts:229

requirements

requirements: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:231

success_criteria

success_criteria: string[]

Defined in: packages/core/src/core/types/index.ts:228

RoomMetadata

Defined in: packages/core/src/core/types/index.ts:347

Properties

createdAt

createdAt: Date

Defined in: packages/core/src/core/types/index.ts:351

description?

optional description: string

Defined in: packages/core/src/core/types/index.ts:349

lastActive

lastActive: Date

Defined in: packages/core/src/core/types/index.ts:352

metadata?

optional metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:353

name

name: string

Defined in: packages/core/src/core/types/index.ts:348

participants

participants: string[]

Defined in: packages/core/src/core/types/index.ts:350

SearchResult

Defined in: packages/core/src/core/types/index.ts:44

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:46

id

id: string

Defined in: packages/core/src/core/types/index.ts:45

metadata?

optional metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:48

similarity

similarity: number

Defined in: packages/core/src/core/types/index.ts:47

StructuredAnalysis

Defined in: packages/core/src/core/types/index.ts:188

Properties

caveats

caveats: string[]

Defined in: packages/core/src/core/types/index.ts:193

conclusion

conclusion: string

Defined in: packages/core/src/core/types/index.ts:191

confidenceLevel

confidenceLevel: number

Defined in: packages/core/src/core/types/index.ts:192

reasoning

reasoning: string

Defined in: packages/core/src/core/types/index.ts:190

summary

summary: string

Defined in: packages/core/src/core/types/index.ts:189

SuggestedOutput<T>

Defined in: packages/core/src/core/types/index.ts:296

Type Parameters

• T

Properties

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:299

data

data: T

Defined in: packages/core/src/core/types/index.ts:298

name

name: string

Defined in: packages/core/src/core/types/index.ts:297

reasoning

reasoning: string

Defined in: packages/core/src/core/types/index.ts:300

SystemStep

Defined in: packages/core/src/core/types/index.ts:106

Extends

• BaseStep

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:80

Inherited from

BaseStep.content

id

id: string

Defined in: packages/core/src/core/types/index.ts:78

Inherited from

BaseStep.id

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:83

Inherited from

BaseStep.meta

systemPrompt

systemPrompt: string

Defined in: packages/core/src/core/types/index.ts:108

tags?

optional tags: string[]

Defined in: packages/core/src/core/types/index.ts:82

Inherited from

BaseStep.tags

timestamp

timestamp: number

Defined in: packages/core/src/core/types/index.ts:81

Inherited from

BaseStep.timestamp

type

type: "system"

Defined in: packages/core/src/core/types/index.ts:107

Overrides

BaseStep.type

TaskStep

Defined in: packages/core/src/core/types/index.ts:111

Extends

• BaseStep

Properties

content

content: string

Defined in: packages/core/src/core/types/index.ts:80

Inherited from

BaseStep.content

id

id: string

Defined in: packages/core/src/core/types/index.ts:78

Inherited from

BaseStep.id

meta?

optional meta: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:83

Inherited from

BaseStep.meta

tags?

optional tags: string[]

Defined in: packages/core/src/core/types/index.ts:82

Inherited from

BaseStep.tags

task

task: string

Defined in: packages/core/src/core/types/index.ts:113

timestamp

timestamp: number

Defined in: packages/core/src/core/types/index.ts:81

Inherited from

BaseStep.timestamp

type

type: "task"

Defined in: packages/core/src/core/types/index.ts:112

Overrides

BaseStep.type

Thought

Defined in: packages/core/src/core/types/index.ts:322

Properties

confidence

confidence: number

Defined in: packages/core/src/core/types/index.ts:324

content

content: string

Defined in: packages/core/src/core/types/index.ts:323

context?

optional context: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:325

metadata?

optional metadata: Record<string, any>

Defined in: packages/core/src/core/types/index.ts:329

roomId?

optional roomId: string

Defined in: packages/core/src/core/types/index.ts:330

source

source: string

Defined in: packages/core/src/core/types/index.ts:328

timestamp

timestamp: Date

Defined in: packages/core/src/core/types/index.ts:326

type

type: string

Defined in: packages/core/src/core/types/index.ts:327

ThoughtTemplate

Defined in: packages/core/src/core/types/index.ts:340

Properties

description

description: string

Defined in: packages/core/src/core/types/index.ts:342

prompt

prompt: string

Defined in: packages/core/src/core/types/index.ts:343

temperature

temperature: number

Defined in: packages/core/src/core/types/index.ts:344

type

type: ThoughtType

Defined in: packages/core/src/core/types/index.ts:341

VectorDB

Defined in: packages/core/src/core/types/index.ts:365

Methods

delete()

delete(id): Promise<void>

Defined in: packages/core/src/core/types/index.ts:374

Parameters

id

string

Returns

Promise<void>

findSimilar()

findSimilar(content, limit?, metadata?): Promise<SearchResult[]>

Defined in: packages/core/src/core/types/index.ts:366

Parameters

content

string

limit?

number

metadata?

Record<string, any>

Returns

Promise<SearchResult[]>

findSimilarDocuments()

findSimilarDocuments(query, limit?): Promise<Documentation[]>

Defined in: packages/core/src/core/types/index.ts:400

Parameters

query

string

limit?

number

Returns

Promise<Documentation[]>

findSimilarEpisodes()

findSimilarEpisodes(action, limit?): Promise<EpisodicMemory[]>

Defined in: packages/core/src/core/types/index.ts:393

Parameters

action

string

limit?

number

Returns

Promise<EpisodicMemory[]>

findSimilarInRoom()

findSimilarInRoom(content, roomId, limit?, metadata?): Promise<SearchResult[]>

Defined in: packages/core/src/core/types/index.ts:382

Parameters

content

string

roomId

string

limit?

number

metadata?

Record<string, any>

Returns

Promise<SearchResult[]>

getRecentEpisodes()

getRecentEpisodes(limit?): Promise<EpisodicMemory[]>

Defined in: packages/core/src/core/types/index.ts:397

Parameters

limit?

number

Returns

Promise<EpisodicMemory[]>

getSystemMetadata()

getSystemMetadata(key): Promise<null | Record<string, any>>

Defined in: packages/core/src/core/types/index.ts:390

Parameters

key

string

Returns

Promise<null | Record<string, any>>

purge()

purge(): Promise<void>

Defined in: packages/core/src/core/types/index.ts:410

Returns

Promise<void>

searchDocumentsByTag()

searchDocumentsByTag(tags, limit?): Promise<Documentation[]>

Defined in: packages/core/src/core/types/index.ts:404

Parameters

tags

string[]

limit?

number

Returns

Promise<Documentation[]>

store()

store(content, metadata?): Promise<void>

Defined in: packages/core/src/core/types/index.ts:372

Parameters

content

string

metadata?

Record<string, any>

Returns

Promise<void>

storeDocument()

storeDocument(doc): Promise<string>

Defined in: packages/core/src/core/types/index.ts:399

Parameters

doc

Omit<Documentation, "id">

Returns

Promise<string>

storeEpisode()

storeEpisode(memory): Promise<string>

Defined in: packages/core/src/core/types/index.ts:392

Parameters

memory

Omit<EpisodicMemory, "id">

Returns

Promise<string>

storeInRoom()

storeInRoom(content, roomId, metadata?): Promise<void>

Defined in: packages/core/src/core/types/index.ts:376

Parameters

content

string

roomId

string

metadata?

Record<string, any>

Returns

Promise<void>

storeSystemMetadata()

storeSystemMetadata(key, value): Promise<void>

Defined in: packages/core/src/core/types/index.ts:389

Parameters

key

string

value

Record<string, any>

Returns

Promise<void>

updateDocument()

updateDocument(id, updates): Promise<void>

Defined in: packages/core/src/core/types/index.ts:408

Parameters

id

string

updates

Partial<Documentation>

Returns

Promise<void>

Type Aliases

GoalStatus

GoalStatus: "pending" | "active" | "completed" | "failed" | "ready" | "blocked"

Defined in: packages/core/src/core/types/index.ts:119

HorizonType

HorizonType: "long" | "medium" | "short"

Defined in: packages/core/src/core/types/index.ts:118

Step

Step: ActionStep | PlanningStep | SystemStep | TaskStep

Defined in: packages/core/src/core/types/index.ts:116

StepType

StepType: "action" | "planning" | "system" | "task"

Defined in: packages/core/src/core/types/index.ts:75

ThoughtType

ThoughtType: "social_share" | "research" | "analysis" | "alert" | "inquiry"

Defined in: packages/core/src/core/types/index.ts:333