Skip to main content

Interface: IGMI

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:625

Interface​

IGMI

Description​

Defines the contract for a Generalized Mind Instance (GMI).

Properties​

creationTimestamp​

readonly creationTimestamp: Date

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:627


gmiId​

readonly gmiId: string

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:626

Methods​

_triggerAndProcessSelfReflection()​

_triggerAndProcessSelfReflection(): Promise<void>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:696

Returns​

Promise<void>


analyzeAndReportMemoryHealth()​

analyzeAndReportMemoryHealth(): Promise<{ issues?: object[]; lifecycleManagerStats?: { details?: any; isHealthy: boolean; }; overallStatus: "DEGRADED" | "ERROR" | "OPERATIONAL" | "LIMITED"; ragSystemStats?: { details?: any; isHealthy: boolean; }; workingMemoryStats?: {[key: string]: any; itemCount: number; }; } | undefined>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:698

Returns​

Promise<{ issues?: object[]; lifecycleManagerStats?: { details?: any; isHealthy: boolean; }; overallStatus: "DEGRADED" | "ERROR" | "OPERATIONAL" | "LIMITED"; ragSystemStats?: { details?: any; isHealthy: boolean; }; workingMemoryStats?: {[key: string]: any; itemCount: number; }; } | undefined>


clearHistory()?​

optional clearHistory(): void

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:661

Empties the conversation history; GMI drops what it recorded about its turns, as for replaceHistory.

Returns​

void


getCognitiveMemoryManager()​

getCognitiveMemoryManager(): ICognitiveMemoryManager | undefined

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:695

Returns​

ICognitiveMemoryManager | undefined


getCurrentPrimaryPersonaId()​

getCurrentPrimaryPersonaId(): string

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:631

Returns​

string


getCurrentState()​

getCurrentState(): GMIPrimeState

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:633

Returns​

GMIPrimeState


getGMIId()​

getGMIId(): string

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:632

Returns​

string


getOverallHealth()​

getOverallHealth(): Promise<GMIHealthReport>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:699

Returns​

Promise<GMIHealthReport>


getPersona()​

getPersona(): IPersonaDefinition

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:630

Returns​

IPersonaDefinition


getReasoningTrace()​

getReasoningTrace(): Readonly<ReasoningTrace>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:693

Returns​

Readonly<ReasoningTrace>


getWorkingMemorySnapshot()​

getWorkingMemorySnapshot(): Promise<Record<string, any>>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:694

Returns​

Promise<Record<string, any>>


handleToolResult()​

handleToolResult(toolCallId, toolName, resultPayload, userId, userApiKeys?): Promise<GMIOutput>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:636

Parameters​

toolCallId​

string

toolName​

string

resultPayload​

ToolResultPayload

userId​

string

userApiKeys?​

Record<string, string>

Returns​

Promise<GMIOutput>


handleToolResults()?​

optional handleToolResults(toolResults, userId, userApiKeys?): Promise<GMIOutput>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:644

Parameters​

toolResults​

ToolCallResult[]

userId​

string

userApiKeys?​

Record<string, string>

Returns​

Promise<GMIOutput>


hydrateConversationHistory()?​

optional hydrateConversationHistory(conversationHistory): void

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:650

Parameters​

conversationHistory​

ConversationMessage[]

Returns​

void


hydrateTurnContext()?​

optional hydrateTurnContext(context): void

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:663

Parameters​

context​
conversationId?​

string

organizationId?​

string

sessionId?​

string

Returns​

void


initialize()​

initialize(persona, config): Promise<void>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:629

Parameters​

persona​

IPersonaDefinition

config​

GMIBaseConfig

Returns​

Promise<void>


onMemoryLifecycleEvent()​

onMemoryLifecycleEvent(event): Promise<LifecycleActionResponse>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:697

Parameters​

event​

MemoryLifecycleEvent

Returns​

Promise<LifecycleActionResponse>


processTurnStream()​

processTurnStream(turnInput): AsyncGenerator<GMIOutputChunk, GMIOutput, undefined>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:634

Parameters​

turnInput​

GMITurnInput

Returns​

AsyncGenerator<GMIOutputChunk, GMIOutput, undefined>


recordUserFeedback()?​

optional recordUserFeedback(feedback): Promise<void>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:679

Records user feedback on this instance's session: a reasoning-trace entry and, when cognitive memory is configured, memories scoped to the user. GMIManager calls it with feedback normalized by normalizeUserFeedback. Optional so that custom IGMI implementations keep compiling.

Parameters​

feedback​

NormalizedUserFeedback & object

Normalized feedback plus the id of the user who sent it.

Returns​

Promise<void>


replaceHistory()?​

optional replaceHistory(messages): void

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:659

Makes messages the whole conversation history. An empty array is authoritative. GMI also drops what it recorded about the turns the new history no longer holds (the details of their trace entries, the input excerpts of their sentiment records).

Parameters​

messages​

ConversationMessage[]

Returns​

void


setPersonalityTrait()?​

optional setPersonalityTrait(trait, value): void

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:691

Sets one personality trait on this instance without mutating the persona definition shared with other sessions. Used by the self-improvement adapt_personality tool. Optional so that custom IGMI implementations keep compiling; without it, personality adaptation reports that the caller could not be resolved.

Parameters​

trait​

string

Trait key, e.g. openness or honesty.

value​

number

New trait value.

Returns​

void


shutdown()​

shutdown(): Promise<void>

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:700

Returns​

Promise<void>