@codesoul-co/hypha-memory / recovery

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

模块用法

用于处理有界恢复、重试或降级。Recovery 模块公开 2 函数、3 接口、1 类型。

从包入口导入

import {
  adviseMemoryRecovery,
  classifyMemoryFailure,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryFailureContext,
  MemoryRecoveryAdvice,
  MemoryRecoveryScope,
  MemoryRecoveryOperation,
} from '@codesoul-co/hypha-memory';

使用要点

• 4 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 2 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
adviseMemoryRecovery	函数	adviseMemoryRecovery(failure: RecoveryFailure): MemoryRecoveryAdvice	Advise Memory Recovery 函数，提供 1 个公开调用签名；参数与返回类型见下表。
classifyMemoryFailure	函数	classifyMemoryFailure(error: unknown, context: MemoryFailureContext): RecoveryFailure	Classify Memory Failure 函数，提供 1 个公开调用签名；参数与返回类型见下表。
MemoryFailureContext	接口	interface MemoryFailureContext	Memory Failure Context 接口，共包含 13 个公开字段或方法。
MemoryRecoveryAdvice	接口	interface MemoryRecoveryAdvice	Memory Recovery Advice 接口，共包含 3 个公开字段或方法。
MemoryRecoveryScope	接口	interface MemoryRecoveryScope	Memory Recovery Scope 接口，共包含 4 个公开字段或方法。
MemoryRecoveryOperation	类型	type MemoryRecoveryOperation = 'read' | 'search' | 'write' | 'update' | 'invalidate' | 'summarize' | 'audit'	Memory Recovery Operation 公共类型别名；完整类型表达式见声明。

adviseMemoryRecovery

Advise Memory Recovery 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { adviseMemoryRecovery } from '@codesoul-co/hypha-memory';
• 源码模块: recovery

声明

export declare function adviseMemoryRecovery(failure: RecoveryFailure): MemoryRecoveryAdvice;

调用签名

adviseMemoryRecovery(failure: RecoveryFailure): MemoryRecoveryAdvice

参数

参数	类型	必需	说明
failure	RecoveryFailure	是	必需参数；接受的值由类型列定义。

返回值

• 类型: MemoryRecoveryAdvice
• 说明: 返回值契约由上述类型定义。

classifyMemoryFailure

Classify Memory Failure 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { classifyMemoryFailure } from '@codesoul-co/hypha-memory';
• 源码模块: recovery

声明

export declare function classifyMemoryFailure(error: unknown, context: MemoryFailureContext): RecoveryFailure;

调用签名

classifyMemoryFailure(error: unknown, context: MemoryFailureContext): RecoveryFailure

参数

参数	类型	必需	说明
error	unknown	是	必需参数；接受的值由类型列定义。
context	MemoryFailureContext	是	必需参数；接受的值由类型列定义。

返回值

• 类型: RecoveryFailure
• 说明: 返回值契约由上述类型定义。

MemoryFailureContext

Memory Failure Context 接口，共包含 13 个公开字段或方法。

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

声明

export interface MemoryFailureContext {
    id: string;
    operation: MemoryRecoveryOperation;
    scope: MemoryRecoveryScope;
    occurredAt?: string;
    providerId?: string;
    providerRevision?: string;
    specRevision?: string;
    policyRevision?: string;
    recordId?: string;
    idempotencyKey?: string;
    sideEffectState?: RecoverySideEffectState;
    compensationAvailable?: boolean;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
compensationAvailable	属性	compensationAvailable?: boolean	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
idempotencyKey	属性	idempotencyKey?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
occurredAt	属性	occurredAt?: string	公开属性；类型、只读和可选状态以签名列为准。
operation	属性	operation: MemoryRecoveryOperation	公开属性；类型、只读和可选状态以签名列为准。
policyRevision	属性	policyRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId?: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
recordId	属性	recordId?: string	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: MemoryRecoveryScope	公开属性；类型、只读和可选状态以签名列为准。
sideEffectState	属性	sideEffectState?: RecoverySideEffectState	公开属性；类型、只读和可选状态以签名列为准。
specRevision	属性	specRevision?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRecoveryAdvice

Memory Recovery Advice 接口，共包含 3 个公开字段或方法。

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

声明

export interface MemoryRecoveryAdvice {
    strategy: RecoveryStrategy;
    reason: string;
    allowBoundedEmptyResult: boolean;
}

契约成员

成员	种类	签名	说明
allowBoundedEmptyResult	属性	allowBoundedEmptyResult: boolean	公开属性；类型、只读和可选状态以签名列为准。
reason	属性	reason: string	公开属性；类型、只读和可选状态以签名列为准。
strategy	属性	strategy: "fail" | "retry" | "human_review" | "reconcile" | "fallback" | "degrade" | "compensate" | "wait" | "quarantine" | "cancel"	公开属性；类型、只读和可选状态以签名列为准。

MemoryRecoveryScope

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

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

声明

export interface MemoryRecoveryScope {
    workspaceId?: string;
    sessionId?: string;
    runId?: string;
    userId?: string;
}

契约成员

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

MemoryRecoveryOperation

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

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

声明

export type MemoryRecoveryOperation = 'read' | 'search' | 'write' | 'update' | 'invalidate' | 'summarize' | 'audit';