@codesoul-co/hypha-memory / integration-contracts

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

模块用法

用于声明并运行时校验契约。Integration contracts 模块公开 2 类、8 函数、20 接口、2 类型。

从包入口导入

import {
  DefaultMemoryActivityPort,
  MemoryContextInferenceBridge,
  createContextBuildActivityHandler,
  createDomainMemoryDependencySnapshot,
  createMemoryCacheValidityInput,
  createMemorySearchActivityHandler,
  memoryCacheValidityHash,
  memoryRecordVersionSetHash,
} from '@codesoul-co/hypha-memory';

import type {
  DefaultMemoryActivityPortOptions,
  DomainMemoryDependencySnapshot,
  InferenceContextInput,
  InferenceContextPort,
  MemoryActivityHarnessHook,
  MemoryActivityObserver,
  MemoryActivityPolicyDecision,
  MemoryActivityPolicyPort,
} from '@codesoul-co/hypha-memory';

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

使用要点

• 22 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 2 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
• 8 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
DefaultMemoryActivityPort	类	new DefaultMemoryActivityPort(options: DefaultMemoryActivityPortOptions): DefaultMemoryActivityPort	Default Memory Activity Port 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryContextInferenceBridge	类	new MemoryContextInferenceBridge(activities: MemoryActivityPort, inference: InferenceContextPort): MemoryContextInferenceBridge	Memory Context Inference Bridge 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
createContextBuildActivityHandler	函数	createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler	Create Context Build Activity Handler 函数，提供 1 个公开调用签名；参数与返回类型见下表。
createDomainMemoryDependencySnapshot	函数	createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, "dependencyHash" | "createdAt">, now?: string): DomainMemoryDependencySnapshot	Create Domain Memory Dependency Snapshot 函数，提供 1 个公开调用签名；参数与返回类型见下表。
createMemoryCacheValidityInput	函数	createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }): MemoryCacheValidityInput	Create Memory Cache Validity Input 函数，提供 1 个公开调用签名；参数与返回类型见下表。
createMemorySearchActivityHandler	函数	createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler	Create Memory Search Activity Handler 函数，提供 1 个公开调用签名；参数与返回类型见下表。
memoryCacheValidityHash	函数	memoryCacheValidityHash(input: MemoryCacheValidityInput): string	Memory Cache Validity Hash 函数，提供 1 个公开调用签名；参数与返回类型见下表。
memoryRecordVersionSetHash	函数	memoryRecordVersionSetHash(versionIds: string[]): string	Memory Record Version Set Hash 函数，提供 1 个公开调用签名；参数与返回类型见下表。
validateMemoryBindingCapabilities	函数	validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[]	Validate Memory Binding Capabilities 函数，提供 1 个公开调用签名；参数与返回类型见下表。
validateMemoryProfileCapabilities	函数	validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[]	Validate Memory Profile Capabilities 函数，提供 1 个公开调用签名；参数与返回类型见下表。
DefaultMemoryActivityPortOptions	接口	interface DefaultMemoryActivityPortOptions	Default Memory Activity Port Options 接口，共包含 4 个公开字段或方法。
DomainMemoryDependencySnapshot	接口	interface DomainMemoryDependencySnapshot	Domain Memory Dependency Snapshot 接口，共包含 10 个公开字段或方法。
InferenceContextInput	接口	interface InferenceContextInput	Inference Context Input 接口，共包含 3 个公开字段或方法。
InferenceContextPort	接口	interface InferenceContextPort	Inference Context Port 接口，共包含 1 个公开字段或方法。
MemoryActivityHarnessHook	接口	interface MemoryActivityHarnessHook	Memory Activity Harness Hook 接口，共包含 2 个公开字段或方法。
MemoryActivityObserver	接口	interface MemoryActivityObserver	Memory Activity Observer 接口，共包含 3 个公开字段或方法。
MemoryActivityPolicyDecision	接口	interface MemoryActivityPolicyDecision	Memory Activity Policy Decision 接口，共包含 3 个公开字段或方法。
MemoryActivityPolicyPort	接口	interface MemoryActivityPolicyPort	Memory Activity Policy Port 接口，共包含 1 个公开字段或方法。
MemoryActivityPort	接口	interface MemoryActivityPort	Memory Activity Port 接口，共包含 1 个公开字段或方法。
MemoryActivityRequest	接口	interface MemoryActivityRequest	Memory Activity Request 接口，共包含 9 个公开字段或方法。
MemoryActivityResult	接口	interface MemoryActivityResult	Memory Activity Result 接口，共包含 8 个公开字段或方法。
MemoryCacheInvalidation	接口	interface MemoryCacheInvalidation	Memory Cache Invalidation 接口，共包含 7 个公开字段或方法。
MemoryCacheValidityInput	接口	interface MemoryCacheValidityInput	Memory Cache Validity Input 接口，共包含 10 个公开字段或方法。
MemoryContextInferenceResult	接口	interface MemoryContextInferenceResult	Memory Context Inference Result 接口，共包含 2 个公开字段或方法。
MemoryEvaluationCase	接口	interface MemoryEvaluationCase	Memory Evaluation Case 接口，共包含 6 个公开字段或方法。
MemoryEvaluationObservation	接口	interface MemoryEvaluationObservation	Memory Evaluation Observation 接口，共包含 7 个公开字段或方法。
MemoryEvaluationPort	接口	interface MemoryEvaluationPort	Memory Evaluation Port 接口，共包含 1 个公开字段或方法。
MemoryReplayReference	接口	interface MemoryReplayReference	Memory Replay Reference 接口，共包含 7 个公开字段或方法。
SessionMemoryBinding	接口	interface SessionMemoryBinding	Session Memory Binding 接口，共包含 4 个公开字段或方法。
WorkflowStateMemoryBinding	接口	interface WorkflowStateMemoryBinding	Workflow State Memory Binding 接口，共包含 8 个公开字段或方法。
MemoryActivityHandler	类型	type MemoryActivityHandler = (request: MemoryActivityRequest, signal?: AbortSignal) => Promise<Omit<MemoryActivityResult, 'operationId'>>	Memory Activity Handler 公共类型别名；完整类型表达式见声明。
MemoryActivityOperation	类型	type MemoryActivityOperation = 'add' | 'extract' | 'search' | 'get' | 'list' | 'update' | 'write' | 'maintain' | 'delete' | 'history' | 'build_context'	Memory Activity Operation 公共类型别名；完整类型表达式见声明。

DefaultMemoryActivityPort

Default Memory Activity Port 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class DefaultMemoryActivityPort implements MemoryActivityPort {
    constructor(options: DefaultMemoryActivityPortOptions);
    register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): this;
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(options: DefaultMemoryActivityPortOptions): DefaultMemoryActivityPort	创建该类的实例。
execute	方法	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>	公开方法；参数与返回类型以签名列为准。
register	方法	register(operation: MemoryActivityOperation, handler: MemoryActivityHandler): DefaultMemoryActivityPort	公开方法；参数与返回类型以签名列为准。

MemoryContextInferenceBridge

Memory Context Inference Bridge 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class MemoryContextInferenceBridge {
    constructor(activities: MemoryActivityPort, inference: InferenceContextPort);
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryContextInferenceResult>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(activities: MemoryActivityPort, inference: InferenceContextPort): MemoryContextInferenceBridge	创建该类的实例。
execute	方法	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryContextInferenceResult>	公开方法；参数与返回类型以签名列为准。

createContextBuildActivityHandler

Create Context Build Activity Handler 函数，提供 1 个公开调用签名；参数与返回类型见下表。

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

声明

export declare function createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler;

调用签名

createContextBuildActivityHandler(builder: MemoryContextBuilder, gateway: ContextInjectionGateway): MemoryActivityHandler

参数

参数	类型	必需	说明
builder	MemoryContextBuilder	是	必需参数；接受的值由类型列定义。
gateway	ContextInjectionGateway	是	必需参数；接受的值由类型列定义。

返回值

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

createDomainMemoryDependencySnapshot

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

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

声明

export declare function createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, 'dependencyHash' | 'createdAt'>, now?: string): DomainMemoryDependencySnapshot;

调用签名

createDomainMemoryDependencySnapshot(input: Omit<DomainMemoryDependencySnapshot, "dependencyHash" | "createdAt">, now?: string): DomainMemoryDependencySnapshot

参数

参数	类型	必需	说明
input	Omit<DomainMemoryDependencySnapshot, "createdAt" | "dependencyHash">	是	必需参数；接受的值由类型列定义。
now	string	否	可选参数；接受的值由类型列定义。

返回值

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

createMemoryCacheValidityInput

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

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

声明

export declare function createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, 'scopeHash'> & {
    scope: ManagedMemoryScope;
}): MemoryCacheValidityInput;

调用签名

createMemoryCacheValidityInput(input: Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }): MemoryCacheValidityInput

参数

参数	类型	必需	说明
input	Omit<MemoryCacheValidityInput, "scopeHash"> & { scope: ManagedMemoryScope; }	是	必需参数；接受的值由类型列定义。

返回值

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

createMemorySearchActivityHandler

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

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

声明

export declare function createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler;

调用签名

createMemorySearchActivityHandler(provider: MemoryManagementProvider): MemoryActivityHandler

参数

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

返回值

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

memoryCacheValidityHash

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

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

声明

export declare function memoryCacheValidityHash(input: MemoryCacheValidityInput): string;

调用签名

memoryCacheValidityHash(input: MemoryCacheValidityInput): string

参数

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

返回值

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

memoryRecordVersionSetHash

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

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

声明

export declare function memoryRecordVersionSetHash(versionIds: string[]): string;

调用签名

memoryRecordVersionSetHash(versionIds: string[]): string

参数

参数	类型	必需	说明
versionIds	string[]	是	必需参数；接受的值由类型列定义。

返回值

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

validateMemoryBindingCapabilities

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

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

声明

export declare function validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[];

调用签名

validateMemoryBindingCapabilities(binding: WorkflowStateMemoryBinding, capabilities: MemoryManagementCapabilities): string[]

参数

参数	类型	必需	说明
binding	WorkflowStateMemoryBinding	是	必需参数；接受的值由类型列定义。
capabilities	MemoryManagementCapabilities	是	必需参数；接受的值由类型列定义。

返回值

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

validateMemoryProfileCapabilities

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

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

声明

export declare function validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[];

调用签名

validateMemoryProfileCapabilities(profile: MemoryProfileSpec, capabilities: MemoryManagementCapabilities): string[]

参数

参数	类型	必需	说明
profile	MemoryProfileSpec	是	必需参数；接受的值由类型列定义。
capabilities	MemoryManagementCapabilities	是	必需参数；接受的值由类型列定义。

返回值

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

DefaultMemoryActivityPortOptions

Default Memory Activity Port Options 接口，共包含 4 个公开字段或方法。

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

声明

export interface DefaultMemoryActivityPortOptions {
    policy: MemoryActivityPolicyPort;
    events: MemoryEventPublisher;
    harness: MemoryActivityHarnessHook;
    observers?: MemoryActivityObserver[];
}

契约成员

成员	种类	签名	说明
events	属性	events: MemoryEventPublisher	公开属性；类型、只读和可选状态以签名列为准。
harness	属性	harness: MemoryActivityHarnessHook	公开属性；类型、只读和可选状态以签名列为准。
observers	属性	observers?: MemoryActivityObserver[]	公开属性；类型、只读和可选状态以签名列为准。
policy	属性	policy: MemoryActivityPolicyPort	公开属性；类型、只读和可选状态以签名列为准。

DomainMemoryDependencySnapshot

Domain Memory Dependency Snapshot 接口，共包含 10 个公开字段或方法。

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

声明

export interface DomainMemoryDependencySnapshot {
    domainPackRef: SpecRef;
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    extractionProfileRef?: SpecRef;
    providerRefs: SpecRef[];
    policyRefs: SpecRef[];
    scopeTemplate?: Partial<ManagedMemoryScope>;
    capabilitySnapshot: Partial<MemoryManagementCapabilities>;
    dependencyHash: string;
    createdAt: string;
}

契约成员

成员	种类	签名	说明
capabilitySnapshot	属性	capabilitySnapshot: Partial<MemoryManagementCapabilities>	公开属性；类型、只读和可选状态以签名列为准。
contextProfileRef	属性	contextProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
dependencyHash	属性	dependencyHash: string	公开属性；类型、只读和可选状态以签名列为准。
domainPackRef	属性	domainPackRef: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
extractionProfileRef	属性	extractionProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
memoryProfileRef	属性	memoryProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
policyRefs	属性	policyRefs: SpecRef[]	公开属性；类型、只读和可选状态以签名列为准。
providerRefs	属性	providerRefs: SpecRef[]	公开属性；类型、只读和可选状态以签名列为准。
scopeTemplate	属性	scopeTemplate?: Partial<ManagedMemoryScope>	公开属性；类型、只读和可选状态以签名列为准。

InferenceContextInput

Inference Context Input 接口，共包含 3 个公开字段或方法。

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

声明

export interface InferenceContextInput {
    envelope: ContextEnvelope;
    contextHash: string;
    provenanceRequired: boolean;
}

契约成员

成员	种类	签名	说明
contextHash	属性	contextHash: string	公开属性；类型、只读和可选状态以签名列为准。
envelope	属性	envelope: ContextEnvelope	公开属性；类型、只读和可选状态以签名列为准。
provenanceRequired	属性	provenanceRequired: boolean	公开属性；类型、只读和可选状态以签名列为准。

InferenceContextPort

Inference Context Port 接口，共包含 1 个公开字段或方法。

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

声明

export interface InferenceContextPort<TOutput = unknown> {
    invoke(input: InferenceContextInput, signal?: AbortSignal): Promise<TOutput>;
}

契约成员

成员	种类	签名	说明
invoke	方法	invoke(input: InferenceContextInput, signal?: AbortSignal): Promise<TOutput>	公开方法；参数与返回类型以签名列为准。

MemoryActivityHarnessHook

Memory Activity Harness Hook 接口，共包含 2 个公开字段或方法。

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

声明

export interface MemoryActivityHarnessHook {
    beforeExecute(request: MemoryActivityRequest, signal: AbortSignal): void | Promise<void>;
    afterExecute(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
}

契约成员

成员	种类	签名	说明
afterExecute	方法	afterExecute(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	公开方法；参数与返回类型以签名列为准。
beforeExecute	方法	beforeExecute(request: MemoryActivityRequest, signal: AbortSignal): void | Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryActivityObserver

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

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

声明

export interface MemoryActivityObserver {
    onStarted?(request: MemoryActivityRequest): void | Promise<void>;
    onCompleted?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
    onFailed?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>;
}

契约成员

成员	种类	签名	说明
onCompleted	方法	onCompleted?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	公开方法；参数与返回类型以签名列为准。
onFailed	方法	onFailed?(request: MemoryActivityRequest, result: MemoryActivityResult): void | Promise<void>	公开方法；参数与返回类型以签名列为准。
onStarted	方法	onStarted?(request: MemoryActivityRequest): void | Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryActivityPolicyDecision

Memory Activity Policy Decision 接口，共包含 3 个公开字段或方法。

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

声明

export interface MemoryActivityPolicyDecision {
    allowed: boolean;
    reason?: string;
    policyRevision?: string;
}

契约成员

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

MemoryActivityPolicyPort

Memory Activity Policy Port 接口，共包含 1 个公开字段或方法。

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

声明

export interface MemoryActivityPolicyPort {
    authorize(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityPolicyDecision>;
}

契约成员

成员	种类	签名	说明
authorize	方法	authorize(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityPolicyDecision>	公开方法；参数与返回类型以签名列为准。

MemoryActivityPort

Memory Activity Port 接口，共包含 1 个公开字段或方法。

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

声明

export interface MemoryActivityPort {
    execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>;
}

契约成员

成员	种类	签名	说明
execute	方法	execute(request: MemoryActivityRequest, signal?: AbortSignal): Promise<MemoryActivityResult>	公开方法；参数与返回类型以签名列为准。

MemoryActivityRequest

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

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

声明

export interface MemoryActivityRequest {
    operationId: string;
    operation: MemoryActivityOperation;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: SpecRef;
    eventContext: MemoryEventContext;
    payload: unknown;
    timeoutMs?: number;
    idempotencyKey?: string;
}

契约成员

成员	种类	签名	说明
eventContext	属性	eventContext: MemoryEventContext	公开属性；类型、只读和可选状态以签名列为准。
idempotencyKey	属性	idempotencyKey?: string	公开属性；类型、只读和可选状态以签名列为准。
operation	属性	operation: MemoryActivityOperation	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
payload	属性	payload: unknown	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
timeoutMs	属性	timeoutMs?: number	公开属性；类型、只读和可选状态以签名列为准。

MemoryActivityResult

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

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

声明

export interface MemoryActivityResult {
    operationId: string;
    status: 'completed' | 'failed' | 'cancelled' | 'partial';
    memoryRefs?: string[];
    contextEnvelopeRef?: string;
    eventIds: string[];
    error?: NormalizedMemoryError;
    evidence?: MemoryProviderReturnEvidence;
    output?: unknown;
}

契约成员

成员	种类	签名	说明
contextEnvelopeRef	属性	contextEnvelopeRef?: string	公开属性；类型、只读和可选状态以签名列为准。
error	属性	error?: NormalizedMemoryError	公开属性；类型、只读和可选状态以签名列为准。
eventIds	属性	eventIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
evidence	属性	evidence?: MemoryProviderReturnEvidence	公开属性；类型、只读和可选状态以签名列为准。
memoryRefs	属性	memoryRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
output	属性	output?: unknown	公开属性；类型、只读和可选状态以签名列为准。
status	属性	status: "completed" | "cancelled" | "failed" | "partial"	公开属性；类型、只读和可选状态以签名列为准。

MemoryCacheInvalidation

Memory Cache Invalidation 接口，共包含 7 个公开字段或方法。

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

声明

export interface MemoryCacheInvalidation {
    operationId: string;
    scopeHash: string;
    reason: 'created' | 'updated' | 'invalidated' | 'deleted' | 'provider_revision';
    memoryIds: string[];
    memoryVersionIds?: string[];
    mutationGeneration: string;
    validityHash: string;
}

契约成员

成员	种类	签名	说明
memoryIds	属性	memoryIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
memoryVersionIds	属性	memoryVersionIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
mutationGeneration	属性	mutationGeneration: string	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
reason	属性	reason: "created" | "invalidated" | "deleted" | "updated" | "provider_revision"	公开属性；类型、只读和可选状态以签名列为准。
scopeHash	属性	scopeHash: string	公开属性；类型、只读和可选状态以签名列为准。
validityHash	属性	validityHash: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryCacheValidityInput

Memory Cache Validity Input 接口，共包含 10 个公开字段或方法。

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

声明

export interface MemoryCacheValidityInput {
    memoryProfileRevision: string;
    mutationGeneration: string;
    contextProfileRevision?: string;
    scopeHash: string;
    queryHash?: string;
    recordSetRevision?: string;
    selectedMemoryVersionIds?: string[];
    providerRevision?: string;
    embeddingRevision?: string;
    policyRevision?: string;
}

契约成员

成员	种类	签名	说明
contextProfileRevision	属性	contextProfileRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
embeddingRevision	属性	embeddingRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
memoryProfileRevision	属性	memoryProfileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
mutationGeneration	属性	mutationGeneration: string	公开属性；类型、只读和可选状态以签名列为准。
policyRevision	属性	policyRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
queryHash	属性	queryHash?: string	公开属性；类型、只读和可选状态以签名列为准。
recordSetRevision	属性	recordSetRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
scopeHash	属性	scopeHash: string	公开属性；类型、只读和可选状态以签名列为准。
selectedMemoryVersionIds	属性	selectedMemoryVersionIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemoryContextInferenceResult

Memory Context Inference Result 接口，共包含 2 个公开字段或方法。

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

声明

export interface MemoryContextInferenceResult<TOutput = unknown> {
    activity: MemoryActivityResult;
    inferenceOutput: TOutput;
}

契约成员

成员	种类	签名	说明
activity	属性	activity: MemoryActivityResult	公开属性；类型、只读和可选状态以签名列为准。
inferenceOutput	属性	inferenceOutput: TOutput	公开属性；类型、只读和可选状态以签名列为准。

MemoryEvaluationCase

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

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

声明

export interface MemoryEvaluationCase {
    id: string;
    category: 'extraction' | 'retrieval' | 'context' | 'lifecycle';
    inputRef: string;
    expectedRef?: string;
    metricIds: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
category	属性	category: "lifecycle" | "context" | "extraction" | "retrieval"	公开属性；类型、只读和可选状态以签名列为准。
expectedRef	属性	expectedRef?: string	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
inputRef	属性	inputRef: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
metricIds	属性	metricIds: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemoryEvaluationObservation

Memory Evaluation Observation 接口，共包含 7 个公开字段或方法。

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

声明

export interface MemoryEvaluationObservation {
    caseId: string;
    operationId: string;
    traceEventIds: string[];
    memoryVersionIds?: string[];
    retrievalSnapshotId?: string;
    contextHash?: string;
    metrics?: Record<string, number>;
}

契约成员

成员	种类	签名	说明
caseId	属性	caseId: string	公开属性；类型、只读和可选状态以签名列为准。
contextHash	属性	contextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
memoryVersionIds	属性	memoryVersionIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
metrics	属性	metrics?: Record<string, number>	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
retrievalSnapshotId	属性	retrievalSnapshotId?: string	公开属性；类型、只读和可选状态以签名列为准。
traceEventIds	属性	traceEventIds: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemoryEvaluationPort

Memory Evaluation Port 接口，共包含 1 个公开字段或方法。

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

声明

export interface MemoryEvaluationPort {
    record(observation: MemoryEvaluationObservation): Promise<void>;
}

契约成员

成员	种类	签名	说明
record	方法	record(observation: MemoryEvaluationObservation): Promise<void>	公开方法；参数与返回类型以签名列为准。

MemoryReplayReference

Memory Replay Reference 接口，共包含 7 个公开字段或方法。

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

声明

export interface MemoryReplayReference {
    operationId: string;
    profileRevision: string;
    scopeHash: string;
    eventIds: string[];
    memoryVersionIds: string[];
    retrievalSnapshotId?: string;
    contextHash?: string;
}

契约成员

成员	种类	签名	说明
contextHash	属性	contextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
eventIds	属性	eventIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
memoryVersionIds	属性	memoryVersionIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
retrievalSnapshotId	属性	retrievalSnapshotId?: string	公开属性；类型、只读和可选状态以签名列为准。
scopeHash	属性	scopeHash: string	公开属性；类型、只读和可选状态以签名列为准。

SessionMemoryBinding

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

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

声明

export interface SessionMemoryBinding {
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    memoryScopeTemplate?: Partial<ManagedMemoryScope>;
    sessionScopeMode?: 'isolated' | 'user_shared' | 'workspace_shared';
}

契约成员

成员	种类	签名	说明
contextProfileRef	属性	contextProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
memoryProfileRef	属性	memoryProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
memoryScopeTemplate	属性	memoryScopeTemplate?: Partial<ManagedMemoryScope>	公开属性；类型、只读和可选状态以签名列为准。
sessionScopeMode	属性	sessionScopeMode?: "isolated" | "user_shared" | "workspace_shared"	公开属性；类型、只读和可选状态以签名列为准。

WorkflowStateMemoryBinding

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

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

声明

export interface WorkflowStateMemoryBinding {
    memoryProfileRef?: SpecRef;
    contextProfileRef?: SpecRef;
    extractionProfileRef?: SpecRef;
    readPolicyRef?: SpecRef;
    writePolicyRef?: SpecRef;
    allowedMemoryTypes?: ManagedMemoryType[];
    memoryAccessMode?: 'none' | 'read' | 'write' | 'read_write';
    autoCapture?: boolean;
}

契约成员

成员	种类	签名	说明
allowedMemoryTypes	属性	allowedMemoryTypes?: ManagedMemoryType[]	公开属性；类型、只读和可选状态以签名列为准。
autoCapture	属性	autoCapture?: boolean	公开属性；类型、只读和可选状态以签名列为准。
contextProfileRef	属性	contextProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
extractionProfileRef	属性	extractionProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
memoryAccessMode	属性	memoryAccessMode?: "none" | "read" | "write" | "read_write"	公开属性；类型、只读和可选状态以签名列为准。
memoryProfileRef	属性	memoryProfileRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
readPolicyRef	属性	readPolicyRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。
writePolicyRef	属性	writePolicyRef?: SpecRef	公开属性；类型、只读和可选状态以签名列为准。

MemoryActivityHandler

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

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

声明

export type MemoryActivityHandler = (request: MemoryActivityRequest, signal?: AbortSignal) => Promise<Omit<MemoryActivityResult, 'operationId'>>;

MemoryActivityOperation

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

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

声明

export type MemoryActivityOperation = 'add' | 'extract' | 'search' | 'get' | 'list' | 'update' | 'write' | 'maintain' | 'delete' | 'history' | 'build_context';