Reference

Types

Primary TypeScript types exported by agentOrc.

Core types

typescripttypescript
type MemoryMetadata = Record<string, unknown>;

interface MemoryContent {
  text: string;
}

interface RememberOptions {
  agent: string;
  content: MemoryContent;
  metadata?: MemoryMetadata;
}

interface RecallOptions {
  query: string;
  topK?: number;
  threshold?: number;
  filter?: {
    agent?: string;
    includeArchived?: boolean;
  };
}

Result types

typescripttypescript
interface RecallResult {
  id: string;
  organization: string;
  agent: string;
  content: MemoryContent;
  metadata: MemoryMetadata;
  archived: boolean;
  similarity: number;
  createdAt: Date;
  updatedAt: Date;
}

interface StatsResult {
  totalMemories: number;
  totalAgents: number;
  databaseSizeBytes: number;
  embeddingModel: string;
  llmModel: string;
  organization: string;
  embeddingDimensions: number;
}