@codesoul-co/hypha-memory / operations
- 包索引:
@codesoul-co/hypha-memory - 源码:
packages/memory/src/operations.ts - 导出数: 20
模块用法
用于使用该功能边界的公共契约与操作。Operations 模块公开 20 接口。
从包入口导入
import type {
ManagedMemoryDeleteRequest,
ManagedMemoryDeleteResult,
ManagedMemorySearchRequest,
ManagedMemorySearchResult,
ManagedMemoryUpdateRequest,
ManagedMemoryWriteResult,
MemoryAddRequest,
MemoryGetRequest,
} from '@codesoul-co/hypha-memory';
// 完整导出列表见下方。使用要点
- 20 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用
import type,运行时不应依赖它们。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
ManagedMemoryDeleteRequest | 接口 | interface ManagedMemoryDeleteRequest | Managed Memory Delete Request 接口,共包含 8 个公开字段或方法。 |
ManagedMemoryDeleteResult | 接口 | interface ManagedMemoryDeleteResult | Managed Memory Delete Result 接口,共包含 6 个公开字段或方法。 |
ManagedMemorySearchRequest | 接口 | interface ManagedMemorySearchRequest | Managed Memory Search Request 接口,共包含 20 个公开字段或方法。 |
ManagedMemorySearchResult | 接口 | interface ManagedMemorySearchResult | Managed Memory Search Result 接口,共包含 7 个公开字段或方法。 |
ManagedMemoryUpdateRequest | 接口 | interface ManagedMemoryUpdateRequest | Managed Memory Update Request 接口,共包含 8 个公开字段或方法。 |
ManagedMemoryWriteResult | 接口 | interface ManagedMemoryWriteResult | Managed Memory Write Result 接口,共包含 7 个公开字段或方法。 |
MemoryAddRequest | 接口 | interface MemoryAddRequest | Memory Add Request 接口,共包含 13 个公开字段或方法。 |
MemoryGetRequest | 接口 | interface MemoryGetRequest | Memory Get Request 接口,共包含 5 个公开字段或方法。 |
MemoryHistoryRequest | 接口 | interface MemoryHistoryRequest | Memory History Request 接口,共包含 5 个公开字段或方法。 |
MemoryIndexJobRef | 接口 | interface MemoryIndexJobRef | Memory Index Job Ref 接口,共包含 2 个公开字段或方法。 |
MemoryListRequest | 接口 | interface MemoryListRequest | Memory List Request 接口,共包含 5 个公开字段或方法。 |
MemoryListResult | 接口 | interface MemoryListResult extends PaginationResult | Memory List Result 接口,共包含 3 个公开字段或方法。 |
MemoryManagementProvider | 接口 | interface MemoryManagementProvider | Memory Management Provider 接口,共包含 11 个公开字段或方法。 |
MemoryPatch | 接口 | interface MemoryPatch | Memory Patch 接口,共包含 8 个公开字段或方法。 |
MemoryRejectedItem | 接口 | interface MemoryRejectedItem | Memory Rejected Item 接口,共包含 3 个公开字段或方法。 |
MemorySearchFilter | 接口 | interface MemorySearchFilter | Memory Search Filter 接口,共包含 18 个公开字段或方法。 |
MemoryVersion | 接口 | interface MemoryVersion | Memory Version 接口,共包含 4 个公开字段或方法。 |
PaginationRequest | 接口 | interface PaginationRequest | Pagination Request 接口,共包含 7 个公开字段或方法。 |
PaginationResult | 接口 | interface PaginationResult | Pagination Result 接口,共包含 2 个公开字段或方法。 |
ProviderHealth | 接口 | interface ProviderHealth | Provider Health 接口,共包含 5 个公开字段或方法。 |
ManagedMemoryDeleteRequest
Managed Memory Delete Request 接口,共包含 8 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ManagedMemoryDeleteRequest } from '@codesoul-co/hypha-memory'; - 源码模块:
operations
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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
声明
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" | 公开属性;类型、只读和可选状态以签名列为准。 |
