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

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/memorybank-managed-client.ts
• Exports: 2

Using this module

Use the Memorybank managed client module for binding external or local providers to Hypha ports. It exports 1 class, 1 interface.

Import from the package entrypoint

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

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

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
MemoryBankManagedClient	class	new MemoryBankManagedClient(options: MemoryBankManagedClientOptions): MemoryBankManagedClient	Google Vertex AI Agent Engine Memory Bank managed client.
MemoryBankManagedClientOptions	interface	interface MemoryBankManagedClientOptions	Memory Bank Managed Client Options interface with 16 public fields or methods.

MemoryBankManagedClient

Google Vertex AI Agent Engine Memory Bank managed client.

• Kind: class
• Import: import { MemoryBankManagedClient } from '@codesoul-co/hypha-memory';
• Source module: memorybank-managed-client

Declaration

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>;
}

Public members

Member	Kind	Signature	Description
add	method	add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.
capabilities	method	capabilities(): Promise<Partial<MemoryManagementCapabilities>>	Public method; parameters and return type are shown in the signature.
close	method	close(): Promise<void>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: MemoryBankManagedClientOptions): MemoryBankManagedClient	Creates an instance of this class.
delete	method	delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>	Public method; parameters and return type are shown in the signature.
get	method	get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>	Public method; parameters and return type are shown in the signature.
health	method	health(signal?: AbortSignal): Promise<ProviderHealth>	Public method; parameters and return type are shown in the signature.
history	method	history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>	Public method; parameters and return type are shown in the signature.
list	method	list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>	Public method; parameters and return type are shown in the signature.
reconcileOperation	method	reconcileOperation(operationId: string, signal?: AbortSignal): Promise<ManagedMemoryWriteResult | null>	Public method; parameters and return type are shown in the signature.
search	method	search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>	Public method; parameters and return type are shown in the signature.
update	method	update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.

MemoryBankManagedClientOptions

Memory Bank Managed Client Options interface with 16 public fields or methods.

• Kind: interface
• Import: import type { MemoryBankManagedClientOptions } from '@codesoul-co/hypha-memory';
• Source module: memorybank-managed-client

Declaration

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;
}

Contract members

Member	Kind	Signature	Description
accessToken	property	accessToken?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
allowInsecureForTests	property	allowInsecureForTests?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
baseUrl	property	baseUrl?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
credentialProvider	property	credentialProvider?: RenewableCredentialProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
fetch	method	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>	Public method; parameters and return type are shown in the signature.
location	property	location: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mappingProfile	property	mappingProfile?: ExternalMemoryMappingRuntimeProfile	Public property; its type, readonly modifier and optionality are shown in the signature.
mappingStore	property	mappingStore?: ExternalMemoryMappingStore	Public property; its type, readonly modifier and optionality are shown in the signature.
maxOperationAttempts	property	maxOperationAttempts?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): Date	Public method; parameters and return type are shown in the signature.
operationDeadlineMs	property	operationDeadlineMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
operationStore	property	operationStore?: ExternalProviderOperationStore	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef?: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
projectId	property	projectId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoningEngineId	property	reasoningEngineId: string	Public property; its type, readonly modifier and optionality are shown in the signature.