@codesoul-co/hypha-memory / contracts

• 包索引: @codesoul-co/hypha-memory
• 源码: packages/memory/src/contracts.ts
• 导出数: 30

模块用法

用于声明并运行时校验契约。Contracts 模块公开 28 接口、2 类型。

从包入口导入

import type {
  EmbeddingProviderSpec,
  ManagedMemoryRecord,
  ManagedMemoryScope,
  MemoryConflictPolicySpec,
  MemoryConsolidationPolicySpec,
  MemoryContractSpecRef,
  MemoryEntityRef,
  MemoryFallbackPolicySpec,
} from '@codesoul-co/hypha-memory';

// 完整导出列表见下方。

使用要点

• 30 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。

公共导出

Symbol	种类	签名	说明
EmbeddingProviderSpec	接口	interface EmbeddingProviderSpec	Embedding Provider Spec 接口，共包含 11 个公开字段或方法。
ManagedMemoryRecord	接口	interface ManagedMemoryRecord	Managed Memory Record 接口，共包含 38 个公开字段或方法。
ManagedMemoryScope	接口	interface ManagedMemoryScope	Managed Memory Scope 接口，共包含 8 个公开字段或方法。
MemoryConflictPolicySpec	接口	interface MemoryConflictPolicySpec	Memory Conflict Policy Spec 接口，共包含 4 个公开字段或方法。
MemoryConsolidationPolicySpec	接口	interface MemoryConsolidationPolicySpec	Memory Consolidation Policy Spec 接口，共包含 8 个公开字段或方法。
MemoryContractSpecRef	接口	interface MemoryContractSpecRef extends SpecRef	Memory Contract Spec Ref 接口，共包含 3 个公开字段或方法。
MemoryEntityRef	接口	interface MemoryEntityRef	Memory Entity Ref 接口，共包含 4 个公开字段或方法。
MemoryFallbackPolicySpec	接口	interface MemoryFallbackPolicySpec	Memory Fallback Policy Spec 接口，共包含 4 个公开字段或方法。
MemoryIndexingPolicySpec	接口	interface MemoryIndexingPolicySpec	Memory Indexing Policy Spec 接口，共包含 6 个公开字段或方法。
MemoryIndexStatus	接口	interface MemoryIndexStatus	Memory Index Status 接口，共包含 4 个公开字段或方法。
MemoryManagementCapabilities	接口	interface MemoryManagementCapabilities	Memory Management Capabilities 接口，共包含 17 个公开字段或方法。
MemoryManagementProviderSpec	接口	interface MemoryManagementProviderSpec	Memory Management Provider Spec 接口，共包含 14 个公开字段或方法。
MemoryPrincipal	接口	interface MemoryPrincipal	Memory Principal 接口，共包含 8 个公开字段或方法。
MemoryPrivacyPolicySpec	接口	interface MemoryPrivacyPolicySpec	Memory Privacy Policy Spec 接口，共包含 6 个公开字段或方法。
MemoryProfileSpec	接口	interface MemoryProfileSpec	Memory Profile Spec 接口，共包含 25 个公开字段或方法。
MemoryProvenance	接口	interface MemoryProvenance	Memory Provenance 接口，共包含 9 个公开字段或方法。
MemoryRecordStoreSpec	接口	interface MemoryRecordStoreSpec	Memory Record Store Spec 接口，共包含 10 个公开字段或方法。
MemoryRelation	接口	interface MemoryRelation	Memory Relation 接口，共包含 4 个公开字段或方法。
MemoryRetentionPolicySpec	接口	interface MemoryRetentionPolicySpec	Memory Retention Policy Spec 接口，共包含 8 个公开字段或方法。
MemoryRetrievalPolicySpec	接口	interface MemoryRetrievalPolicySpec	Memory Retrieval Policy Spec 接口，共包含 14 个公开字段或方法。
MemoryScopePolicySpec	接口	interface MemoryScopePolicySpec	Memory Scope Policy Spec 接口，共包含 7 个公开字段或方法。
MemorySource	接口	interface MemorySource	Memory Source 接口，共包含 6 个公开字段或方法。
MemoryVectorRef	接口	interface MemoryVectorRef	Memory Vector Ref 接口，共包含 8 个公开字段或方法。
MemoryWritePolicySpec	接口	interface MemoryWritePolicySpec	Memory Write Policy Spec 接口，共包含 9 个公开字段或方法。
NormalizedMemoryError	接口	interface NormalizedMemoryError	Normalized Memory Error 接口，共包含 6 个公开字段或方法。
VectorStoreCapabilities	接口	interface VectorStoreCapabilities	Vector Store Capabilities 接口，共包含 12 个公开字段或方法。
VectorStoreSpec	接口	interface VectorStoreSpec	Vector Store Spec 接口，共包含 12 个公开字段或方法。
WorkingMemoryStoreSpec	接口	interface WorkingMemoryStoreSpec	Working Memory Store Spec 接口，共包含 10 个公开字段或方法。
ManagedMemoryType	类型	type ManagedMemoryType = 'working' | 'episodic' | 'semantic' | 'procedural' | 'preference' | 'artifact' | 'governance' | 'reflection' | 'custom'	Managed Memory Type 公共类型别名；完整类型表达式见声明。
MemoryStatus	类型	type MemoryStatus = 'pending' | 'active' | 'dormant' | 'superseded' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed'	Memory Status 公共类型别名；完整类型表达式见声明。

EmbeddingProviderSpec

Embedding Provider Spec 接口，共包含 11 个公开字段或方法。

• 种类: 接口
• 导入: import type { EmbeddingProviderSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface EmbeddingProviderSpec {
    id: string;
    version: string;
    provider: string;
    model: string;
    dimensions?: number;
    normalized?: boolean;
    maxBatchSize?: number;
    maxInputTokens?: number;
    connectionRef?: string;
    timeoutMs?: number;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
connectionRef	属性	connectionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
dimensions	属性	dimensions?: number	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
maxBatchSize	属性	maxBatchSize?: number	公开属性；类型、只读和可选状态以签名列为准。
maxInputTokens	属性	maxInputTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
model	属性	model: string	公开属性；类型、只读和可选状态以签名列为准。
normalized	属性	normalized?: boolean	公开属性；类型、只读和可选状态以签名列为准。
provider	属性	provider: string	公开属性；类型、只读和可选状态以签名列为准。
timeoutMs	属性	timeoutMs?: number	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。

ManagedMemoryRecord

Managed Memory Record 接口，共包含 38 个公开字段或方法。

• 种类: 接口
• 导入: import type { ManagedMemoryRecord } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface ManagedMemoryRecord<TContent = unknown> {
    id: string;
    versionId: string;
    revision: number;
    type: ManagedMemoryType;
    subtype?: string;
    content: TContent;
    canonicalText?: string;
    summary?: string;
    language?: string;
    scope: ManagedMemoryScope;
    visibility: 'private' | 'session' | 'workspace' | 'tenant' | 'shared';
    source: MemorySource;
    provenance: MemoryProvenance;
    confidence?: number;
    importance?: number;
    strength?: number;
    salience?: number;
    accessCount: number;
    lastAccessedAt?: string;
    lastReinforcedAt?: string;
    decayScore?: number;
    status: MemoryStatus;
    immutable?: boolean;
    humanVerified?: boolean;
    sensitive?: boolean;
    tags?: string[];
    entities?: MemoryEntityRef[];
    relations?: MemoryRelation[];
    indexStatus: MemoryIndexStatus;
    vectorRefs?: MemoryVectorRef[];
    artifactRefs?: string[];
    contentHash: string;
    scopeHash: string;
    createdAt: string;
    updatedAt: string;
    expiresAt?: string;
    deletedAt?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
accessCount	属性	accessCount: number	公开属性；类型、只读和可选状态以签名列为准。
artifactRefs	属性	artifactRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
canonicalText	属性	canonicalText?: string	公开属性；类型、只读和可选状态以签名列为准。
confidence	属性	confidence?: number	公开属性；类型、只读和可选状态以签名列为准。
content	属性	content: TContent	公开属性；类型、只读和可选状态以签名列为准。
contentHash	属性	contentHash: string	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
decayScore	属性	decayScore?: number	公开属性；类型、只读和可选状态以签名列为准。
deletedAt	属性	deletedAt?: string	公开属性；类型、只读和可选状态以签名列为准。
entities	属性	entities?: MemoryEntityRef[]	公开属性；类型、只读和可选状态以签名列为准。
expiresAt	属性	expiresAt?: string	公开属性；类型、只读和可选状态以签名列为准。
humanVerified	属性	humanVerified?: boolean	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
immutable	属性	immutable?: boolean	公开属性；类型、只读和可选状态以签名列为准。
importance	属性	importance?: number	公开属性；类型、只读和可选状态以签名列为准。
indexStatus	属性	indexStatus: MemoryIndexStatus	公开属性；类型、只读和可选状态以签名列为准。
language	属性	language?: string	公开属性；类型、只读和可选状态以签名列为准。
lastAccessedAt	属性	lastAccessedAt?: string	公开属性；类型、只读和可选状态以签名列为准。
lastReinforcedAt	属性	lastReinforcedAt?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
provenance	属性	provenance: MemoryProvenance	公开属性；类型、只读和可选状态以签名列为准。
relations	属性	relations?: MemoryRelation[]	公开属性；类型、只读和可选状态以签名列为准。
revision	属性	revision: number	公开属性；类型、只读和可选状态以签名列为准。
salience	属性	salience?: number	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
scopeHash	属性	scopeHash: string	公开属性；类型、只读和可选状态以签名列为准。
sensitive	属性	sensitive?: boolean	公开属性；类型、只读和可选状态以签名列为准。
source	属性	source: MemorySource	公开属性；类型、只读和可选状态以签名列为准。
status	属性	status: MemoryStatus	公开属性；类型、只读和可选状态以签名列为准。
strength	属性	strength?: number	公开属性；类型、只读和可选状态以签名列为准。
subtype	属性	subtype?: string	公开属性；类型、只读和可选状态以签名列为准。
summary	属性	summary?: string	公开属性；类型、只读和可选状态以签名列为准。
tags	属性	tags?: string[]	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: ManagedMemoryType	公开属性；类型、只读和可选状态以签名列为准。
updatedAt	属性	updatedAt: string	公开属性；类型、只读和可选状态以签名列为准。
vectorRefs	属性	vectorRefs?: MemoryVectorRef[]	公开属性；类型、只读和可选状态以签名列为准。
versionId	属性	versionId: string	公开属性；类型、只读和可选状态以签名列为准。
visibility	属性	visibility: "workspace" | "session" | "private" | "shared" | "tenant"	公开属性；类型、只读和可选状态以签名列为准。

ManagedMemoryScope

Managed Memory Scope 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { ManagedMemoryScope } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface ManagedMemoryScope {
    tenantId?: string;
    userId: string;
    workspaceId?: string;
    projectId?: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
    domainPackId?: string;
}

契约成员

成员	种类	签名	说明
agentId	属性	agentId?: string	公开属性；类型、只读和可选状态以签名列为准。
domainPackId	属性	domainPackId?: string	公开属性；类型、只读和可选状态以签名列为准。
projectId	属性	projectId?: string	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId?: string	公开属性；类型、只读和可选状态以签名列为准。
sessionId	属性	sessionId?: string	公开属性；类型、只读和可选状态以签名列为准。
tenantId	属性	tenantId?: string	公开属性；类型、只读和可选状态以签名列为准。
userId	属性	userId: string	公开属性；类型、只读和可选状态以签名列为准。
workspaceId	属性	workspaceId?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryConflictPolicySpec

Memory Conflict Policy Spec 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryConflictPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryConflictPolicySpec {
    detectOnWrite: boolean;
    matchingMode: 'same_key' | 'semantic' | 'entity_relation' | 'custom';
    resolution: 'keep_both' | 'prefer_latest' | 'prefer_verified' | 'require_human' | 'custom';
    markRelations?: boolean;
}

契约成员

成员	种类	签名	说明
detectOnWrite	属性	detectOnWrite: boolean	公开属性；类型、只读和可选状态以签名列为准。
markRelations	属性	markRelations?: boolean	公开属性；类型、只读和可选状态以签名列为准。
matchingMode	属性	matchingMode: "custom" | "semantic" | "same_key" | "entity_relation"	公开属性；类型、只读和可选状态以签名列为准。
resolution	属性	resolution: "custom" | "prefer_latest" | "prefer_verified" | "keep_both" | "require_human"	公开属性；类型、只读和可选状态以签名列为准。

MemoryConsolidationPolicySpec

Memory Consolidation Policy Spec 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryConsolidationPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryConsolidationPolicySpec {
    enabled: boolean;
    trigger: 'scheduled' | 'count' | 'token_pressure' | 'manual';
    minRecords?: number;
    intervalSeconds?: number;
    similarityThreshold?: number;
    preserveSourceRecords?: boolean;
    summaryMemoryType?: ManagedMemoryType;
    requireVerification?: boolean;
}

契约成员

成员	种类	签名	说明
enabled	属性	enabled: boolean	公开属性；类型、只读和可选状态以签名列为准。
intervalSeconds	属性	intervalSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
minRecords	属性	minRecords?: number	公开属性；类型、只读和可选状态以签名列为准。
preserveSourceRecords	属性	preserveSourceRecords?: boolean	公开属性；类型、只读和可选状态以签名列为准。
requireVerification	属性	requireVerification?: boolean	公开属性；类型、只读和可选状态以签名列为准。
similarityThreshold	属性	similarityThreshold?: number	公开属性；类型、只读和可选状态以签名列为准。
summaryMemoryType	属性	summaryMemoryType?: ManagedMemoryType	公开属性；类型、只读和可选状态以签名列为准。
trigger	属性	trigger: "manual" | "scheduled" | "count" | "token_pressure"	公开属性；类型、只读和可选状态以签名列为准。

MemoryContractSpecRef

Memory Contract Spec Ref 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryContractSpecRef } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryContractSpecRef extends SpecRef {
    revision?: string;
}

契约成员

成员	种类	签名	说明
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
revision	属性	revision?: string	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryEntityRef

Memory Entity Ref 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryEntityRef } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryEntityRef {
    entityId: string;
    label?: string;
    type?: string;
    confidence?: number;
}

契约成员

成员	种类	签名	说明
confidence	属性	confidence?: number	公开属性；类型、只读和可选状态以签名列为准。
entityId	属性	entityId: string	公开属性；类型、只读和可选状态以签名列为准。
label	属性	label?: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryFallbackPolicySpec

Memory Fallback Policy Spec 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryFallbackPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryFallbackPolicySpec {
    onProviderUnavailable: 'fail' | 'native' | 'record_store_only' | 'skip';
    onVectorUnavailable: 'structured_only' | 'keyword' | 'fail';
    onRerankerUnavailable: 'score_fusion' | 'no_rerank' | 'fail';
    maxFallbackDepth?: number;
}

契约成员

成员	种类	签名	说明
maxFallbackDepth	属性	maxFallbackDepth?: number	公开属性；类型、只读和可选状态以签名列为准。
onProviderUnavailable	属性	onProviderUnavailable: "fail" | "native" | "record_store_only" | "skip"	公开属性；类型、只读和可选状态以签名列为准。
onRerankerUnavailable	属性	onRerankerUnavailable: "fail" | "score_fusion" | "no_rerank"	公开属性；类型、只读和可选状态以签名列为准。
onVectorUnavailable	属性	onVectorUnavailable: "fail" | "keyword" | "structured_only"	公开属性；类型、只读和可选状态以签名列为准。

MemoryIndexingPolicySpec

Memory Indexing Policy Spec 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryIndexingPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryIndexingPolicySpec {
    mode: 'sync' | 'async_outbox' | 'disabled';
    batchSize?: number;
    maxAttempts?: number;
    retryDelayMs?: number;
    deadLetterAfterAttempts?: number;
    rebuildable: boolean;
}

契约成员

成员	种类	签名	说明
batchSize	属性	batchSize?: number	公开属性；类型、只读和可选状态以签名列为准。
deadLetterAfterAttempts	属性	deadLetterAfterAttempts?: number	公开属性；类型、只读和可选状态以签名列为准。
maxAttempts	属性	maxAttempts?: number	公开属性；类型、只读和可选状态以签名列为准。
mode	属性	mode: "disabled" | "sync" | "async_outbox"	公开属性；类型、只读和可选状态以签名列为准。
rebuildable	属性	rebuildable: boolean	公开属性；类型、只读和可选状态以签名列为准。
retryDelayMs	属性	retryDelayMs?: number	公开属性；类型、只读和可选状态以签名列为准。

MemoryIndexStatus

Memory Index Status 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryIndexStatus } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryIndexStatus {
    state: 'none' | 'pending' | 'indexing' | 'indexed' | 'partial' | 'failed' | 'deleted';
    attempts: number;
    lastAttemptAt?: string;
    lastError?: NormalizedMemoryError;
}

契约成员

成员	种类	签名	说明
attempts	属性	attempts: number	公开属性；类型、只读和可选状态以签名列为准。
lastAttemptAt	属性	lastAttemptAt?: string	公开属性；类型、只读和可选状态以签名列为准。
lastError	属性	lastError?: NormalizedMemoryError	公开属性；类型、只读和可选状态以签名列为准。
state	属性	state: "none" | "failed" | "deleted" | "pending" | "indexing" | "indexed" | "partial"	公开属性；类型、只读和可选状态以签名列为准。

MemoryManagementCapabilities

Memory Management Capabilities 接口，共包含 17 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryManagementCapabilities } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryManagementCapabilities {
    add: boolean;
    search: boolean;
    get: boolean;
    list: boolean;
    update: boolean;
    delete: boolean;
    deleteByFilter: boolean;
    history: boolean;
    summarize: boolean;
    consolidate: boolean;
    decay: boolean;
    reinforce: boolean;
    conflictDetection: boolean;
    hybridSearch: boolean;
    graphRelations: boolean;
    asyncWrite: boolean;
    batchOperations: boolean;
}

契约成员

成员	种类	签名	说明
add	属性	add: boolean	公开属性；类型、只读和可选状态以签名列为准。
asyncWrite	属性	asyncWrite: boolean	公开属性；类型、只读和可选状态以签名列为准。
batchOperations	属性	batchOperations: boolean	公开属性；类型、只读和可选状态以签名列为准。
conflictDetection	属性	conflictDetection: boolean	公开属性；类型、只读和可选状态以签名列为准。
consolidate	属性	consolidate: boolean	公开属性；类型、只读和可选状态以签名列为准。
decay	属性	decay: boolean	公开属性；类型、只读和可选状态以签名列为准。
delete	属性	delete: boolean	公开属性；类型、只读和可选状态以签名列为准。
deleteByFilter	属性	deleteByFilter: boolean	公开属性；类型、只读和可选状态以签名列为准。
get	属性	get: boolean	公开属性；类型、只读和可选状态以签名列为准。
graphRelations	属性	graphRelations: boolean	公开属性；类型、只读和可选状态以签名列为准。
history	属性	history: boolean	公开属性；类型、只读和可选状态以签名列为准。
hybridSearch	属性	hybridSearch: boolean	公开属性；类型、只读和可选状态以签名列为准。
list	属性	list: boolean	公开属性；类型、只读和可选状态以签名列为准。
reinforce	属性	reinforce: boolean	公开属性；类型、只读和可选状态以签名列为准。
search	属性	search: boolean	公开属性；类型、只读和可选状态以签名列为准。
summarize	属性	summarize: boolean	公开属性；类型、只读和可选状态以签名列为准。
update	属性	update: boolean	公开属性；类型、只读和可选状态以签名列为准。

MemoryManagementProviderSpec

Memory Management Provider Spec 接口，共包含 14 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryManagementProviderSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryManagementProviderSpec {
    id: string;
    version: string;
    revision?: string;
    name?: string;
    type: 'native' | 'mem0' | 'memorybank' | 'custom';
    deployment: 'embedded' | 'local' | 'self_hosted' | 'managed' | 'remote';
    connectionRef?: string;
    config?: Record<string, unknown>;
    capabilities: MemoryManagementCapabilities;
    timeoutPolicy?: {
        timeoutMs: number;
        operationTimeouts?: Partial<Record<'add' | 'search' | 'get' | 'list' | 'update' | 'delete', number>>;
    };
    retryPolicy?: {
        maxAttempts: number;
        initialDelayMs?: number;
        maxDelayMs?: number;
        backoff?: 'fixed' | 'exponential';
    };
    circuitBreakerPolicy?: {
        failureThreshold: number;
        resetAfterMs: number;
    };
    healthCheckPolicy?: {
        intervalMs?: number;
        timeoutMs?: number;
    };
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
capabilities	属性	capabilities: MemoryManagementCapabilities	公开属性；类型、只读和可选状态以签名列为准。
circuitBreakerPolicy	属性	circuitBreakerPolicy?: { failureThreshold: number; resetAfterMs: number; }	公开属性；类型、只读和可选状态以签名列为准。
config	属性	config?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
connectionRef	属性	connectionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
deployment	属性	deployment: "local" | "self_hosted" | "managed" | "embedded" | "remote"	公开属性；类型、只读和可选状态以签名列为准。
healthCheckPolicy	属性	healthCheckPolicy?: { intervalMs?: number; timeoutMs?: number; }	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
name	属性	name?: string	公开属性；类型、只读和可选状态以签名列为准。
retryPolicy	属性	retryPolicy?: { maxAttempts: number; initialDelayMs?: number; maxDelayMs?: number; backoff?: "fixed" | "exponential"; }	公开属性；类型、只读和可选状态以签名列为准。
revision	属性	revision?: string	公开属性；类型、只读和可选状态以签名列为准。
timeoutPolicy	属性	timeoutPolicy?: { timeoutMs: number; operationTimeouts?: Partial<Record<"add" | "search" | "get" | "list" | "update" | "delete", number>>; }	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "custom" | "native" | "mem0" | "memorybank"	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryPrincipal

Memory Principal 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryPrincipal } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryPrincipal {
    principalId: string;
    type: 'user' | 'agent' | 'service' | 'system';
    tenantId?: string;
    userId?: string;
    agentId?: string;
    roles?: string[];
    permissionScopes: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
agentId	属性	agentId?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
permissionScopes	属性	permissionScopes: string[]	公开属性；类型、只读和可选状态以签名列为准。
principalId	属性	principalId: string	公开属性；类型、只读和可选状态以签名列为准。
roles	属性	roles?: string[]	公开属性；类型、只读和可选状态以签名列为准。
tenantId	属性	tenantId?: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "system" | "agent" | "user" | "service"	公开属性；类型、只读和可选状态以签名列为准。
userId	属性	userId?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryPrivacyPolicySpec

Memory Privacy Policy Spec 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryPrivacyPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryPrivacyPolicySpec {
    sensitiveDataMode: 'reject' | 'redact' | 'encrypt' | 'allow_by_policy';
    encryptionRef?: MemoryContractSpecRef;
    redactFields?: string[];
    allowCrossUserRead?: boolean;
    allowCrossWorkspaceRead?: boolean;
    complianceDelete?: boolean;
}

契约成员

成员	种类	签名	说明
allowCrossUserRead	属性	allowCrossUserRead?: boolean	公开属性；类型、只读和可选状态以签名列为准。
allowCrossWorkspaceRead	属性	allowCrossWorkspaceRead?: boolean	公开属性；类型、只读和可选状态以签名列为准。
complianceDelete	属性	complianceDelete?: boolean	公开属性；类型、只读和可选状态以签名列为准。
encryptionRef	属性	encryptionRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
redactFields	属性	redactFields?: string[]	公开属性；类型、只读和可选状态以签名列为准。
sensitiveDataMode	属性	sensitiveDataMode: "reject" | "redact" | "encrypt" | "allow_by_policy"	公开属性；类型、只读和可选状态以签名列为准。

MemoryProfileSpec

Memory Profile Spec 接口，共包含 25 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryProfileSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryProfileSpec {
    id: string;
    version: string;
    revision?: string;
    name?: string;
    description?: string;
    enabled?: boolean;
    managementProviderRef: MemoryContractSpecRef;
    workingStoreRef?: MemoryContractSpecRef;
    recordStoreRef: MemoryContractSpecRef;
    vectorStoreRefs?: MemoryContractSpecRef[];
    artifactStoreRef?: MemoryContractSpecRef;
    embeddingProviderRef?: MemoryContractSpecRef;
    rerankerProviderRef?: MemoryContractSpecRef;
    scopePolicy: MemoryScopePolicySpec;
    retrievalPolicy: MemoryRetrievalPolicySpec;
    writePolicy: MemoryWritePolicySpec;
    retentionPolicy: MemoryRetentionPolicySpec;
    consolidationPolicy?: MemoryConsolidationPolicySpec;
    conflictPolicy?: MemoryConflictPolicySpec;
    fallbackPolicy?: MemoryFallbackPolicySpec;
    privacyPolicy?: MemoryPrivacyPolicySpec;
    indexingPolicy?: MemoryIndexingPolicySpec;
    contextProfileRef?: MemoryContractSpecRef;
    tags?: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
artifactStoreRef	属性	artifactStoreRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
conflictPolicy	属性	conflictPolicy?: MemoryConflictPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
consolidationPolicy	属性	consolidationPolicy?: MemoryConsolidationPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
contextProfileRef	属性	contextProfileRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
description	属性	description?: string	公开属性；类型、只读和可选状态以签名列为准。
embeddingProviderRef	属性	embeddingProviderRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
enabled	属性	enabled?: boolean	公开属性；类型、只读和可选状态以签名列为准。
fallbackPolicy	属性	fallbackPolicy?: MemoryFallbackPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
indexingPolicy	属性	indexingPolicy?: MemoryIndexingPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
managementProviderRef	属性	managementProviderRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
name	属性	name?: string	公开属性；类型、只读和可选状态以签名列为准。
privacyPolicy	属性	privacyPolicy?: MemoryPrivacyPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
recordStoreRef	属性	recordStoreRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
rerankerProviderRef	属性	rerankerProviderRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
retentionPolicy	属性	retentionPolicy: MemoryRetentionPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
retrievalPolicy	属性	retrievalPolicy: MemoryRetrievalPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
revision	属性	revision?: string	公开属性；类型、只读和可选状态以签名列为准。
scopePolicy	属性	scopePolicy: MemoryScopePolicySpec	公开属性；类型、只读和可选状态以签名列为准。
tags	属性	tags?: string[]	公开属性；类型、只读和可选状态以签名列为准。
vectorStoreRefs	属性	vectorStoreRefs?: MemoryContractSpecRef[]	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。
workingStoreRef	属性	workingStoreRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
writePolicy	属性	writePolicy: MemoryWritePolicySpec	公开属性；类型、只读和可选状态以签名列为准。

MemoryProvenance

Memory Provenance 接口，共包含 9 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryProvenance } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryProvenance {
    createdBy: string;
    providerId: string;
    extractorVersion?: string;
    sourceEventIds?: string[];
    sourceMemoryIds?: string[];
    transformation?: string;
    humanDecisionId?: string;
    createdAt: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
createdBy	属性	createdBy: string	公开属性；类型、只读和可选状态以签名列为准。
extractorVersion	属性	extractorVersion?: string	公开属性；类型、只读和可选状态以签名列为准。
humanDecisionId	属性	humanDecisionId?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId: string	公开属性；类型、只读和可选状态以签名列为准。
sourceEventIds	属性	sourceEventIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
sourceMemoryIds	属性	sourceMemoryIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
transformation	属性	transformation?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRecordStoreSpec

Memory Record Store Spec 接口，共包含 10 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRecordStoreSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryRecordStoreSpec {
    id: string;
    version: string;
    type: 'mongodb' | 'sqlite' | 'postgres' | 'custom';
    connectionRef?: string;
    database?: string;
    collectionOrTable?: string;
    transactional?: boolean;
    historyMode?: 'embedded_versions' | 'separate_versions' | 'event_projection';
    encryptionRef?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
collectionOrTable	属性	collectionOrTable?: string	公开属性；类型、只读和可选状态以签名列为准。
connectionRef	属性	connectionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
database	属性	database?: string	公开属性；类型、只读和可选状态以签名列为准。
encryptionRef	属性	encryptionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
historyMode	属性	historyMode?: "embedded_versions" | "separate_versions" | "event_projection"	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
transactional	属性	transactional?: boolean	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "custom" | "sqlite" | "postgres" | "mongodb"	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRelation

Memory Relation 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRelation } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryRelation {
    type: 'supports' | 'contradicts' | 'supersedes' | 'derived_from' | 'related_to' | 'same_as' | 'part_of';
    targetMemoryId: string;
    confidence?: number;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
confidence	属性	confidence?: number	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
targetMemoryId	属性	targetMemoryId: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "supports" | "contradicts" | "supersedes" | "derived_from" | "related_to" | "same_as" | "part_of"	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetentionPolicySpec

Memory Retention Policy Spec 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRetentionPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryRetentionPolicySpec {
    defaultTtlSeconds?: number;
    ttlByType?: Partial<Record<ManagedMemoryType, number>>;
    archiveAfterSeconds?: number;
    deleteAfterSeconds?: number;
    retainHistory?: boolean;
    maxVersions?: number;
    legalHoldSupported?: boolean;
    deletionMode?: 'soft' | 'hard';
}

契约成员

成员	种类	签名	说明
archiveAfterSeconds	属性	archiveAfterSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
defaultTtlSeconds	属性	defaultTtlSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
deleteAfterSeconds	属性	deleteAfterSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
deletionMode	属性	deletionMode?: "soft" | "hard"	公开属性；类型、只读和可选状态以签名列为准。
legalHoldSupported	属性	legalHoldSupported?: boolean	公开属性；类型、只读和可选状态以签名列为准。
maxVersions	属性	maxVersions?: number	公开属性；类型、只读和可选状态以签名列为准。
retainHistory	属性	retainHistory?: boolean	公开属性；类型、只读和可选状态以签名列为准。
ttlByType	属性	ttlByType?: Partial<Record<ManagedMemoryType, number>>	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetrievalPolicySpec

Memory Retrieval Policy Spec 接口，共包含 14 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryRetrievalPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryRetrievalPolicySpec {
    defaultMode: 'structured' | 'semantic' | 'keyword' | 'hybrid';
    maxCandidates: number;
    defaultTopK: number;
    scoreThreshold?: number;
    memoryTypePriority?: Partial<Record<ManagedMemoryType, number>>;
    sourcePriority?: Partial<Record<MemorySource['type'], number>>;
    recencyWeight?: number;
    importanceWeight?: number;
    confidenceWeight?: number;
    reinforcementWeight?: number;
    deduplication: 'none' | 'id' | 'hash' | 'semantic';
    semanticDedupThreshold?: number;
    conflictHandling?: 'include_marked' | 'prefer_latest' | 'prefer_verified' | 'exclude_conflicts';
    rerank?: 'none' | 'score_fusion' | 'provider' | 'custom';
}

契约成员

成员	种类	签名	说明
confidenceWeight	属性	confidenceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
conflictHandling	属性	conflictHandling?: "include_marked" | "prefer_latest" | "prefer_verified" | "exclude_conflicts"	公开属性；类型、只读和可选状态以签名列为准。
deduplication	属性	deduplication: "none" | "id" | "semantic" | "hash"	公开属性；类型、只读和可选状态以签名列为准。
defaultMode	属性	defaultMode: "structured" | "hybrid" | "semantic" | "keyword"	公开属性；类型、只读和可选状态以签名列为准。
defaultTopK	属性	defaultTopK: number	公开属性；类型、只读和可选状态以签名列为准。
importanceWeight	属性	importanceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
maxCandidates	属性	maxCandidates: number	公开属性；类型、只读和可选状态以签名列为准。
memoryTypePriority	属性	memoryTypePriority?: Partial<Record<ManagedMemoryType, number>>	公开属性；类型、只读和可选状态以签名列为准。
recencyWeight	属性	recencyWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
reinforcementWeight	属性	reinforcementWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
rerank	属性	rerank?: "none" | "provider" | "custom" | "score_fusion"	公开属性；类型、只读和可选状态以签名列为准。
scoreThreshold	属性	scoreThreshold?: number	公开属性；类型、只读和可选状态以签名列为准。
semanticDedupThreshold	属性	semanticDedupThreshold?: number	公开属性；类型、只读和可选状态以签名列为准。
sourcePriority	属性	sourcePriority?: Partial<Record<"human_review" | "artifact" | "system" | "derived" | "user_message" | "assistant_message" | "tool_result" | "workflow_state" | "import", number>>	公开属性；类型、只读和可选状态以签名列为准。

MemoryScopePolicySpec

Memory Scope Policy Spec 接口，共包含 7 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryScopePolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryScopePolicySpec {
    requiredDimensions: Array<keyof ManagedMemoryScope>;
    allowedReadScopes: Array<keyof ManagedMemoryScope>;
    allowedWriteScopes: Array<keyof ManagedMemoryScope>;
    inheritanceOrder?: Array<keyof ManagedMemoryScope>;
    crossUserRead?: 'deny' | 'policy';
    crossWorkspaceRead?: 'deny' | 'policy';
    enforceTenantBoundary?: boolean;
}

契约成员

成员	种类	签名	说明
allowedReadScopes	属性	allowedReadScopes: (keyof ManagedMemoryScope)[]	公开属性；类型、只读和可选状态以签名列为准。
allowedWriteScopes	属性	allowedWriteScopes: (keyof ManagedMemoryScope)[]	公开属性；类型、只读和可选状态以签名列为准。
crossUserRead	属性	crossUserRead?: "deny" | "policy"	公开属性；类型、只读和可选状态以签名列为准。
crossWorkspaceRead	属性	crossWorkspaceRead?: "deny" | "policy"	公开属性；类型、只读和可选状态以签名列为准。
enforceTenantBoundary	属性	enforceTenantBoundary?: boolean	公开属性；类型、只读和可选状态以签名列为准。
inheritanceOrder	属性	inheritanceOrder?: (keyof ManagedMemoryScope)[]	公开属性；类型、只读和可选状态以签名列为准。
requiredDimensions	属性	requiredDimensions: (keyof ManagedMemoryScope)[]	公开属性；类型、只读和可选状态以签名列为准。

MemorySource

Memory Source 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemorySource } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemorySource {
    type: 'user_message' | 'assistant_message' | 'tool_result' | 'artifact' | 'workflow_state' | 'human_review' | 'import' | 'derived' | 'system';
    sourceId?: string;
    sourceEventId?: string;
    sourceRunId?: string;
    sourceMessageId?: string;
    sourceArtifactId?: string;
}

契约成员

成员	种类	签名	说明
sourceArtifactId	属性	sourceArtifactId?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceEventId	属性	sourceEventId?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceId	属性	sourceId?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceMessageId	属性	sourceMessageId?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceRunId	属性	sourceRunId?: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "human_review" | "artifact" | "system" | "derived" | "user_message" | "assistant_message" | "tool_result" | "workflow_state" | "import"	公开属性；类型、只读和可选状态以签名列为准。

MemoryVectorRef

Memory Vector Ref 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryVectorRef } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryVectorRef {
    vectorStoreId: string;
    indexName: string;
    vectorId: string;
    embeddingProviderId: string;
    embeddingModel: string;
    embeddingRevision?: string;
    dimensions?: number;
    indexedAt: string;
}

契约成员

成员	种类	签名	说明
dimensions	属性	dimensions?: number	公开属性；类型、只读和可选状态以签名列为准。
embeddingModel	属性	embeddingModel: string	公开属性；类型、只读和可选状态以签名列为准。
embeddingProviderId	属性	embeddingProviderId: string	公开属性；类型、只读和可选状态以签名列为准。
embeddingRevision	属性	embeddingRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
indexedAt	属性	indexedAt: string	公开属性；类型、只读和可选状态以签名列为准。
indexName	属性	indexName: string	公开属性；类型、只读和可选状态以签名列为准。
vectorId	属性	vectorId: string	公开属性；类型、只读和可选状态以签名列为准。
vectorStoreId	属性	vectorStoreId: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryWritePolicySpec

Memory Write Policy Spec 接口，共包含 9 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryWritePolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface MemoryWritePolicySpec {
    allowedTypes: ManagedMemoryType[];
    autoCaptureSources?: MemorySource['type'][];
    requireHumanVerificationFor?: ManagedMemoryType[];
    minConfidence?: number;
    deduplicateBeforeWrite?: boolean;
    conflictDetection?: boolean;
    immutableTypes?: ManagedMemoryType[];
    maxContentBytes?: number;
    sensitiveDataMode?: 'reject' | 'redact' | 'encrypt' | 'allow_by_policy';
}

契约成员

成员	种类	签名	说明
allowedTypes	属性	allowedTypes: ManagedMemoryType[]	公开属性；类型、只读和可选状态以签名列为准。
autoCaptureSources	属性	autoCaptureSources?: ("human_review" | "artifact" | "system" | "derived" | "user_message" | "assistant_message" | "tool_result" | "workflow_state" | "import")[]	公开属性；类型、只读和可选状态以签名列为准。
conflictDetection	属性	conflictDetection?: boolean	公开属性；类型、只读和可选状态以签名列为准。
deduplicateBeforeWrite	属性	deduplicateBeforeWrite?: boolean	公开属性；类型、只读和可选状态以签名列为准。
immutableTypes	属性	immutableTypes?: ManagedMemoryType[]	公开属性；类型、只读和可选状态以签名列为准。
maxContentBytes	属性	maxContentBytes?: number	公开属性；类型、只读和可选状态以签名列为准。
minConfidence	属性	minConfidence?: number	公开属性；类型、只读和可选状态以签名列为准。
requireHumanVerificationFor	属性	requireHumanVerificationFor?: ManagedMemoryType[]	公开属性；类型、只读和可选状态以签名列为准。
sensitiveDataMode	属性	sensitiveDataMode?: "reject" | "redact" | "encrypt" | "allow_by_policy"	公开属性；类型、只读和可选状态以签名列为准。

NormalizedMemoryError

Normalized Memory Error 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { NormalizedMemoryError } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface NormalizedMemoryError {
    code: 'MEMORY_INVALID_INPUT' | 'MEMORY_EXTRACTION_SOURCE_UNAVAILABLE' | 'MEMORY_EXTRACTION_FAILED' | 'MEMORY_EXTRACTION_CURSOR_CONFLICT' | 'MEMORY_MAINTENANCE_CONFLICT' | 'MEMORY_RANKING_FAILED' | 'MEMORY_IDEMPOTENCY_CONFLICT' | 'MEMORY_SCOPE_DENIED' | 'MEMORY_PERMISSION_DENIED' | 'MEMORY_NOT_FOUND' | 'MEMORY_REVISION_CONFLICT' | 'MEMORY_PROVIDER_NOT_INSTALLED' | 'MEMORY_PROVIDER_UNAVAILABLE' | 'MEMORY_PROVIDER_TIMEOUT' | 'MEMORY_STORE_UNAVAILABLE' | 'MEMORY_VECTOR_UNAVAILABLE' | 'MEMORY_INDEX_FAILED' | 'MEMORY_DELETE_PARTIAL' | 'MEMORY_POLICY_REJECTED' | 'MEMORY_CONTEXT_BUDGET_EXCEEDED' | 'MEMORY_INTERNAL_ERROR';
    message: string;
    retryable: boolean;
    providerCode?: string;
    details?: Record<string, unknown>;
    causeRef?: string;
}

契约成员

成员	种类	签名	说明
causeRef	属性	causeRef?: string	公开属性；类型、只读和可选状态以签名列为准。
code	属性	code: "MEMORY_INVALID_INPUT" | "MEMORY_EXTRACTION_SOURCE_UNAVAILABLE" | "MEMORY_EXTRACTION_FAILED" | "MEMORY_EXTRACTION_CURSOR_CONFLICT" | "MEMORY_MAINTENANCE_CONFLICT" | "MEMORY_RANKING_FAILED" | "MEMORY_IDEMPOTENCY_CONFLICT" | "MEMORY_SCOPE_DENIED" | "MEMORY_PERMISSION_DENIED" | "MEMORY_NOT_FOUND" | "MEMORY_REVISION_CONFLICT" | "MEMORY_PROVIDER_NOT_INSTALLED" | "MEMORY_PROVIDER_UNAVAILABLE" | "MEMORY_PROVIDER_TI...	公开属性；类型、只读和可选状态以签名列为准。
details	属性	details?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
message	属性	message: string	公开属性；类型、只读和可选状态以签名列为准。
providerCode	属性	providerCode?: string	公开属性；类型、只读和可选状态以签名列为准。
retryable	属性	retryable: boolean	公开属性；类型、只读和可选状态以签名列为准。

VectorStoreCapabilities

Vector Store Capabilities 接口，共包含 12 个公开字段或方法。

• 种类: 接口
• 导入: import type { VectorStoreCapabilities } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface VectorStoreCapabilities {
    denseSearch: boolean;
    sparseSearch: boolean;
    hybridSearch: boolean;
    metadataFilter: boolean;
    fullTextFilter: boolean;
    namespaces: boolean;
    multiVector: boolean;
    batchUpsert: boolean;
    deleteByFilter: boolean;
    payloadUpdate: boolean;
    scoreThreshold: boolean;
    localDeployment: boolean;
}

契约成员

成员	种类	签名	说明
batchUpsert	属性	batchUpsert: boolean	公开属性；类型、只读和可选状态以签名列为准。
deleteByFilter	属性	deleteByFilter: boolean	公开属性；类型、只读和可选状态以签名列为准。
denseSearch	属性	denseSearch: boolean	公开属性；类型、只读和可选状态以签名列为准。
fullTextFilter	属性	fullTextFilter: boolean	公开属性；类型、只读和可选状态以签名列为准。
hybridSearch	属性	hybridSearch: boolean	公开属性；类型、只读和可选状态以签名列为准。
localDeployment	属性	localDeployment: boolean	公开属性；类型、只读和可选状态以签名列为准。
metadataFilter	属性	metadataFilter: boolean	公开属性；类型、只读和可选状态以签名列为准。
multiVector	属性	multiVector: boolean	公开属性；类型、只读和可选状态以签名列为准。
namespaces	属性	namespaces: boolean	公开属性；类型、只读和可选状态以签名列为准。
payloadUpdate	属性	payloadUpdate: boolean	公开属性；类型、只读和可选状态以签名列为准。
scoreThreshold	属性	scoreThreshold: boolean	公开属性；类型、只读和可选状态以签名列为准。
sparseSearch	属性	sparseSearch: boolean	公开属性；类型、只读和可选状态以签名列为准。

VectorStoreSpec

Vector Store Spec 接口，共包含 12 个公开字段或方法。

• 种类: 接口
• 导入: import type { VectorStoreSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface VectorStoreSpec {
    id: string;
    version: string;
    type: 'local' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'pgvector' | 'custom';
    connectionRef?: string;
    collection: string;
    namespaceStrategy?: 'scope_hash' | 'metadata_filter' | 'collection_per_tenant';
    dimensions?: number;
    distance?: 'cosine' | 'dot' | 'l2';
    indexType?: string;
    capabilities: VectorStoreCapabilities;
    writeMode?: 'sync' | 'async_outbox' | 'dual_write';
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
capabilities	属性	capabilities: VectorStoreCapabilities	公开属性；类型、只读和可选状态以签名列为准。
collection	属性	collection: string	公开属性；类型、只读和可选状态以签名列为准。
connectionRef	属性	connectionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
dimensions	属性	dimensions?: number	公开属性；类型、只读和可选状态以签名列为准。
distance	属性	distance?: "cosine" | "dot" | "l2"	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
indexType	属性	indexType?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
namespaceStrategy	属性	namespaceStrategy?: "metadata_filter" | "scope_hash" | "collection_per_tenant"	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "local" | "custom" | "pgvector" | "qdrant" | "milvus" | "chroma" | "pinecone"	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。
writeMode	属性	writeMode?: "sync" | "async_outbox" | "dual_write"	公开属性；类型、只读和可选状态以签名列为准。

WorkingMemoryStoreSpec

Working Memory Store Spec 接口，共包含 10 个公开字段或方法。

• 种类: 接口
• 导入: import type { WorkingMemoryStoreSpec } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export interface WorkingMemoryStoreSpec {
    id: string;
    version: string;
    type: 'in_memory' | 'redis' | 'custom';
    connectionRef?: string;
    namespace?: string;
    defaultTtlSeconds?: number;
    maxItemBytes?: number;
    serialization?: 'json' | 'msgpack';
    encryptionRef?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
connectionRef	属性	connectionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
defaultTtlSeconds	属性	defaultTtlSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
encryptionRef	属性	encryptionRef?: string	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
maxItemBytes	属性	maxItemBytes?: number	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
namespace	属性	namespace?: string	公开属性；类型、只读和可选状态以签名列为准。
serialization	属性	serialization?: "json" | "msgpack"	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: "custom" | "redis" | "in_memory"	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。

ManagedMemoryType

Managed Memory Type 公共类型别名；完整类型表达式见声明。

• 种类: 类型
• 导入: import type { ManagedMemoryType } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export type ManagedMemoryType = 'working' | 'episodic' | 'semantic' | 'procedural' | 'preference' | 'artifact' | 'governance' | 'reflection' | 'custom';

MemoryStatus

Memory Status 公共类型别名；完整类型表达式见声明。

• 种类: 类型
• 导入: import type { MemoryStatus } from '@codesoul-co/hypha-memory';
• 源码模块: contracts

声明

export type MemoryStatus = 'pending' | 'active' | 'dormant' | 'superseded' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed';