Skip to main content

Module types

Module types 

Source
Expand description

Core types for Engram

Structs§

CreateCrossRefInput
Input for creating a cross-reference
CreateMemoryInput
Input for creating a new memory
CrossReference
Cross-reference (relation) between memories
EmbeddingConfig
Embedding model configuration
EmbeddingStatus
Embedding queue status
ListOptions
Options for listing memories
MatchInfo
Information about how a search result matched
Memory
A memory entry in the database
MemoryVersion
Memory version for history tracking
SearchOptions
Options for search operations
SearchResult
Search result with metadata
StorageConfig
Configuration for the storage engine
StorageStats
Statistics about the memory store
SyncStatus
Sync status information
UpdateMemoryInput
Input for updating a memory
WorkspaceStats
Statistics for a workspace

Enums§

DedupMode
Deduplication mode when creating memories
EdgeType
Types of edges/relationships between memories
EmbeddingState
State of embedding computation
LifecycleState
Lifecycle state for memory management (Phase 5 - ENG-37)
MemoryScope
Memory scope for isolating memories by user, session, agent, or global
MemoryTier
Memory tier for tiered storage (permanent vs ephemeral)
MemoryType
Memory type classification
RelationSource
How a relation was created
SearchStrategy
Search strategy used
SortField
Fields to sort by
SortOrder
Sort order
StorageMode
Storage mode for SQLite
Visibility
Visibility levels for memories
WorkspaceError
Workspace validation error

Constants§

MAX_WORKSPACE_LENGTH
Maximum workspace name length
RESERVED_WORKSPACES
Reserved workspace names that cannot be used

Functions§

normalize_workspace
Normalize and validate a workspace name

Type Aliases§

MemoryId
Unique identifier for a memory