`@codesoul-co/hypha-memory` / `lifecycle-contracts`

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

模块用法

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

从包入口导入

import type {
  EpisodicRecordInput,
  ExtractedMemoryCandidate,
  ExtractedMemoryEvidence,
  MemoryExtractionBatch,
  MemoryExtractionCursor,
  MemoryExtractionJob,
  MemoryExtractionProfileSpec,
  MemoryExtractionRequest,
} from '@codesoul-co/hypha-memory';

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

使用要点

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

公共导出

Symbol	种类	签名	说明
`EpisodicRecordInput`	接口	`interface EpisodicRecordInput`	Episodic Record Input 接口，共包含 14 个公开字段或方法。
`ExtractedMemoryCandidate`	接口	`interface ExtractedMemoryCandidate`	Extracted Memory Candidate 接口，共包含 20 个公开字段或方法。
`ExtractedMemoryEvidence`	接口	`interface ExtractedMemoryEvidence`	Extracted Memory Evidence 接口，共包含 4 个公开字段或方法。
`MemoryExtractionBatch`	接口	`interface MemoryExtractionBatch`	Memory Extraction Batch 接口，共包含 9 个公开字段或方法。
`MemoryExtractionCursor`	接口	`interface MemoryExtractionCursor`	Memory Extraction Cursor 接口，共包含 6 个公开字段或方法。
`MemoryExtractionJob`	接口	`interface MemoryExtractionJob`	Memory Extraction Job 接口，共包含 16 个公开字段或方法。
`MemoryExtractionProfileSpec`	接口	`interface MemoryExtractionProfileSpec`	Memory Extraction Profile Spec 接口，共包含 14 个公开字段或方法。
`MemoryExtractionRequest`	接口	`interface MemoryExtractionRequest`	Memory Extraction Request 接口，共包含 9 个公开字段或方法。
`MemoryExtractionSourceAdapter`	接口	`interface MemoryExtractionSourceAdapter`	Memory Extraction Source Adapter 接口，共包含 4 个公开字段或方法。
`MemoryExtractionSourceBatch`	接口	`interface MemoryExtractionSourceBatch`	Memory Extraction Source Batch 接口，共包含 3 个公开字段或方法。
`MemoryExtractionSourceRef`	接口	`interface MemoryExtractionSourceRef`	Memory Extraction Source Ref 接口，共包含 15 个公开字段或方法。
`MemoryExtractionStageSpec`	接口	`interface MemoryExtractionStageSpec`	Memory Extraction Stage Spec 接口，共包含 6 个公开字段或方法。
`MemoryExtractor`	接口	`interface MemoryExtractor`	Memory Extractor 接口，共包含 3 个公开字段或方法。
`MemoryMaintenanceApplyRequest`	接口	`interface MemoryMaintenanceApplyRequest`	Memory Maintenance Apply Request 接口，共包含 3 个公开字段或方法。
`MemoryMaintenanceDecision`	接口	`interface MemoryMaintenanceDecision`	Memory Maintenance Decision 接口，共包含 18 个公开字段或方法。
`MemoryMaintenancePlanner`	接口	`interface MemoryMaintenancePlanner`	Memory Maintenance Planner 接口，共包含 3 个公开字段或方法。
`MemoryMaintenancePlanRequest`	接口	`interface MemoryMaintenancePlanRequest`	Memory Maintenance Plan Request 接口，共包含 5 个公开字段或方法。
`MemoryMaintenancePolicySpec`	接口	`interface MemoryMaintenancePolicySpec`	Memory Maintenance Policy Spec 接口，共包含 8 个公开字段或方法。
`NormalizedExtractionInput`	接口	`interface NormalizedExtractionInput`	Normalized Extraction Input 接口，共包含 3 个公开字段或方法。
`TruthAssertion`	接口	`interface TruthAssertion`	Truth Assertion 接口，共包含 11 个公开字段或方法。
`MemoryExtractionSourceType`	类型	`type MemoryExtractionSourceType = 'conversation' \| 'truth' \| 'episodic_record' \| 'runtime_event' \| 'tool_observation' \| 'artifact' \| 'structured_record' \| 'custom'`	Memory Extraction Source Type 公共类型别名；完整类型表达式见声明。
`MemoryMaintenanceAction`	类型	`type MemoryMaintenanceAction = 'create' \| 'noop' \| 'reuse' \| 'update' \| 'merge' \| 'supersede' \| 'invalidate' \| 'reject' \| 'require_review'`	Memory Maintenance Action 公共类型别名；完整类型表达式见声明。

`EpisodicRecordInput`

Episodic Record Input 接口，共包含 14 个公开字段或方法。

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

声明

text

export interface EpisodicRecordInput {
    episodeId: string;
    title?: string;
    startAt: string;
    endAt?: string;
    actors?: string[];
    goal?: string;
    actions?: string[];
    observations?: string[];
    outcome?: unknown;
    success?: boolean;
    failureCode?: string;
    causalEventIds?: string[];
    artifactRefs?: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`actions`	属性	`actions?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`actors`	属性	`actors?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`artifactRefs`	属性	`artifactRefs?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`causalEventIds`	属性	`causalEventIds?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`endAt`	属性	`endAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`episodeId`	属性	`episodeId: string`	公开属性；类型、只读和可选状态以签名列为准。
`failureCode`	属性	`failureCode?: string`	公开属性；类型、只读和可选状态以签名列为准。
`goal`	属性	`goal?: string`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`observations`	属性	`observations?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`outcome`	属性	`outcome?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`startAt`	属性	`startAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`success`	属性	`success?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`title`	属性	`title?: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExtractedMemoryCandidate`

Extracted Memory Candidate 接口，共包含 20 个公开字段或方法。

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

声明

text

export interface ExtractedMemoryCandidate {
    candidateId: string;
    type: ManagedMemoryType;
    content: unknown;
    canonicalText: string;
    summary?: string;
    confidence: number;
    importance?: number;
    canonicalKey?: string;
    subject?: string;
    predicate?: string;
    object?: unknown;
    temporal?: {
        observedAt?: string;
        validFrom?: string;
        validTo?: string;
        temporalConfidence?: number;
    };
    entities?: MemoryEntityRef[];
    relations?: MemoryRelation[];
    sensitive?: boolean;
    authority?: MemoryExtractionSourceRef['authority'];
    evidence: ExtractedMemoryEvidence[];
    extractionRationale?: string;
    extractionProfileRevision: string;
    sourceHash: string;
}

契约成员

成员	种类	签名	说明
`authority`	属性	`authority?: "verified" \| "unverified" \| "user_asserted" \| "system_observed" \| "authoritative"`	公开属性；类型、只读和可选状态以签名列为准。
`candidateId`	属性	`candidateId: string`	公开属性；类型、只读和可选状态以签名列为准。
`canonicalKey`	属性	`canonicalKey?: string`	公开属性；类型、只读和可选状态以签名列为准。
`canonicalText`	属性	`canonicalText: string`	公开属性；类型、只读和可选状态以签名列为准。
`confidence`	属性	`confidence: number`	公开属性；类型、只读和可选状态以签名列为准。
`content`	属性	`content: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`entities`	属性	`entities?: MemoryEntityRef[]`	公开属性；类型、只读和可选状态以签名列为准。
`evidence`	属性	`evidence: ExtractedMemoryEvidence[]`	公开属性；类型、只读和可选状态以签名列为准。
`extractionProfileRevision`	属性	`extractionProfileRevision: string`	公开属性；类型、只读和可选状态以签名列为准。
`extractionRationale`	属性	`extractionRationale?: string`	公开属性；类型、只读和可选状态以签名列为准。
`importance`	属性	`importance?: number`	公开属性；类型、只读和可选状态以签名列为准。
`object`	属性	`object?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`predicate`	属性	`predicate?: string`	公开属性；类型、只读和可选状态以签名列为准。
`relations`	属性	`relations?: MemoryRelation[]`	公开属性；类型、只读和可选状态以签名列为准。
`sensitive`	属性	`sensitive?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`sourceHash`	属性	`sourceHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`subject`	属性	`subject?: string`	公开属性；类型、只读和可选状态以签名列为准。
`summary`	属性	`summary?: string`	公开属性；类型、只读和可选状态以签名列为准。
`temporal`	属性	`temporal?: { observedAt?: string; validFrom?: string; validTo?: string; temporalConfidence?: number; }`	公开属性；类型、只读和可选状态以签名列为准。
`type`	属性	`type: ManagedMemoryType`	公开属性；类型、只读和可选状态以签名列为准。

`ExtractedMemoryEvidence`

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

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

声明

text

export interface ExtractedMemoryEvidence {
    sourceRef: MemoryExtractionSourceRef;
    sourceSpan?: {
        messageId?: string;
        eventId?: string;
        artifactRef?: string;
        start?: number;
        end?: number;
        quoteHash?: string;
    };
    supportType: 'direct' | 'derived' | 'contradicting';
    confidence?: number;
}

契约成员

成员	种类	签名	说明
`confidence`	属性	`confidence?: number`	公开属性；类型、只读和可选状态以签名列为准。
`sourceRef`	属性	`sourceRef: MemoryExtractionSourceRef`	公开属性；类型、只读和可选状态以签名列为准。
`sourceSpan`	属性	`sourceSpan?: { messageId?: string; eventId?: string; artifactRef?: string; start?: number; end?: number; quoteHash?: string; }`	公开属性；类型、只读和可选状态以签名列为准。
`supportType`	属性	`supportType: "derived" \| "direct" \| "contradicting"`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionBatch`

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

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

声明

text

export interface MemoryExtractionBatch {
    id: string;
    jobId: string;
    sourceRefs: MemoryExtractionSourceRef[];
    candidates: ExtractedMemoryCandidate[];
    rejectedCandidates: MemoryRejectedItem[];
    sourceHash: string;
    extractorVersion: string;
    modelObservationRef?: string;
    createdAt: string;
}

契约成员

成员	种类	签名	说明
`candidates`	属性	`candidates: ExtractedMemoryCandidate[]`	公开属性；类型、只读和可选状态以签名列为准。
`createdAt`	属性	`createdAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`extractorVersion`	属性	`extractorVersion: string`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`jobId`	属性	`jobId: string`	公开属性；类型、只读和可选状态以签名列为准。
`modelObservationRef`	属性	`modelObservationRef?: string`	公开属性；类型、只读和可选状态以签名列为准。
`rejectedCandidates`	属性	`rejectedCandidates: MemoryRejectedItem[]`	公开属性；类型、只读和可选状态以签名列为准。
`sourceHash`	属性	`sourceHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceRefs`	属性	`sourceRefs: MemoryExtractionSourceRef[]`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionCursor`

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

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

声明

text

export interface MemoryExtractionCursor {
    sourceType: MemoryExtractionSourceType;
    sourceId: string;
    sequence?: number;
    timestamp?: string;
    sourceHash?: string;
    opaqueCursor?: string;
}

契约成员

成员	种类	签名	说明
`opaqueCursor`	属性	`opaqueCursor?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sequence`	属性	`sequence?: number`	公开属性；类型、只读和可选状态以签名列为准。
`sourceHash`	属性	`sourceHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceId`	属性	`sourceId: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceType`	属性	`sourceType: MemoryExtractionSourceType`	公开属性；类型、只读和可选状态以签名列为准。
`timestamp`	属性	`timestamp?: string`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionJob`

Memory Extraction Job 接口，共包含 16 个公开字段或方法。

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

声明

text

export interface MemoryExtractionJob {
    id: string;
    operationId: string;
    scopeHash: string;
    profileRef: MemoryContractSpecRef;
    profileRevision: string;
    sourceRefs: MemoryExtractionSourceRef[];
    status: 'queued' | 'running' | 'awaiting_review' | 'completed' | 'partial' | 'failed' | 'cancelled';
    cursorBefore?: MemoryExtractionCursor;
    cursorAfter?: MemoryExtractionCursor;
    attempts: number;
    leaseOwner?: string;
    leaseExpiresAt?: string;
    lastError?: NormalizedMemoryError;
    createdAt: string;
    startedAt?: string;
    completedAt?: string;
}

契约成员

成员	种类	签名	说明
`attempts`	属性	`attempts: number`	公开属性；类型、只读和可选状态以签名列为准。
`completedAt`	属性	`completedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`createdAt`	属性	`createdAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`cursorAfter`	属性	`cursorAfter?: MemoryExtractionCursor`	公开属性；类型、只读和可选状态以签名列为准。
`cursorBefore`	属性	`cursorBefore?: MemoryExtractionCursor`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`lastError`	属性	`lastError?: NormalizedMemoryError`	公开属性；类型、只读和可选状态以签名列为准。
`leaseExpiresAt`	属性	`leaseExpiresAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`leaseOwner`	属性	`leaseOwner?: string`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`profileRef`	属性	`profileRef: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`profileRevision`	属性	`profileRevision: string`	公开属性；类型、只读和可选状态以签名列为准。
`scopeHash`	属性	`scopeHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceRefs`	属性	`sourceRefs: MemoryExtractionSourceRef[]`	公开属性；类型、只读和可选状态以签名列为准。
`startedAt`	属性	`startedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`status`	属性	`status: "completed" \| "queued" \| "running" \| "cancelled" \| "failed" \| "partial" \| "awaiting_review"`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionProfileSpec`

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

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

声明

text

export interface MemoryExtractionProfileSpec {
    id: string;
    version: string;
    revision?: string;
    acceptedSourceTypes: MemoryExtractionSourceType[];
    outputMemoryTypes: ManagedMemoryType[];
    extractor: {
        type: 'deterministic';
        extractorRef: MemoryContractSpecRef;
    } | {
        type: 'model';
        modelProfileRef: MemoryContractSpecRef;
        promptTemplateRef: MemoryContractSpecRef;
    } | {
        type: 'provider';
        providerRef: MemoryContractSpecRef;
    } | {
        type: 'hybrid';
        stages: MemoryExtractionStageSpec[];
    };
    conversation?: {
        maxMessagesPerWindow: number;
        overlapMessages?: number;
        includeSystemMessages?: boolean;
        includeToolMessages?: boolean;
        extractionTrigger: 'each_turn' | 'window' | 'run_end' | 'session_idle' | 'manual';
    };
    episodic?: {
        boundary: 'run' | 'workflow_state' | 'task' | 'time_window' | 'custom';
        includeFailedEpisodes?: boolean;
        includeIntermediateObservations?: boolean;
    };
    truth?: {
        minimumAuthority: TruthAssertion['authority'];
        requireEvidence?: boolean;
        preserveValidityInterval?: boolean;
    };
    sensitiveDataPolicyRef?: MemoryContractSpecRef;
    candidateValidation: {
        minConfidence: number;
        requireCanonicalText: boolean;
        requireEvidence: boolean;
        maxCandidatesPerJob?: number;
        rejectInstructionLikeContent?: boolean;
    };
    writePolicyRef: MemoryContractSpecRef;
    maintenancePolicyRef: MemoryContractSpecRef;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`acceptedSourceTypes`	属性	`acceptedSourceTypes: MemoryExtractionSourceType[]`	公开属性；类型、只读和可选状态以签名列为准。
`candidateValidation`	属性	`candidateValidation: { minConfidence: number; requireCanonicalText: boolean; requireEvidence: boolean; maxCandidatesPerJob?: number; rejectInstructionLikeContent?: boolean; }`	公开属性；类型、只读和可选状态以签名列为准。
`conversation`	属性	`conversation?: { maxMessagesPerWindow: number; overlapMessages?: number; includeSystemMessages?: boolean; includeToolMessages?: boolean; extractionTrigger: "each_turn" \| "window" \| "run_end" \| "session_idle" \| "manual"; }`	公开属性；类型、只读和可选状态以签名列为准。
`episodic`	属性	`episodic?: { boundary: "run" \| "workflow_state" \| "task" \| "time_window" \| "custom"; includeFailedEpisodes?: boolean; includeIntermediateObservations?: boolean; }`	公开属性；类型、只读和可选状态以签名列为准。
`extractor`	属性	`extractor: { type: "deterministic"; extractorRef: MemoryContractSpecRef; } \| { type: "model"; modelProfileRef: MemoryContractSpecRef; promptTemplateRef: MemoryContractSpecRef; } \| { type: "provider"; providerRef: MemoryContractSpecRef; } \| { type: "hybrid"; stages: MemoryExtractionStageSpec[]; }`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`maintenancePolicyRef`	属性	`maintenancePolicyRef: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`outputMemoryTypes`	属性	`outputMemoryTypes: ManagedMemoryType[]`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sensitiveDataPolicyRef`	属性	`sensitiveDataPolicyRef?: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`truth`	属性	`truth?: { minimumAuthority: TruthAssertion["authority"]; requireEvidence?: boolean; preserveValidityInterval?: boolean; }`	公开属性；类型、只读和可选状态以签名列为准。
`version`	属性	`version: string`	公开属性；类型、只读和可选状态以签名列为准。
`writePolicyRef`	属性	`writePolicyRef: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionRequest`

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

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

声明

text

export interface MemoryExtractionRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: MemoryContractSpecRef;
    sources: MemoryExtractionSourceRef[];
    mode: 'sync' | 'async';
    force?: boolean;
    idempotencyKey?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`force`	属性	`force?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`idempotencyKey`	属性	`idempotencyKey?: string`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`mode`	属性	`mode: "sync" \| "async"`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`principal`	属性	`principal: MemoryPrincipal`	公开属性；类型、只读和可选状态以签名列为准。
`profileRef`	属性	`profileRef: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`scope`	属性	`scope: ManagedMemoryScope`	公开属性；类型、只读和可选状态以签名列为准。
`sources`	属性	`sources: MemoryExtractionSourceRef[]`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionSourceAdapter`

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

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

声明

text

export interface MemoryExtractionSourceAdapter<T = unknown> {
    readonly type: MemoryExtractionSourceType;
    load(refs: MemoryExtractionSourceRef[], cursor?: MemoryExtractionCursor): Promise<MemoryExtractionSourceBatch<T>>;
    normalize(batch: MemoryExtractionSourceBatch<T>): Promise<NormalizedExtractionInput[]>;
    health(): Promise<ProviderHealth>;
}

契约成员

成员	种类	签名	说明
`health`	方法	`health(): Promise<ProviderHealth>`	公开方法；参数与返回类型以签名列为准。
`load`	方法	`load(refs: MemoryExtractionSourceRef[], cursor?: MemoryExtractionCursor): Promise<MemoryExtractionSourceBatch<T>>`	公开方法；参数与返回类型以签名列为准。
`normalize`	方法	`normalize(batch: MemoryExtractionSourceBatch<T>): Promise<NormalizedExtractionInput[]>`	公开方法；参数与返回类型以签名列为准。
`type`	属性	`readonly type: MemoryExtractionSourceType`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionSourceBatch`

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

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

声明

text

export interface MemoryExtractionSourceBatch<T = unknown> {
    sourceRefs: MemoryExtractionSourceRef[];
    items: Array<{
        sourceRef: MemoryExtractionSourceRef;
        value: T;
    }>;
    nextCursor?: MemoryExtractionCursor;
}

契约成员

成员	种类	签名	说明
`items`	属性	`items: { sourceRef: MemoryExtractionSourceRef; value: T; }[]`	公开属性；类型、只读和可选状态以签名列为准。
`nextCursor`	属性	`nextCursor?: MemoryExtractionCursor`	公开属性；类型、只读和可选状态以签名列为准。
`sourceRefs`	属性	`sourceRefs: MemoryExtractionSourceRef[]`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionSourceRef`

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

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

声明

text

export interface MemoryExtractionSourceRef {
    type: MemoryExtractionSourceType;
    sourceId: string;
    sourceVersion?: string;
    sourceHash?: string;
    sessionId?: string;
    runId?: string;
    messageIds?: string[];
    eventIds?: string[];
    artifactRefs?: string[];
    observedAt?: string;
    validFrom?: string;
    validTo?: string;
    authority?: 'unverified' | 'user_asserted' | 'system_observed' | 'verified' | 'authoritative';
    trustScore?: number;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`artifactRefs`	属性	`artifactRefs?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`authority`	属性	`authority?: "verified" \| "unverified" \| "user_asserted" \| "system_observed" \| "authoritative"`	公开属性；类型、只读和可选状态以签名列为准。
`eventIds`	属性	`eventIds?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`messageIds`	属性	`messageIds?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`observedAt`	属性	`observedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`runId`	属性	`runId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sessionId`	属性	`sessionId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceHash`	属性	`sourceHash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceId`	属性	`sourceId: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceVersion`	属性	`sourceVersion?: string`	公开属性；类型、只读和可选状态以签名列为准。
`trustScore`	属性	`trustScore?: number`	公开属性；类型、只读和可选状态以签名列为准。
`type`	属性	`type: MemoryExtractionSourceType`	公开属性；类型、只读和可选状态以签名列为准。
`validFrom`	属性	`validFrom?: string`	公开属性；类型、只读和可选状态以签名列为准。
`validTo`	属性	`validTo?: string`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionStageSpec`

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

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

声明

text

export interface MemoryExtractionStageSpec {
    id: string;
    type: 'normalize' | 'classify' | 'extract' | 'validate' | 'enrich' | 'custom';
    handlerRef: MemoryContractSpecRef;
    optional?: boolean;
    timeoutMs?: number;
    retryPolicy?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`handlerRef`	属性	`handlerRef: MemoryContractSpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`optional`	属性	`optional?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`retryPolicy`	属性	`retryPolicy?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`timeoutMs`	属性	`timeoutMs?: number`	公开属性；类型、只读和可选状态以签名列为准。
`type`	属性	`type: "custom" \| "validate" \| "normalize" \| "classify" \| "extract" \| "enrich"`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractor`

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

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

声明

text

export interface MemoryExtractor {
    readonly id: string;
    extract(inputs: NormalizedExtractionInput[], profile: MemoryExtractionProfileSpec): Promise<ExtractedMemoryCandidate[]>;
    health(): Promise<ProviderHealth>;
}

契约成员

成员	种类	签名	说明
`extract`	方法	`extract(inputs: NormalizedExtractionInput[], profile: MemoryExtractionProfileSpec): Promise<ExtractedMemoryCandidate[]>`	公开方法；参数与返回类型以签名列为准。
`health`	方法	`health(): Promise<ProviderHealth>`	公开方法；参数与返回类型以签名列为准。
`id`	属性	`readonly id: string`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryMaintenanceApplyRequest`

Memory Maintenance Apply Request 接口，共包含 3 个公开字段或方法。

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

声明

text

export interface MemoryMaintenanceApplyRequest {
    decision: MemoryMaintenanceDecision;
    candidate: ExtractedMemoryCandidate;
    scope: ManagedMemoryScope;
}

契约成员

成员	种类	签名	说明
`candidate`	属性	`candidate: ExtractedMemoryCandidate`	公开属性；类型、只读和可选状态以签名列为准。
`decision`	属性	`decision: MemoryMaintenanceDecision`	公开属性；类型、只读和可选状态以签名列为准。
`scope`	属性	`scope: ManagedMemoryScope`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryMaintenanceDecision`

Memory Maintenance Decision 接口，共包含 18 个公开字段或方法。

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

声明

text

export interface MemoryMaintenanceDecision {
    id: string;
    operationId: string;
    candidateId: string;
    scopeHash: string;
    action: MemoryMaintenanceAction;
    targetMemoryIds: string[];
    expectedRevisions: Record<string, number>;
    duplicateScore?: number;
    conflictScore?: number;
    authorityComparison?: 'candidate_higher' | 'existing_higher' | 'equal' | 'unknown';
    mergedContent?: unknown;
    patch?: MemoryPatch;
    relationsToCreate?: MemoryRelation[];
    recordsToInvalidate?: string[];
    reasonCode: 'NEW_FACT' | 'EXACT_DUPLICATE' | 'SEMANTIC_DUPLICATE' | 'ADDITIONAL_EVIDENCE' | 'FACT_CORRECTION' | 'TEMPORAL_UPDATE' | 'AUTHORITY_OVERRIDE' | 'CONFLICT_REQUIRES_REVIEW' | 'LOW_CONFIDENCE' | 'POLICY_REJECTED' | 'CUSTOM';
    explanation?: string;
    policyRevision: string;
    createdAt: string;
}

契约成员

成员	种类	签名	说明
`action`	属性	`action: MemoryMaintenanceAction`	公开属性；类型、只读和可选状态以签名列为准。
`authorityComparison`	属性	`authorityComparison?: "unknown" \| "candidate_higher" \| "existing_higher" \| "equal"`	公开属性；类型、只读和可选状态以签名列为准。
`candidateId`	属性	`candidateId: string`	公开属性；类型、只读和可选状态以签名列为准。
`conflictScore`	属性	`conflictScore?: number`	公开属性；类型、只读和可选状态以签名列为准。
`createdAt`	属性	`createdAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`duplicateScore`	属性	`duplicateScore?: number`	公开属性；类型、只读和可选状态以签名列为准。
`expectedRevisions`	属性	`expectedRevisions: Record<string, number>`	公开属性；类型、只读和可选状态以签名列为准。
`explanation`	属性	`explanation?: string`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`mergedContent`	属性	`mergedContent?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`patch`	属性	`patch?: MemoryPatch`	公开属性；类型、只读和可选状态以签名列为准。
`policyRevision`	属性	`policyRevision: string`	公开属性；类型、只读和可选状态以签名列为准。
`reasonCode`	属性	`reasonCode: "CUSTOM" \| "NEW_FACT" \| "EXACT_DUPLICATE" \| "SEMANTIC_DUPLICATE" \| "ADDITIONAL_EVIDENCE" \| "FACT_CORRECTION" \| "TEMPORAL_UPDATE" \| "AUTHORITY_OVERRIDE" \| "CONFLICT_REQUIRES_REVIEW" \| "LOW_CONFIDENCE" \| "POLICY_REJECTED"`	公开属性；类型、只读和可选状态以签名列为准。
`recordsToInvalidate`	属性	`recordsToInvalidate?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`relationsToCreate`	属性	`relationsToCreate?: MemoryRelation[]`	公开属性；类型、只读和可选状态以签名列为准。
`scopeHash`	属性	`scopeHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`targetMemoryIds`	属性	`targetMemoryIds: string[]`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryMaintenancePlanner`

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

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

声明

text

export interface MemoryMaintenancePlanner {
    plan(request: MemoryMaintenancePlanRequest): Promise<MemoryMaintenanceDecision>;
    apply(request: MemoryMaintenanceApplyRequest): Promise<ManagedMemoryWriteResult>;
    explain(decisionId: string): Promise<MemoryMaintenanceDecision | null>;
}

契约成员

成员	种类	签名	说明
`apply`	方法	`apply(request: MemoryMaintenanceApplyRequest): Promise<ManagedMemoryWriteResult>`	公开方法；参数与返回类型以签名列为准。
`explain`	方法	`explain(decisionId: string): Promise<MemoryMaintenanceDecision \| null>`	公开方法；参数与返回类型以签名列为准。
`plan`	方法	`plan(request: MemoryMaintenancePlanRequest): Promise<MemoryMaintenanceDecision>`	公开方法；参数与返回类型以签名列为准。

`MemoryMaintenancePlanRequest`

Memory Maintenance Plan Request 接口，共包含 5 个公开字段或方法。

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

声明

text

export interface MemoryMaintenancePlanRequest {
    operationId: string;
    scope: ManagedMemoryScope;
    candidate: ExtractedMemoryCandidate;
    existingRecords: ManagedMemoryRecord[];
    policy: MemoryMaintenancePolicySpec;
}

契约成员

成员	种类	签名	说明
`candidate`	属性	`candidate: ExtractedMemoryCandidate`	公开属性；类型、只读和可选状态以签名列为准。
`existingRecords`	属性	`existingRecords: ManagedMemoryRecord<unknown>[]`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`policy`	属性	`policy: MemoryMaintenancePolicySpec`	公开属性；类型、只读和可选状态以签名列为准。
`scope`	属性	`scope: ManagedMemoryScope`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryMaintenancePolicySpec`

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

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

声明

text

export interface MemoryMaintenancePolicySpec {
    id: string;
    version: string;
    revision?: string;
    preWriteRetrieval: {
        enabled: boolean;
        exactKeyLookup: boolean;
        semanticLookup?: boolean;
        maxCandidates: number;
        semanticThreshold?: number;
        includeSuperseded?: boolean;
        includeInvalidated?: boolean;
    };
    duplicateResolution: 'reuse_existing' | 'increase_support' | 'create_version' | 'require_review';
    updateResolution: 'patch_current' | 'create_version' | 'supersede' | 'require_review';
    conflictResolution: 'keep_both_marked' | 'prefer_authoritative' | 'prefer_verified' | 'prefer_latest' | 'invalidate_old' | 'require_review';
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`conflictResolution`	属性	`conflictResolution: "prefer_latest" \| "prefer_verified" \| "require_review" \| "keep_both_marked" \| "prefer_authoritative" \| "invalidate_old"`	公开属性；类型、只读和可选状态以签名列为准。
`duplicateResolution`	属性	`duplicateResolution: "reuse_existing" \| "increase_support" \| "create_version" \| "require_review"`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`preWriteRetrieval`	属性	`preWriteRetrieval: { enabled: boolean; exactKeyLookup: boolean; semanticLookup?: boolean; maxCandidates: number; semanticThreshold?: number; includeSuperseded?: boolean; includeInvalidated?: boolean; }`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision?: string`	公开属性；类型、只读和可选状态以签名列为准。
`updateResolution`	属性	`updateResolution: "create_version" \| "require_review" \| "patch_current" \| "supersede"`	公开属性；类型、只读和可选状态以签名列为准。
`version`	属性	`version: string`	公开属性；类型、只读和可选状态以签名列为准。

`NormalizedExtractionInput`

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

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

声明

text

export interface NormalizedExtractionInput {
    sourceRef: MemoryExtractionSourceRef;
    value: unknown;
    canonicalText?: string;
}

契约成员

成员	种类	签名	说明
`canonicalText`	属性	`canonicalText?: string`	公开属性；类型、只读和可选状态以签名列为准。
`sourceRef`	属性	`sourceRef: MemoryExtractionSourceRef`	公开属性；类型、只读和可选状态以签名列为准。
`value`	属性	`value: unknown`	公开属性；类型、只读和可选状态以签名列为准。

`TruthAssertion`

Truth Assertion 接口，共包含 11 个公开字段或方法。

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

声明

text

export interface TruthAssertion {
    assertionId: string;
    subject: string;
    predicate: string;
    object: unknown;
    authority: 'user_confirmed' | 'human_reviewed' | 'system_of_record' | 'policy_defined';
    confidence: number;
    validFrom?: string;
    validTo?: string;
    supersedesAssertionId?: string;
    evidenceRefs: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`assertionId`	属性	`assertionId: string`	公开属性；类型、只读和可选状态以签名列为准。
`authority`	属性	`authority: "user_confirmed" \| "human_reviewed" \| "system_of_record" \| "policy_defined"`	公开属性；类型、只读和可选状态以签名列为准。
`confidence`	属性	`confidence: number`	公开属性；类型、只读和可选状态以签名列为准。
`evidenceRefs`	属性	`evidenceRefs: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`metadata`	属性	`metadata?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`object`	属性	`object: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`predicate`	属性	`predicate: string`	公开属性；类型、只读和可选状态以签名列为准。
`subject`	属性	`subject: string`	公开属性；类型、只读和可选状态以签名列为准。
`supersedesAssertionId`	属性	`supersedesAssertionId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`validFrom`	属性	`validFrom?: string`	公开属性；类型、只读和可选状态以签名列为准。
`validTo`	属性	`validTo?: string`	公开属性；类型、只读和可选状态以签名列为准。

`MemoryExtractionSourceType`

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

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

声明

text

export type MemoryExtractionSourceType = 'conversation' | 'truth' | 'episodic_record' | 'runtime_event' | 'tool_observation' | 'artifact' | 'structured_record' | 'custom';

`MemoryMaintenanceAction`

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

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

声明

text

export type MemoryMaintenanceAction = 'create' | 'noop' | 'reuse' | 'update' | 'merge' | 'supersede' | 'invalidate' | 'reject' | 'require_review';

@codesoul-co/hypha-memory / lifecycle-contracts ​

模块用法 ​

从包入口导入 ​

使用要点 ​

公共导出 ​

EpisodicRecordInput ​

声明 ​

契约成员 ​

ExtractedMemoryCandidate ​

声明 ​

契约成员 ​

ExtractedMemoryEvidence ​

声明 ​

契约成员 ​

MemoryExtractionBatch ​

声明 ​

契约成员 ​

MemoryExtractionCursor ​

声明 ​

契约成员 ​

MemoryExtractionJob ​

声明 ​

契约成员 ​

MemoryExtractionProfileSpec ​

声明 ​

契约成员 ​

MemoryExtractionRequest ​

声明 ​

契约成员 ​

MemoryExtractionSourceAdapter ​

声明 ​

契约成员 ​

MemoryExtractionSourceBatch ​

声明 ​

契约成员 ​

MemoryExtractionSourceRef ​

声明 ​

契约成员 ​

MemoryExtractionStageSpec ​

声明 ​

契约成员 ​

MemoryExtractor ​

声明 ​

契约成员 ​

MemoryMaintenanceApplyRequest ​

声明 ​

契约成员 ​

MemoryMaintenanceDecision ​

声明 ​

契约成员 ​

MemoryMaintenancePlanner ​

声明 ​

契约成员 ​

MemoryMaintenancePlanRequest ​

声明 ​

契约成员 ​

MemoryMaintenancePolicySpec ​

声明 ​

契约成员 ​

NormalizedExtractionInput ​

声明 ​

契约成员 ​

TruthAssertion ​

声明 ​

契约成员 ​

MemoryExtractionSourceType ​

声明 ​

MemoryMaintenanceAction ​

声明 ​

`@codesoul-co/hypha-memory` / `lifecycle-contracts`

模块用法

从包入口导入

使用要点

公共导出

`EpisodicRecordInput`

声明

契约成员

`ExtractedMemoryCandidate`

声明

契约成员

`ExtractedMemoryEvidence`

声明

契约成员

`MemoryExtractionBatch`

声明

契约成员

`MemoryExtractionCursor`

声明

契约成员

`MemoryExtractionJob`

声明

契约成员

`MemoryExtractionProfileSpec`

声明

契约成员

`MemoryExtractionRequest`

声明

契约成员

`MemoryExtractionSourceAdapter`

声明

契约成员

`MemoryExtractionSourceBatch`

声明

契约成员

`MemoryExtractionSourceRef`

声明

契约成员

`MemoryExtractionStageSpec`

声明

契约成员

`MemoryExtractor`

声明

契约成员

`MemoryMaintenanceApplyRequest`

声明

契约成员

`MemoryMaintenanceDecision`

声明

契约成员

`MemoryMaintenancePlanner`

声明

契约成员

`MemoryMaintenancePlanRequest`

声明

契约成员

`MemoryMaintenancePolicySpec`

声明

契约成员

`NormalizedExtractionInput`

声明

契约成员

`TruthAssertion`

声明

契约成员

`MemoryExtractionSourceType`

声明

`MemoryMaintenanceAction`

声明