@codesoul-co/hypha-memory / mem0-platform-client
模块用法
用于把外部或本地 Provider 绑定到 Hypha Port。Mem0 platform client 模块公开 1 类、2 接口。
从包入口导入
ts
import {
Mem0PlatformClient,
} from '@codesoul-co/hypha-memory';
import type {
Mem0PlatformClientOptions,
Mem0PlatformEvent,
} from '@codesoul-co/hypha-memory';使用要点
- 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用
import type，运行时不应依赖它们。 - 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
Mem0PlatformClient | 类 | new Mem0PlatformClient(options: Mem0PlatformClientOptions): Mem0PlatformClient | Client for the documented Mem0 Platform v3 additive/search/list protocol. |
Mem0PlatformClientOptions | 接口 | interface Mem0PlatformClientOptions | Mem0 Platform Client Options 接口，共包含 15 个公开字段或方法。 |
Mem0PlatformEvent | 接口 | interface Mem0PlatformEvent | Mem0 Platform Event 接口，共包含 4 个公开字段或方法。 |
Mem0PlatformClient
Client for the documented Mem0 Platform v3 additive/search/list protocol.
- 种类: 类
- 导入:
import { Mem0PlatformClient } from '@codesoul-co/hypha-memory'; - 源码模块:
mem0-platform-client
声明
text
export declare class Mem0PlatformClient implements ExternalMemoryClient {
constructor(options: Mem0PlatformClientOptions);
capabilities(): Promise<Partial<MemoryManagementCapabilities>>;
add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
get(request: MemoryGetRequest, signal?: AbortSignal): Promise<import("./contracts").ManagedMemoryRecord<unknown> | 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(signal?: AbortSignal): Promise<ProviderHealth>;
close(): Promise<void>;
getEvent(eventId: string, signal?: AbortSignal): Promise<Mem0PlatformEvent>;
resumeEvent(operationId: string, signal?: AbortSignal): Promise<Mem0PlatformEvent | null>;
reconcile(operationId: string, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
}公开成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
add | 方法 | add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |
capabilities | 方法 | capabilities(): Promise<Partial<MemoryManagementCapabilities>> | 公开方法；参数与返回类型以签名列为准。 |
close | 方法 | close(): Promise<void> | 公开方法；参数与返回类型以签名列为准。 |
constructor | 构造函数 | (options: Mem0PlatformClientOptions): Mem0PlatformClient | 创建该类的实例。 |
delete | 方法 | delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult> | 公开方法；参数与返回类型以签名列为准。 |
get | 方法 | get(request: MemoryGetRequest, signal?: AbortSignal): Promise<import("./contracts").ManagedMemoryRecord<unknown> | null> | 公开方法；参数与返回类型以签名列为准。 |
getEvent | 方法 | getEvent(eventId: string, signal?: AbortSignal): Promise<Mem0PlatformEvent> | 公开方法；参数与返回类型以签名列为准。 |
health | 方法 | health(signal?: AbortSignal): Promise<ProviderHealth> | 公开方法；参数与返回类型以签名列为准。 |
history | 方法 | history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]> | 公开方法；参数与返回类型以签名列为准。 |
list | 方法 | list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult> | 公开方法；参数与返回类型以签名列为准。 |
reconcile | 方法 | reconcile(operationId: string, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]> | 公开方法；参数与返回类型以签名列为准。 |
resumeEvent | 方法 | resumeEvent(operationId: string, signal?: AbortSignal): Promise<Mem0PlatformEvent | null> | 公开方法；参数与返回类型以签名列为准。 |
search | 方法 | search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]> | 公开方法；参数与返回类型以签名列为准。 |
update | 方法 | update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |
Mem0PlatformClientOptions
Mem0 Platform Client Options 接口，共包含 15 个公开字段或方法。
- 种类: 接口
- 导入:
import type { Mem0PlatformClientOptions } from '@codesoul-co/hypha-memory'; - 源码模块:
mem0-platform-client
声明
text
export interface Mem0PlatformClientOptions {
baseUrl?: string;
apiToken?: string;
credentialProvider?: RenewableCredentialProvider;
fetch?: Mem0HttpFetch;
providerId?: string;
mappingStore?: ExternalMemoryMappingStore;
mappingProfile?: ExternalMemoryMappingRuntimeProfile;
operationStore?: ExternalProviderOperationStore;
operationDeadlineMs?: number;
maxOperationAttempts?: number;
providerVersion?: string;
expectedProviderVersion?: string;
expectedCapabilities?: Partial<MemoryManagementCapabilities>;
now?: () => Date;
allowInsecureForTests?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
allowInsecureForTests | 属性 | allowInsecureForTests?: boolean | 公开属性；类型、只读和可选状态以签名列为准。 |
apiToken | 属性 | apiToken?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
baseUrl | 属性 | baseUrl?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
credentialProvider | 属性 | credentialProvider?: RenewableCredentialProvider | 公开属性；类型、只读和可选状态以签名列为准。 |
expectedCapabilities | 属性 | expectedCapabilities?: Partial<MemoryManagementCapabilities> | 公开属性；类型、只读和可选状态以签名列为准。 |
expectedProviderVersion | 属性 | expectedProviderVersion?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
fetch | 方法 | fetch?(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string; signal?: AbortSignal; }): Promise<import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/mem0-rest-client").Mem0HttpResponse> | 公开方法；参数与返回类型以签名列为准。 |
mappingProfile | 属性 | mappingProfile?: ExternalMemoryMappingRuntimeProfile | 公开属性；类型、只读和可选状态以签名列为准。 |
mappingStore | 属性 | mappingStore?: ExternalMemoryMappingStore | 公开属性；类型、只读和可选状态以签名列为准。 |
maxOperationAttempts | 属性 | maxOperationAttempts?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
now | 方法 | now?(): Date | 公开方法；参数与返回类型以签名列为准。 |
operationDeadlineMs | 属性 | operationDeadlineMs?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
operationStore | 属性 | operationStore?: ExternalProviderOperationStore | 公开属性；类型、只读和可选状态以签名列为准。 |
providerId | 属性 | providerId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
providerVersion | 属性 | providerVersion?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
Mem0PlatformEvent
Mem0 Platform Event 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { Mem0PlatformEvent } from '@codesoul-co/hypha-memory'; - 源码模块:
mem0-platform-client
声明
text
export interface Mem0PlatformEvent {
id: string;
status: 'PENDING' | 'RUNNING' | 'FAILED' | 'SUCCEEDED';
results?: unknown[];
payload?: Record<string, unknown>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
id | 属性 | id: string | 公开属性；类型、只读和可选状态以签名列为准。 |
payload | 属性 | payload?: Record<string, unknown> | 公开属性；类型、只读和可选状态以签名列为准。 |
results | 属性 | results?: unknown[] | 公开属性；类型、只读和可选状态以签名列为准。 |
status | 属性 | status: "PENDING" | "RUNNING" | "FAILED" | "SUCCEEDED" | 公开属性；类型、只读和可选状态以签名列为准。 |