Skip to content

@codesoul-co/hypha-memory / operations

模块用法

用于使用该功能边界的公共契约与操作。Operations 模块公开 20 接口。

从包入口导入

ts
import type {
  ManagedMemoryDeleteRequest,
  ManagedMemoryDeleteResult,
  ManagedMemorySearchRequest,
  ManagedMemorySearchResult,
  ManagedMemoryUpdateRequest,
  ManagedMemoryWriteResult,
  MemoryAddRequest,
  MemoryGetRequest,
} from '@codesoul-co/hypha-memory';

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

使用要点

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

公共导出

Symbol种类签名说明
ManagedMemoryDeleteRequest接口interface ManagedMemoryDeleteRequestManaged Memory Delete Request 接口,共包含 8 个公开字段或方法。
ManagedMemoryDeleteResult接口interface ManagedMemoryDeleteResultManaged Memory Delete Result 接口,共包含 6 个公开字段或方法。
ManagedMemorySearchRequest接口interface ManagedMemorySearchRequestManaged Memory Search Request 接口,共包含 20 个公开字段或方法。
ManagedMemorySearchResult接口interface ManagedMemorySearchResultManaged Memory Search Result 接口,共包含 7 个公开字段或方法。
ManagedMemoryUpdateRequest接口interface ManagedMemoryUpdateRequestManaged Memory Update Request 接口,共包含 8 个公开字段或方法。
ManagedMemoryWriteResult接口interface ManagedMemoryWriteResultManaged Memory Write Result 接口,共包含 7 个公开字段或方法。
MemoryAddRequest接口interface MemoryAddRequestMemory Add Request 接口,共包含 13 个公开字段或方法。
MemoryGetRequest接口interface MemoryGetRequestMemory Get Request 接口,共包含 5 个公开字段或方法。
MemoryHistoryRequest接口interface MemoryHistoryRequestMemory History Request 接口,共包含 5 个公开字段或方法。
MemoryIndexJobRef接口interface MemoryIndexJobRefMemory Index Job Ref 接口,共包含 2 个公开字段或方法。
MemoryListRequest接口interface MemoryListRequestMemory List Request 接口,共包含 5 个公开字段或方法。
MemoryListResult接口interface MemoryListResult extends PaginationResultMemory List Result 接口,共包含 3 个公开字段或方法。
MemoryManagementProvider接口interface MemoryManagementProviderMemory Management Provider 接口,共包含 11 个公开字段或方法。
MemoryPatch接口interface MemoryPatchMemory Patch 接口,共包含 8 个公开字段或方法。
MemoryRejectedItem接口interface MemoryRejectedItemMemory Rejected Item 接口,共包含 3 个公开字段或方法。
MemorySearchFilter接口interface MemorySearchFilterMemory Search Filter 接口,共包含 18 个公开字段或方法。
MemoryVersion接口interface MemoryVersionMemory Version 接口,共包含 4 个公开字段或方法。
PaginationRequest接口interface PaginationRequestPagination Request 接口,共包含 7 个公开字段或方法。
PaginationResult接口interface PaginationResultPagination Result 接口,共包含 2 个公开字段或方法。
ProviderHealth接口interface ProviderHealthProvider Health 接口,共包含 5 个公开字段或方法。

ManagedMemoryDeleteRequest

Managed Memory Delete Request 接口,共包含 8 个公开字段或方法。

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

声明

text
export interface ManagedMemoryDeleteRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryIds?: string[];
    filter?: MemorySearchFilter;
    mode: 'soft' | 'hard' | 'compliance';
    reason: string;
    idempotencyKey?: string;
}

契约成员

成员种类签名说明
filter属性filter?: MemorySearchFilter公开属性;类型、只读和可选状态以签名列为准。
idempotencyKey属性idempotencyKey?: string公开属性;类型、只读和可选状态以签名列为准。
memoryIds属性memoryIds?: string[]公开属性;类型、只读和可选状态以签名列为准。
mode属性mode: "soft" | "hard" | "compliance"公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
reason属性reason: string公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。

ManagedMemoryDeleteResult

Managed Memory Delete Result 接口,共包含 6 个公开字段或方法。

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

声明

text
export interface ManagedMemoryDeleteResult {
    operationId: string;
    status: 'completed' | 'partial' | 'rejected' | 'failed';
    deletedMemoryIds: string[];
    pendingProviderIds?: string[];
    events?: string[];
    warnings?: string[];
}

契约成员

成员种类签名说明
deletedMemoryIds属性deletedMemoryIds: string[]公开属性;类型、只读和可选状态以签名列为准。
events属性events?: string[]公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
pendingProviderIds属性pendingProviderIds?: string[]公开属性;类型、只读和可选状态以签名列为准。
status属性status: "completed" | "rejected" | "failed" | "partial"公开属性;类型、只读和可选状态以签名列为准。
warnings属性warnings?: string[]公开属性;类型、只读和可选状态以签名列为准。

ManagedMemorySearchRequest

Managed Memory Search Request 接口,共包含 20 个公开字段或方法。

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

声明

text
export interface ManagedMemorySearchRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: MemoryContractSpecRef;
    query?: string;
    queryEmbedding?: number[];
    filters?: MemorySearchFilter;
    memoryTypes?: ManagedMemoryType[];
    mode?: 'structured' | 'semantic' | 'keyword' | 'hybrid' | 'graph';
    topK?: number;
    scoreThreshold?: number;
    includeDormant?: boolean;
    includeSuperseded?: boolean;
    includeContent?: boolean;
    includeProvenance?: boolean;
    includeRelations?: boolean;
    rerank?: boolean;
    updateAccessStats?: boolean;
    pagination?: PaginationRequest;
    metadata?: Record<string, unknown>;
}

契约成员

成员种类签名说明
filters属性filters?: MemorySearchFilter公开属性;类型、只读和可选状态以签名列为准。
includeContent属性includeContent?: boolean公开属性;类型、只读和可选状态以签名列为准。
includeDormant属性includeDormant?: boolean公开属性;类型、只读和可选状态以签名列为准。
includeProvenance属性includeProvenance?: boolean公开属性;类型、只读和可选状态以签名列为准。
includeRelations属性includeRelations?: boolean公开属性;类型、只读和可选状态以签名列为准。
includeSuperseded属性includeSuperseded?: boolean公开属性;类型、只读和可选状态以签名列为准。
memoryTypes属性memoryTypes?: ManagedMemoryType[]公开属性;类型、只读和可选状态以签名列为准。
metadata属性metadata?: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。
mode属性mode?: "structured" | "hybrid" | "semantic" | "keyword" | "graph"公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
pagination属性pagination?: PaginationRequest公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
profileRef属性profileRef: MemoryContractSpecRef公开属性;类型、只读和可选状态以签名列为准。
query属性query?: string公开属性;类型、只读和可选状态以签名列为准。
queryEmbedding属性queryEmbedding?: number[]公开属性;类型、只读和可选状态以签名列为准。
rerank属性rerank?: boolean公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。
scoreThreshold属性scoreThreshold?: number公开属性;类型、只读和可选状态以签名列为准。
topK属性topK?: number公开属性;类型、只读和可选状态以签名列为准。
updateAccessStats属性updateAccessStats?: boolean公开属性;类型、只读和可选状态以签名列为准。

ManagedMemorySearchResult

Managed Memory Search Result 接口,共包含 7 个公开字段或方法。

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

声明

text
export interface ManagedMemorySearchResult {
    record: ManagedMemoryRecord;
    score?: number;
    semanticScore?: number;
    keywordScore?: number;
    graphScore?: number;
    rerankScore?: number;
    reasons?: string[];
}

契约成员

成员种类签名说明
graphScore属性graphScore?: number公开属性;类型、只读和可选状态以签名列为准。
keywordScore属性keywordScore?: number公开属性;类型、只读和可选状态以签名列为准。
reasons属性reasons?: string[]公开属性;类型、只读和可选状态以签名列为准。
record属性record: ManagedMemoryRecord<unknown>公开属性;类型、只读和可选状态以签名列为准。
rerankScore属性rerankScore?: number公开属性;类型、只读和可选状态以签名列为准。
score属性score?: number公开属性;类型、只读和可选状态以签名列为准。
semanticScore属性semanticScore?: number公开属性;类型、只读和可选状态以签名列为准。

ManagedMemoryUpdateRequest

Managed Memory Update Request 接口,共包含 8 个公开字段或方法。

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

声明

text
export interface ManagedMemoryUpdateRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    expectedRevision?: number;
    patch: MemoryPatch;
    reason: string;
    idempotencyKey?: string;
}

契约成员

成员种类签名说明
expectedRevision属性expectedRevision?: number公开属性;类型、只读和可选状态以签名列为准。
idempotencyKey属性idempotencyKey?: string公开属性;类型、只读和可选状态以签名列为准。
memoryId属性memoryId: string公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
patch属性patch: MemoryPatch公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
reason属性reason: string公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。

ManagedMemoryWriteResult

Managed Memory Write Result 接口,共包含 7 个公开字段或方法。

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

声明

text
export interface ManagedMemoryWriteResult {
    operationId: string;
    status: 'committed' | 'queued' | 'reused' | 'rejected' | 'partial' | 'failed';
    records: ManagedMemoryRecord[];
    rejectedItems?: MemoryRejectedItem[];
    indexJobs?: MemoryIndexJobRef[];
    events?: string[];
    warnings?: string[];
}

契约成员

成员种类签名说明
events属性events?: string[]公开属性;类型、只读和可选状态以签名列为准。
indexJobs属性indexJobs?: MemoryIndexJobRef[]公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
records属性records: ManagedMemoryRecord<unknown>[]公开属性;类型、只读和可选状态以签名列为准。
rejectedItems属性rejectedItems?: MemoryRejectedItem[]公开属性;类型、只读和可选状态以签名列为准。
status属性status: "rejected" | "queued" | "failed" | "committed" | "reused" | "partial"公开属性;类型、只读和可选状态以签名列为准。
warnings属性warnings?: string[]公开属性;类型、只读和可选状态以签名列为准。

MemoryAddRequest

Memory Add Request 接口,共包含 13 个公开字段或方法。

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

声明

text
export interface MemoryAddRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    input: unknown;
    inputType?: 'message' | 'text' | 'structured' | 'artifact_ref' | 'event_ref';
    memoryType?: ManagedMemoryType;
    source: MemorySource;
    extractionMode?: 'none' | 'native' | 'provider' | 'custom';
    writeMode?: 'sync' | 'async';
    idempotencyKey?: string;
    profileRef: MemoryContractSpecRef;
    tags?: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员种类签名说明
extractionMode属性extractionMode?: "none" | "provider" | "custom" | "native"公开属性;类型、只读和可选状态以签名列为准。
idempotencyKey属性idempotencyKey?: string公开属性;类型、只读和可选状态以签名列为准。
input属性input: unknown公开属性;类型、只读和可选状态以签名列为准。
inputType属性inputType?: "structured" | "text" | "message" | "artifact_ref" | "event_ref"公开属性;类型、只读和可选状态以签名列为准。
memoryType属性memoryType?: ManagedMemoryType公开属性;类型、只读和可选状态以签名列为准。
metadata属性metadata?: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
profileRef属性profileRef: MemoryContractSpecRef公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。
source属性source: MemorySource公开属性;类型、只读和可选状态以签名列为准。
tags属性tags?: string[]公开属性;类型、只读和可选状态以签名列为准。
writeMode属性writeMode?: "sync" | "async"公开属性;类型、只读和可选状态以签名列为准。

MemoryGetRequest

Memory Get Request 接口,共包含 5 个公开字段或方法。

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

声明

text
export interface MemoryGetRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    includeHistory?: boolean;
}

契约成员

成员种类签名说明
includeHistory属性includeHistory?: boolean公开属性;类型、只读和可选状态以签名列为准。
memoryId属性memoryId: string公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。

MemoryHistoryRequest

Memory History Request 接口,共包含 5 个公开字段或方法。

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

声明

text
export interface MemoryHistoryRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    pagination?: PaginationRequest;
}

契约成员

成员种类签名说明
memoryId属性memoryId: string公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
pagination属性pagination?: PaginationRequest公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。

MemoryIndexJobRef

Memory Index Job Ref 接口,共包含 2 个公开字段或方法。

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

声明

text
export interface MemoryIndexJobRef {
    id: string;
    state: 'pending' | 'processing' | 'completed' | 'partial' | 'failed';
}

契约成员

成员种类签名说明
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
state属性state: "completed" | "failed" | "processing" | "pending" | "partial"公开属性;类型、只读和可选状态以签名列为准。

MemoryListRequest

Memory List Request 接口,共包含 5 个公开字段或方法。

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

声明

text
export interface MemoryListRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    filter?: MemorySearchFilter;
    pagination?: PaginationRequest;
}

契约成员

成员种类签名说明
filter属性filter?: MemorySearchFilter公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
pagination属性pagination?: PaginationRequest公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: MemoryPrincipal公开属性;类型、只读和可选状态以签名列为准。
scope属性scope: ManagedMemoryScope公开属性;类型、只读和可选状态以签名列为准。

MemoryListResult

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

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

声明

text
export interface MemoryListResult extends PaginationResult {
    records: ManagedMemoryRecord[];
}

契约成员

成员种类签名说明
hasMore属性hasMore: boolean公开属性;类型、只读和可选状态以签名列为准。
nextCursor属性nextCursor?: string公开属性;类型、只读和可选状态以签名列为准。
records属性records: ManagedMemoryRecord<unknown>[]公开属性;类型、只读和可选状态以签名列为准。

MemoryManagementProvider

Memory Management Provider 接口,共包含 11 个公开字段或方法。

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

声明

text
export interface MemoryManagementProvider {
    readonly id: string;
    capabilities(): Promise<import('./contracts').MemoryManagementCapabilities>;
    add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
    get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>;
    list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>;
    update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>;
    history?(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>;
    health(): Promise<ProviderHealth>;
    close?(): Promise<void>;
}

契约成员

成员种类签名说明
add方法add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>公开方法;参数与返回类型以签名列为准。
capabilities方法capabilities(): Promise<import("./contracts").MemoryManagementCapabilities>公开方法;参数与返回类型以签名列为准。
close方法close?(): Promise<void>公开方法;参数与返回类型以签名列为准。
delete方法delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>公开方法;参数与返回类型以签名列为准。
get方法get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>公开方法;参数与返回类型以签名列为准。
health方法health(): Promise<ProviderHealth>公开方法;参数与返回类型以签名列为准。
history方法history?(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>公开方法;参数与返回类型以签名列为准。
id属性readonly id: string公开属性;类型、只读和可选状态以签名列为准。
list方法list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>公开方法;参数与返回类型以签名列为准。
search方法search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>公开方法;参数与返回类型以签名列为准。
update方法update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>公开方法;参数与返回类型以签名列为准。

MemoryPatch

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

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

声明

text
export interface MemoryPatch {
    content?: unknown;
    canonicalText?: string;
    summary?: string;
    confidence?: number;
    importance?: number;
    tags?: string[];
    status?: Exclude<MemoryStatus, 'deleted'>;
    metadata?: Record<string, unknown>;
}

契约成员

成员种类签名说明
canonicalText属性canonicalText?: string公开属性;类型、只读和可选状态以签名列为准。
confidence属性confidence?: number公开属性;类型、只读和可选状态以签名列为准。
content属性content?: unknown公开属性;类型、只读和可选状态以签名列为准。
importance属性importance?: number公开属性;类型、只读和可选状态以签名列为准。
metadata属性metadata?: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。
status属性status?: "failed" | "invalidated" | "deletion_pending" | "active" | "pending" | "superseded" | "dormant"公开属性;类型、只读和可选状态以签名列为准。
summary属性summary?: string公开属性;类型、只读和可选状态以签名列为准。
tags属性tags?: string[]公开属性;类型、只读和可选状态以签名列为准。

MemoryRejectedItem

Memory Rejected Item 接口,共包含 3 个公开字段或方法。

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

声明

text
export interface MemoryRejectedItem {
    itemId?: string;
    reason: string;
    error?: NormalizedMemoryError;
}

契约成员

成员种类签名说明
error属性error?: NormalizedMemoryError公开属性;类型、只读和可选状态以签名列为准。
itemId属性itemId?: string公开属性;类型、只读和可选状态以签名列为准。
reason属性reason: string公开属性;类型、只读和可选状态以签名列为准。

MemorySearchFilter

Memory Search Filter 接口,共包含 18 个公开字段或方法。

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

声明

text
export interface MemorySearchFilter {
    ids?: string[];
    excludeIds?: string[];
    statuses?: MemoryStatus[];
    tagsAny?: string[];
    tagsAll?: string[];
    createdAfter?: string;
    createdBefore?: string;
    updatedAfter?: string;
    expiresAfter?: string;
    confidenceGte?: number;
    importanceGte?: number;
    sourceTypes?: MemorySource['type'][];
    entityIds?: string[];
    visibility?: ManagedMemoryRecord['visibility'][];
    verifiedOnly?: boolean;
    conflictFreeOnly?: boolean;
    canonicalKeys?: string[];
    metadata?: Record<string, unknown>;
}

契约成员

成员种类签名说明
canonicalKeys属性canonicalKeys?: string[]公开属性;类型、只读和可选状态以签名列为准。
confidenceGte属性confidenceGte?: number公开属性;类型、只读和可选状态以签名列为准。
conflictFreeOnly属性conflictFreeOnly?: boolean公开属性;类型、只读和可选状态以签名列为准。
createdAfter属性createdAfter?: string公开属性;类型、只读和可选状态以签名列为准。
createdBefore属性createdBefore?: string公开属性;类型、只读和可选状态以签名列为准。
entityIds属性entityIds?: string[]公开属性;类型、只读和可选状态以签名列为准。
excludeIds属性excludeIds?: string[]公开属性;类型、只读和可选状态以签名列为准。
expiresAfter属性expiresAfter?: string公开属性;类型、只读和可选状态以签名列为准。
ids属性ids?: string[]公开属性;类型、只读和可选状态以签名列为准。
importanceGte属性importanceGte?: number公开属性;类型、只读和可选状态以签名列为准。
metadata属性metadata?: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。
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公开属性;类型、只读和可选状态以签名列为准。
verifiedOnly属性verifiedOnly?: boolean公开属性;类型、只读和可选状态以签名列为准。
visibility属性visibility?: ("workspace" | "session" | "private" | "shared" | "tenant")[]公开属性;类型、只读和可选状态以签名列为准。

MemoryVersion

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

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

声明

text
export interface MemoryVersion {
    memoryId: string;
    versionId: string;
    revision: number;
    record: ManagedMemoryRecord;
}

契约成员

成员种类签名说明
memoryId属性memoryId: string公开属性;类型、只读和可选状态以签名列为准。
record属性record: ManagedMemoryRecord<unknown>公开属性;类型、只读和可选状态以签名列为准。
revision属性revision: number公开属性;类型、只读和可选状态以签名列为准。
versionId属性versionId: string公开属性;类型、只读和可选状态以签名列为准。

PaginationRequest

Pagination Request 接口,共包含 7 个公开字段或方法。

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

声明

text
export interface PaginationRequest {
    cursor?: string;
    limit?: number;
    maxPages?: number;
    maxItems?: number;
    maxBytes?: number;
    maxDurationMs?: number;
    maxCalls?: number;
}

契约成员

成员种类签名说明
cursor属性cursor?: string公开属性;类型、只读和可选状态以签名列为准。
limit属性limit?: number公开属性;类型、只读和可选状态以签名列为准。
maxBytes属性maxBytes?: number公开属性;类型、只读和可选状态以签名列为准。
maxCalls属性maxCalls?: number公开属性;类型、只读和可选状态以签名列为准。
maxDurationMs属性maxDurationMs?: number公开属性;类型、只读和可选状态以签名列为准。
maxItems属性maxItems?: number公开属性;类型、只读和可选状态以签名列为准。
maxPages属性maxPages?: number公开属性;类型、只读和可选状态以签名列为准。

PaginationResult

Pagination Result 接口,共包含 2 个公开字段或方法。

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

声明

text
export interface PaginationResult {
    nextCursor?: string;
    hasMore: boolean;
}

契约成员

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

ProviderHealth

Provider Health 接口,共包含 5 个公开字段或方法。

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

声明

text
export interface ProviderHealth {
    status: 'healthy' | 'degraded' | 'unhealthy' | 'unknown';
    checkedAt: string;
    latencyMs?: number;
    message?: string;
    details?: Record<string, unknown>;
}

契约成员

成员种类签名说明
checkedAt属性checkedAt: string公开属性;类型、只读和可选状态以签名列为准。
details属性details?: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。
latencyMs属性latencyMs?: number公开属性;类型、只读和可选状态以签名列为准。
message属性message?: string公开属性;类型、只读和可选状态以签名列为准。
status属性status: "healthy" | "degraded" | "unhealthy" | "unknown"公开属性;类型、只读和可选状态以签名列为准。