@codesoul-co/hypha-memory / memorybank-managed-client

• 包索引: @codesoul-co/hypha-memory
• 源码: packages/memory/src/memorybank-managed-client.ts
• 导出数: 2

模块用法

用于把外部或本地 Provider 绑定到 Hypha Port。Memorybank managed client 模块公开 1 类、1 接口。

从包入口导入

import {
  MemoryBankManagedClient,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryBankManagedClientOptions,
} from '@codesoul-co/hypha-memory';

使用要点

• 1 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol	种类	签名	说明
MemoryBankManagedClient	类	new MemoryBankManagedClient(options: MemoryBankManagedClientOptions): MemoryBankManagedClient	Google Vertex AI Agent Engine Memory Bank managed client.
MemoryBankManagedClientOptions	接口	interface MemoryBankManagedClientOptions	Memory Bank Managed Client Options 接口，共包含 16 个公开字段或方法。

MemoryBankManagedClient

Google Vertex AI Agent Engine Memory Bank managed client.

• 种类: 类
• 导入: import { MemoryBankManagedClient } from '@codesoul-co/hypha-memory';
• 源码模块: memorybank-managed-client

声明

export declare class MemoryBankManagedClient implements ExternalMemoryClient {
    constructor(options: MemoryBankManagedClientOptions);
    capabilities(): Promise<Partial<MemoryManagementCapabilities>>;
    add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
    reconcileOperation(operationId: string, signal?: AbortSignal): Promise<ManagedMemoryWriteResult | null>;
    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(signal?: AbortSignal): Promise<ProviderHealth>;
    close(): Promise<void>;
}

公开成员

成员	种类	签名	说明
add	方法	add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	公开方法；参数与返回类型以签名列为准。
capabilities	方法	capabilities(): Promise<Partial<MemoryManagementCapabilities>>	公开方法；参数与返回类型以签名列为准。
close	方法	close(): Promise<void>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: MemoryBankManagedClientOptions): MemoryBankManagedClient	创建该类的实例。
delete	方法	delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>	公开方法；参数与返回类型以签名列为准。
get	方法	get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>	公开方法；参数与返回类型以签名列为准。
health	方法	health(signal?: AbortSignal): Promise<ProviderHealth>	公开方法；参数与返回类型以签名列为准。
history	方法	history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>	公开方法；参数与返回类型以签名列为准。
list	方法	list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>	公开方法；参数与返回类型以签名列为准。
reconcileOperation	方法	reconcileOperation(operationId: string, signal?: AbortSignal): Promise<ManagedMemoryWriteResult | null>	公开方法；参数与返回类型以签名列为准。
search	方法	search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>	公开方法；参数与返回类型以签名列为准。
update	方法	update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	公开方法；参数与返回类型以签名列为准。

MemoryBankManagedClientOptions

Memory Bank Managed Client Options 接口，共包含 16 个公开字段或方法。

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

声明

export interface MemoryBankManagedClientOptions {
    projectId: string;
    location: string;
    reasoningEngineId: string;
    accessToken?: string;
    credentialProvider?: RenewableCredentialProvider;
    fetch?: Mem0HttpFetch;
    baseUrl?: string;
    providerId?: string;
    mappingStore?: ExternalMemoryMappingStore;
    mappingProfile?: ExternalMemoryMappingRuntimeProfile;
    profileRef?: MemoryContractSpecRef;
    operationStore?: ExternalProviderOperationStore;
    operationDeadlineMs?: number;
    maxOperationAttempts?: number;
    now?: () => Date;
    allowInsecureForTests?: boolean;
}

契约成员

成员	种类	签名	说明
accessToken	属性	accessToken?: string	公开属性；类型、只读和可选状态以签名列为准。
allowInsecureForTests	属性	allowInsecureForTests?: boolean	公开属性；类型、只读和可选状态以签名列为准。
baseUrl	属性	baseUrl?: string	公开属性；类型、只读和可选状态以签名列为准。
credentialProvider	属性	credentialProvider?: RenewableCredentialProvider	公开属性；类型、只读和可选状态以签名列为准。
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>	公开方法；参数与返回类型以签名列为准。
location	属性	location: string	公开属性；类型、只读和可选状态以签名列为准。
mappingProfile	属性	mappingProfile?: ExternalMemoryMappingRuntimeProfile	公开属性；类型、只读和可选状态以签名列为准。
mappingStore	属性	mappingStore?: ExternalMemoryMappingStore	公开属性；类型、只读和可选状态以签名列为准。
maxOperationAttempts	属性	maxOperationAttempts?: number	公开属性；类型、只读和可选状态以签名列为准。
now	方法	now?(): Date	公开方法；参数与返回类型以签名列为准。
operationDeadlineMs	属性	operationDeadlineMs?: number	公开属性；类型、只读和可选状态以签名列为准。
operationStore	属性	operationStore?: ExternalProviderOperationStore	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
projectId	属性	projectId: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId?: string	公开属性；类型、只读和可选状态以签名列为准。
reasoningEngineId	属性	reasoningEngineId: string	公开属性；类型、只读和可选状态以签名列为准。