@codesoul-co/hypha-memory / retrieval

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

模块用法

用于使用该功能边界的公共契约与操作。Retrieval 模块公开 4 类、1 函数、14 接口、1 类型。

从包入口导入

import {
  DefaultMemoryRetrievalPipeline,
  DenseMemoryCandidateGenerator,
  KeywordMemoryCandidateGenerator,
  StructuredMemoryCandidateGenerator,
  normalizeMemoryQuery,
} from '@codesoul-co/hypha-memory';

import type {
  DefaultMemoryRetrievalPipelineOptions,
  DenseMemoryCandidateGeneratorOptions,
  MemoryCandidate,
  MemoryCandidateGenerationRequest,
  MemoryCandidateGenerator,
  MemoryMatchedFragment,
  MemoryRankingPolicySpecV2,
  MemoryRetrievalExplanation,
} from '@codesoul-co/hypha-memory';

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

使用要点

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

公共导出

Symbol	种类	签名	说明
DefaultMemoryRetrievalPipeline	类	new DefaultMemoryRetrievalPipeline(options: DefaultMemoryRetrievalPipelineOptions): DefaultMemoryRetrievalPipeline	Default Memory Retrieval Pipeline 类，共公开 3 个构造函数或成员；精确签名见本条目的声明与成员表。
DenseMemoryCandidateGenerator	类	new DenseMemoryCandidateGenerator(options: DenseMemoryCandidateGeneratorOptions): DenseMemoryCandidateGenerator	Generates scope-fenced dense candidates from the configured vector projection.
KeywordMemoryCandidateGenerator	类	new KeywordMemoryCandidateGenerator(store: ManagedMemoryRecordStore): KeywordMemoryCandidateGenerator	Keyword Memory Candidate Generator 类，共公开 4 个构造函数或成员；精确签名见本条目的声明与成员表。
StructuredMemoryCandidateGenerator	类	new StructuredMemoryCandidateGenerator(store: ManagedMemoryRecordStore): StructuredMemoryCandidateGenerator	Structured Memory Candidate Generator 类，共公开 4 个构造函数或成员；精确签名见本条目的声明与成员表。
normalizeMemoryQuery	函数	normalizeMemoryQuery(input: Omit<NormalizedMemoryQuery, "queryHash">): NormalizedMemoryQuery	Normalize Memory Query 函数，提供 1 个公开调用签名；参数与返回类型见下表。
DefaultMemoryRetrievalPipelineOptions	接口	interface DefaultMemoryRetrievalPipelineOptions	Default Memory Retrieval Pipeline Options 接口，共包含 4 个公开字段或方法。
DenseMemoryCandidateGeneratorOptions	接口	interface DenseMemoryCandidateGeneratorOptions	Dense Memory Candidate Generator Options 接口，共包含 2 个公开字段或方法。
MemoryCandidate	接口	interface MemoryCandidate	Memory Candidate 接口，共包含 8 个公开字段或方法。
MemoryCandidateGenerationRequest	接口	interface MemoryCandidateGenerationRequest	Memory Candidate Generation Request 接口，共包含 3 个公开字段或方法。
MemoryCandidateGenerator	接口	interface MemoryCandidateGenerator	Memory Candidate Generator 接口，共包含 3 个公开字段或方法。
MemoryMatchedFragment	接口	interface MemoryMatchedFragment	Memory Matched Fragment 接口，共包含 5 个公开字段或方法。
MemoryRankingPolicySpecV2	接口	interface MemoryRankingPolicySpecV2 extends MemoryRetrievalPolicySpec	Memory Ranking Policy Spec V2 接口，共包含 19 个公开字段或方法。
MemoryRetrievalExplanation	接口	interface MemoryRetrievalExplanation	Memory Retrieval Explanation 接口，共包含 8 个公开字段或方法。
MemoryRetrievalPipeline	接口	interface MemoryRetrievalPipeline	Memory Retrieval Pipeline 接口，共包含 2 个公开字段或方法。
MemoryRetrievalRequest	接口	interface MemoryRetrievalRequest	Memory Retrieval Request 接口，共包含 7 个公开字段或方法。
MemoryRetrievalResult	接口	interface MemoryRetrievalResult	Memory Retrieval Result 接口，共包含 3 个公开字段或方法。
MemoryRetrievalSnapshot	接口	interface MemoryRetrievalSnapshot	Memory Retrieval Snapshot 接口，共包含 12 个公开字段或方法。
MemorySearchFilterV2	接口	interface MemorySearchFilterV2 extends MemorySearchFilter	Memory Search Filter V2 接口，共包含 25 个公开字段或方法。
NormalizedMemoryQuery	接口	interface NormalizedMemoryQuery	Normalized Memory Query 接口，共包含 12 个公开字段或方法。
MemoryCandidateGeneratorType	类型	type MemoryCandidateGeneratorType = 'structured' | 'keyword' | 'dense' | 'sparse' | 'graph' | 'recent' | 'custom'	Memory Candidate Generator Type 公共类型别名；完整类型表达式见声明。

DefaultMemoryRetrievalPipeline

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

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

声明

export declare class DefaultMemoryRetrievalPipeline implements MemoryRetrievalPipeline {
    constructor(options: DefaultMemoryRetrievalPipelineOptions);
    retrieve(request: MemoryRetrievalRequest): Promise<MemoryRetrievalResult>;
    explain(snapshotId: string): Promise<MemoryRetrievalResult | null>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(options: DefaultMemoryRetrievalPipelineOptions): DefaultMemoryRetrievalPipeline	创建该类的实例。
explain	方法	explain(snapshotId: string): Promise<MemoryRetrievalResult | null>	公开方法；参数与返回类型以签名列为准。
retrieve	方法	retrieve(request: MemoryRetrievalRequest): Promise<MemoryRetrievalResult>	公开方法；参数与返回类型以签名列为准。

DenseMemoryCandidateGenerator

Generates scope-fenced dense candidates from the configured vector projection.

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

声明

export declare class DenseMemoryCandidateGenerator implements MemoryCandidateGenerator {
    readonly id: string;
    readonly type: "dense";
    constructor(options: DenseMemoryCandidateGeneratorOptions);
    generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(options: DenseMemoryCandidateGeneratorOptions): DenseMemoryCandidateGenerator	创建该类的实例。
generate	方法	generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	readonly type: "dense"	公开属性；类型、只读和可选状态以签名列为准。

KeywordMemoryCandidateGenerator

Keyword Memory Candidate Generator 类，共公开 4 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class KeywordMemoryCandidateGenerator implements MemoryCandidateGenerator {
    readonly id = "memory.generator.keyword";
    readonly type: "keyword";
    constructor(store: ManagedMemoryRecordStore);
    generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(store: ManagedMemoryRecordStore): KeywordMemoryCandidateGenerator	创建该类的实例。
generate	方法	generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: "memory.generator.keyword"	公开属性；类型、只读和可选状态以签名列为准。
type	属性	readonly type: "keyword"	公开属性；类型、只读和可选状态以签名列为准。

StructuredMemoryCandidateGenerator

Structured Memory Candidate Generator 类，共公开 4 个构造函数或成员；精确签名见本条目的声明与成员表。

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

声明

export declare class StructuredMemoryCandidateGenerator implements MemoryCandidateGenerator {
    readonly id = "memory.generator.structured";
    readonly type: "structured";
    constructor(store: ManagedMemoryRecordStore);
    generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>;
}

公开成员

成员	种类	签名	说明
constructor	构造函数	(store: ManagedMemoryRecordStore): StructuredMemoryCandidateGenerator	创建该类的实例。
generate	方法	generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: "memory.generator.structured"	公开属性；类型、只读和可选状态以签名列为准。
type	属性	readonly type: "structured"	公开属性；类型、只读和可选状态以签名列为准。

normalizeMemoryQuery

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

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

声明

export declare function normalizeMemoryQuery(input: Omit<NormalizedMemoryQuery, 'queryHash'>): NormalizedMemoryQuery;

调用签名

normalizeMemoryQuery(input: Omit<NormalizedMemoryQuery, "queryHash">): NormalizedMemoryQuery

参数

参数	类型	必需	说明
input	Omit<NormalizedMemoryQuery, "queryHash">	是	必需参数；接受的值由类型列定义。

返回值

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

DefaultMemoryRetrievalPipelineOptions

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

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

声明

export interface DefaultMemoryRetrievalPipelineOptions {
    recordStore: ManagedMemoryRecordStore;
    generators: MemoryCandidateGenerator[];
    rankingPolicy: MemoryRankingPolicySpecV2;
    now?: () => string;
}

契约成员

成员	种类	签名	说明
generators	属性	generators: MemoryCandidateGenerator[]	公开属性；类型、只读和可选状态以签名列为准。
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
rankingPolicy	属性	rankingPolicy: MemoryRankingPolicySpecV2	公开属性；类型、只读和可选状态以签名列为准。
recordStore	属性	recordStore: ManagedMemoryRecordStore	公开属性；类型、只读和可选状态以签名列为准。

DenseMemoryCandidateGeneratorOptions

Dense Memory Candidate Generator Options 接口，共包含 2 个公开字段或方法。

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

声明

export interface DenseMemoryCandidateGeneratorOptions {
    store: ManagedVectorStoreAdapter;
    embeddings: EmbeddingProvider;
}

契约成员

成员	种类	签名	说明
embeddings	属性	embeddings: EmbeddingProvider	公开属性；类型、只读和可选状态以签名列为准。
store	属性	store: ManagedVectorStoreAdapter	公开属性；类型、只读和可选状态以签名列为准。

MemoryCandidate

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

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

声明

export interface MemoryCandidate {
    memoryId: string;
    generatorId: string;
    generatorType?: MemoryCandidateGeneratorType;
    rawScore?: number;
    normalizedScore?: number;
    matchedFields?: string[];
    matchedFragments?: MemoryMatchedFragment[];
    reasons?: string[];
}

契约成员

成员	种类	签名	说明
generatorId	属性	generatorId: string	公开属性；类型、只读和可选状态以签名列为准。
generatorType	属性	generatorType?: MemoryCandidateGeneratorType	公开属性；类型、只读和可选状态以签名列为准。
matchedFields	属性	matchedFields?: string[]	公开属性；类型、只读和可选状态以签名列为准。
matchedFragments	属性	matchedFragments?: MemoryMatchedFragment[]	公开属性；类型、只读和可选状态以签名列为准。
memoryId	属性	memoryId: string	公开属性；类型、只读和可选状态以签名列为准。
normalizedScore	属性	normalizedScore?: number	公开属性；类型、只读和可选状态以签名列为准。
rawScore	属性	rawScore?: number	公开属性；类型、只读和可选状态以签名列为准。
reasons	属性	reasons?: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemoryCandidateGenerationRequest

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

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

声明

export interface MemoryCandidateGenerationRequest {
    query: NormalizedMemoryQuery;
    filter?: MemorySearchFilterV2;
    limit: number;
}

契约成员

成员	种类	签名	说明
filter	属性	filter?: MemorySearchFilterV2	公开属性；类型、只读和可选状态以签名列为准。
limit	属性	limit: number	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query: NormalizedMemoryQuery	公开属性；类型、只读和可选状态以签名列为准。

MemoryCandidateGenerator

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

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

声明

export interface MemoryCandidateGenerator {
    readonly id: string;
    readonly type: MemoryCandidateGeneratorType;
    generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>;
}

契约成员

成员	种类	签名	说明
generate	方法	generate(request: MemoryCandidateGenerationRequest): Promise<MemoryCandidate[]>	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: string	公开属性；类型、只读和可选状态以签名列为准。
type	属性	readonly type: MemoryCandidateGeneratorType	公开属性；类型、只读和可选状态以签名列为准。

MemoryMatchedFragment

Memory Matched Fragment 接口，共包含 5 个公开字段或方法。

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

声明

export interface MemoryMatchedFragment {
    field: string;
    text?: string;
    start?: number;
    end?: number;
    fragmentHash?: string;
}

契约成员

成员	种类	签名	说明
end	属性	end?: number	公开属性；类型、只读和可选状态以签名列为准。
field	属性	field: string	公开属性；类型、只读和可选状态以签名列为准。
fragmentHash	属性	fragmentHash?: string	公开属性；类型、只读和可选状态以签名列为准。
start	属性	start?: number	公开属性；类型、只读和可选状态以签名列为准。
text	属性	text?: string	公开属性；类型、只读和可选状态以签名列为准。

MemoryRankingPolicySpecV2

Memory Ranking Policy Spec V2 接口，共包含 19 个公开字段或方法。

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

声明

export interface MemoryRankingPolicySpecV2 extends MemoryRetrievalPolicySpec {
    normalization: 'min_max' | 'z_score' | 'rank' | 'provider_normalized';
    weights: {
        semantic?: number;
        keyword?: number;
        exact?: number;
        graph?: number;
        recency?: number;
        importance?: number;
        confidence?: number;
        authority?: number;
        verified?: number;
        reinforcement?: number;
    };
    freshnessHalfLifeSeconds?: number;
    diversity?: {
        method: 'none' | 'mmr' | 'per_entity_cap' | 'per_source_cap';
        lambda?: number;
        maxPerEntity?: number;
        maxPerSource?: number;
    };
    stableTieBreak: 'memory_id' | 'updated_at_then_id' | 'created_at_then_id';
}

契约成员

成员	种类	签名	说明
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	公开属性；类型、只读和可选状态以签名列为准。
diversity	属性	diversity?: { method: "none" | "mmr" | "per_entity_cap" | "per_source_cap"; lambda?: number; maxPerEntity?: number; maxPerSource?: number; }	公开属性；类型、只读和可选状态以签名列为准。
freshnessHalfLifeSeconds	属性	freshnessHalfLifeSeconds?: number	公开属性；类型、只读和可选状态以签名列为准。
importanceWeight	属性	importanceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
maxCandidates	属性	maxCandidates: number	公开属性；类型、只读和可选状态以签名列为准。
memoryTypePriority	属性	memoryTypePriority?: Partial<Record<ManagedMemoryType, number>>	公开属性；类型、只读和可选状态以签名列为准。
normalization	属性	normalization: "min_max" | "z_score" | "rank" | "provider_normalized"	公开属性；类型、只读和可选状态以签名列为准。
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>>	公开属性；类型、只读和可选状态以签名列为准。
stableTieBreak	属性	stableTieBreak: "memory_id" | "updated_at_then_id" | "created_at_then_id"	公开属性；类型、只读和可选状态以签名列为准。
weights	属性	weights: { semantic?: number; keyword?: number; exact?: number; graph?: number; recency?: number; importance?: number; confidence?: number; authority?: number; verified?: number; reinforcement?: number; }	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetrievalExplanation

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

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

声明

export interface MemoryRetrievalExplanation {
    memoryId: string;
    finalRank: number;
    finalScore: number;
    componentScores: Record<string, number>;
    filtersPassed: string[];
    filtersRejected?: string[];
    selectedBecause: string[];
    conflictMarkers?: string[];
}

契约成员

成员	种类	签名	说明
componentScores	属性	componentScores: Record<string, number>	公开属性；类型、只读和可选状态以签名列为准。
conflictMarkers	属性	conflictMarkers?: string[]	公开属性；类型、只读和可选状态以签名列为准。
filtersPassed	属性	filtersPassed: string[]	公开属性；类型、只读和可选状态以签名列为准。
filtersRejected	属性	filtersRejected?: string[]	公开属性；类型、只读和可选状态以签名列为准。
finalRank	属性	finalRank: number	公开属性；类型、只读和可选状态以签名列为准。
finalScore	属性	finalScore: number	公开属性；类型、只读和可选状态以签名列为准。
memoryId	属性	memoryId: string	公开属性；类型、只读和可选状态以签名列为准。
selectedBecause	属性	selectedBecause: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetrievalPipeline

Memory Retrieval Pipeline 接口，共包含 2 个公开字段或方法。

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

声明

export interface MemoryRetrievalPipeline {
    retrieve(request: MemoryRetrievalRequest): Promise<MemoryRetrievalResult>;
    explain(snapshotId: string): Promise<MemoryRetrievalResult | null>;
}

契约成员

成员	种类	签名	说明
explain	方法	explain(snapshotId: string): Promise<MemoryRetrievalResult | null>	公开方法；参数与返回类型以签名列为准。
retrieve	方法	retrieve(request: MemoryRetrievalRequest): Promise<MemoryRetrievalResult>	公开方法；参数与返回类型以签名列为准。

MemoryRetrievalRequest

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

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

声明

export interface MemoryRetrievalRequest {
    query: NormalizedMemoryQuery;
    profileRef: MemoryContractSpecRef;
    filter?: MemorySearchFilterV2;
    topK: number;
    scoreThreshold?: number;
    includeSuperseded?: boolean;
    includeInvalidated?: boolean;
}

契约成员

成员	种类	签名	说明
filter	属性	filter?: MemorySearchFilterV2	公开属性；类型、只读和可选状态以签名列为准。
includeInvalidated	属性	includeInvalidated?: boolean	公开属性；类型、只读和可选状态以签名列为准。
includeSuperseded	属性	includeSuperseded?: boolean	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query: NormalizedMemoryQuery	公开属性；类型、只读和可选状态以签名列为准。
scoreThreshold	属性	scoreThreshold?: number	公开属性；类型、只读和可选状态以签名列为准。
topK	属性	topK: number	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetrievalResult

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

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

声明

export interface MemoryRetrievalResult {
    results: ManagedMemorySearchResult[];
    snapshot: MemoryRetrievalSnapshot;
    explanations: MemoryRetrievalExplanation[];
}

契约成员

成员	种类	签名	说明
explanations	属性	explanations: MemoryRetrievalExplanation[]	公开属性；类型、只读和可选状态以签名列为准。
results	属性	results: ManagedMemorySearchResult[]	公开属性；类型、只读和可选状态以签名列为准。
snapshot	属性	snapshot: MemoryRetrievalSnapshot	公开属性；类型、只读和可选状态以签名列为准。

MemoryRetrievalSnapshot

Memory Retrieval Snapshot 接口，共包含 12 个公开字段或方法。

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

声明

export interface MemoryRetrievalSnapshot {
    id: string;
    operationId: string;
    queryHash: string;
    profileRef: MemoryContractSpecRef;
    profileRevision: string;
    filterHash: string;
    generatorIds: string[];
    candidateCount: number;
    rankingPolicyHash: string;
    rerankerRef?: MemoryContractSpecRef;
    resultMemoryIds: string[];
    createdAt: string;
}

契约成员

成员	种类	签名	说明
candidateCount	属性	candidateCount: number	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
filterHash	属性	filterHash: string	公开属性；类型、只读和可选状态以签名列为准。
generatorIds	属性	generatorIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
queryHash	属性	queryHash: string	公开属性；类型、只读和可选状态以签名列为准。
rankingPolicyHash	属性	rankingPolicyHash: string	公开属性；类型、只读和可选状态以签名列为准。
rerankerRef	属性	rerankerRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
resultMemoryIds	属性	resultMemoryIds: string[]	公开属性；类型、只读和可选状态以签名列为准。

MemorySearchFilterV2

Memory Search Filter V2 接口，共包含 25 个公开字段或方法。

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

声明

export interface MemorySearchFilterV2 extends MemorySearchFilter {
    excludeTags?: string[];
    authorities?: NonNullable<MemoryExtractionSourceRef['authority']>[];
    validAt?: string;
    validFromBefore?: string;
    validToAfter?: string;
    relationTypes?: MemoryRelation['type'][];
    legalHoldOnly?: boolean;
}

契约成员

成员	种类	签名	说明
authorities	属性	authorities?: NonNullable<"verified" | "unverified" | "user_asserted" | "system_observed" | "authoritative">[]	公开属性；类型、只读和可选状态以签名列为准。
canonicalKeys	属性	canonicalKeys?: string[]	公开属性；类型、只读和可选状态以签名列为准。
confidenceGte	属性	confidenceGte?: number	公开属性；类型、只读和可选状态以签名列为准。
conflictFreeOnly	属性	conflictFreeOnly?: boolean	公开属性；类型、只读和可选状态以签名列为准。
createdAfter	属性	createdAfter?: string	公开属性；类型、只读和可选状态以签名列为准。
createdBefore	属性	createdBefore?: string	公开属性；类型、只读和可选状态以签名列为准。
entityIds	属性	entityIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
excludeIds	属性	excludeIds?: string[]	公开属性；类型、只读和可选状态以签名列为准。
excludeTags	属性	excludeTags?: string[]	公开属性；类型、只读和可选状态以签名列为准。
expiresAfter	属性	expiresAfter?: string	公开属性；类型、只读和可选状态以签名列为准。
ids	属性	ids?: string[]	公开属性；类型、只读和可选状态以签名列为准。
importanceGte	属性	importanceGte?: number	公开属性；类型、只读和可选状态以签名列为准。
legalHoldOnly	属性	legalHoldOnly?: boolean	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
relationTypes	属性	relationTypes?: ("supports" | "contradicts" | "supersedes" | "derived_from" | "related_to" | "same_as" | "part_of")[]	公开属性；类型、只读和可选状态以签名列为准。
sourceTypes	属性	sourceTypes?: ("human_review" | "artifact" | "system" | "derived" | "user_message" | "assistant_message" | "tool_result" | "workflow_state" | "import")[]	公开属性；类型、只读和可选状态以签名列为准。
statuses	属性	statuses?: MemoryStatus[]	公开属性；类型、只读和可选状态以签名列为准。
tagsAll	属性	tagsAll?: string[]	公开属性；类型、只读和可选状态以签名列为准。
tagsAny	属性	tagsAny?: string[]	公开属性；类型、只读和可选状态以签名列为准。
updatedAfter	属性	updatedAfter?: string	公开属性；类型、只读和可选状态以签名列为准。
validAt	属性	validAt?: string	公开属性；类型、只读和可选状态以签名列为准。
validFromBefore	属性	validFromBefore?: string	公开属性；类型、只读和可选状态以签名列为准。
validToAfter	属性	validToAfter?: string	公开属性；类型、只读和可选状态以签名列为准。
verifiedOnly	属性	verifiedOnly?: boolean	公开属性；类型、只读和可选状态以签名列为准。
visibility	属性	visibility?: ("workspace" | "session" | "private" | "shared" | "tenant")[]	公开属性；类型、只读和可选状态以签名列为准。

NormalizedMemoryQuery

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

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

声明

export interface NormalizedMemoryQuery {
    operationId: string;
    scope: ManagedMemoryScope;
    principal: MemoryPrincipal;
    rawQuery?: string;
    normalizedQuery?: string;
    queryEmbedding?: number[];
    entities?: MemoryEntityRef[];
    temporalIntent?: {
        at?: string;
        from?: string;
        to?: string;
    };
    requestedTypes?: ManagedMemoryType[];
    mode?: 'structured' | 'semantic' | 'keyword' | 'hybrid' | 'graph';
    profileRevision: string;
    queryHash: string;
}

契约成员

成员	种类	签名	说明
entities	属性	entities?: MemoryEntityRef[]	公开属性；类型、只读和可选状态以签名列为准。
mode	属性	mode?: "structured" | "hybrid" | "semantic" | "keyword" | "graph"	公开属性；类型、只读和可选状态以签名列为准。
normalizedQuery	属性	normalizedQuery?: string	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
queryEmbedding	属性	queryEmbedding?: number[]	公开属性；类型、只读和可选状态以签名列为准。
queryHash	属性	queryHash: string	公开属性；类型、只读和可选状态以签名列为准。
rawQuery	属性	rawQuery?: string	公开属性；类型、只读和可选状态以签名列为准。
requestedTypes	属性	requestedTypes?: ManagedMemoryType[]	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
temporalIntent	属性	temporalIntent?: { at?: string; from?: string; to?: string; }	公开属性；类型、只读和可选状态以签名列为准。

MemoryCandidateGeneratorType

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

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

声明

export type MemoryCandidateGeneratorType = 'structured' | 'keyword' | 'dense' | 'sparse' | 'graph' | 'recent' | 'custom';