Interface IGMI

initialize

• initialize(persona, config): Promise<void>

• Parameters

  • persona: IPersonaDefinition
  • config: GMIBaseConfig

  Returns Promise<void>

getPersona

• getPersona(): IPersonaDefinition

• Returns IPersonaDefinition

getCurrentPrimaryPersonaId

• getCurrentPrimaryPersonaId(): string

• Returns string

getGMIId

• getGMIId(): string

• Returns string

getCurrentState

• getCurrentState(): GMIPrimeState

• Returns GMIPrimeState

processTurnStream

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

• Parameters

  • turnInput: GMITurnInput

  Returns AsyncGenerator<GMIOutputChunk, GMIOutput, undefined>

handleToolResult

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

• Parameters

  • toolCallId: string
  • toolName: string
  • resultPayload: ToolResultPayload
  • userId: string
  • Optional userApiKeys: Record<string, string>

  Returns Promise<GMIOutput>

Optional handleToolResults

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

• Parameters

  • toolResults: ToolCallResult[]
  • userId: string
  • Optional userApiKeys: Record<string, string>

  Returns Promise<GMIOutput>

Optional hydrateConversationHistory

• hydrateConversationHistory(conversationHistory): void

• Parameters

  • conversationHistory: ConversationMessage[]

  Returns void

Optional hydrateTurnContext

• hydrateTurnContext(context): void

• Parameters

  • context: {
        sessionId?: string;
        conversationId?: string;
        organizationId?: string;
    }

    • Optional sessionId?: string

    • Optional conversationId?: string

    • Optional organizationId?: string

  Returns void

getReasoningTrace

• getReasoningTrace(): Readonly<ReasoningTrace>

• Returns Readonly<ReasoningTrace>

getWorkingMemorySnapshot

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

• Returns Promise<Record<string, any>>

getCognitiveMemoryManager

• getCognitiveMemoryManager(): undefined | ICognitiveMemoryManager

• Returns undefined | ICognitiveMemoryManager

_triggerAndProcessSelfReflection

• _triggerAndProcessSelfReflection(): Promise<void>

• Returns Promise<void>

onMemoryLifecycleEvent

• onMemoryLifecycleEvent(event): Promise<LifecycleActionResponse>

• Parameters

  • event: MemoryLifecycleEvent

  Returns Promise<LifecycleActionResponse>

analyzeAndReportMemoryHealth

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

• Returns Promise<undefined | {
      overallStatus: "DEGRADED" | "ERROR" | "OPERATIONAL" | "LIMITED";
      workingMemoryStats?: {
          itemCount: number;
          [key: string]: any;
      };
      ragSystemStats?: {
          isHealthy: boolean;
          details?: any;
      };
      lifecycleManagerStats?: {
          isHealthy: boolean;
          details?: any;
      };
      issues?: {
          severity: "critical" | "warning" | "info";
          description: string;
          component: string;
          details?: any;
      }[];
  }>

getOverallHealth

• getOverallHealth(): Promise<GMIHealthReport>

• Returns Promise<GMIHealthReport>

shutdown

• shutdown(): Promise<void>

• Returns Promise<void>

Readonly gmiId

Readonly creationTimestamp