Skip to content

@codesoul-co/hypha-memory / managed-provider-factories

Using this module

Use the Managed provider factories module for binding external or local providers to Hypha ports. It exports 2 constants, 2 functions, 1 interface.

Import from the package entrypoint

ts
import {
  MEM0_PLATFORM_FACTORY_ID,
  MEMORYBANK_MANAGED_FACTORY_ID,
  createMem0PlatformMemoryProviderFactory,
  createMemoryBankManagedProviderFactory,
} from '@codesoul-co/hypha-memory';

import type {
  ManagedExternalProviderFactoryOptions,
} 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 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
  • The 2 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

SymbolKindSignatureDescription
MEM0_PLATFORM_FACTORY_IDconstantconst MEM0_PLATFORM_FACTORY_ID: "memory.factory.mem0.platform-v3"MEM0 PLATFORM FACTORY ID constant exported by the managed-provider-factories module.
MEMORYBANK_MANAGED_FACTORY_IDconstantconst MEMORYBANK_MANAGED_FACTORY_ID: "memory.factory.memorybank.vertex-ai-managed"MEMORYBANK MANAGED FACTORY ID constant exported by the managed-provider-factories module.
createMem0PlatformMemoryProviderFactoryfunctioncreateMem0PlatformMemoryProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactoryCreate Mem0 Platform Memory Provider Factory function with 1 public call signature; parameters and return types are listed below.
createMemoryBankManagedProviderFactoryfunctioncreateMemoryBankManagedProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactoryCreate Memory Bank Managed Provider Factory function with 1 public call signature; parameters and return types are listed below.
ManagedExternalProviderFactoryOptionsinterfaceinterface ManagedExternalProviderFactoryOptionsManaged External Provider Factory Options interface with 1 public fields or methods.

MEM0_PLATFORM_FACTORY_ID

MEM0 PLATFORM FACTORY ID constant exported by the managed-provider-factories module.

  • Kind: constant
  • Import: import { MEM0_PLATFORM_FACTORY_ID } from '@codesoul-co/hypha-memory';
  • Source module: managed-provider-factories

Declaration

text
export declare const MEM0_PLATFORM_FACTORY_ID: "memory.factory.mem0.platform-v3";

MEMORYBANK_MANAGED_FACTORY_ID

MEMORYBANK MANAGED FACTORY ID constant exported by the managed-provider-factories module.

  • Kind: constant
  • Import: import { MEMORYBANK_MANAGED_FACTORY_ID } from '@codesoul-co/hypha-memory';
  • Source module: managed-provider-factories

Declaration

text
export declare const MEMORYBANK_MANAGED_FACTORY_ID: "memory.factory.memorybank.vertex-ai-managed";

createMem0PlatformMemoryProviderFactory

Create Mem0 Platform Memory Provider Factory function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { createMem0PlatformMemoryProviderFactory } from '@codesoul-co/hypha-memory';
  • Source module: managed-provider-factories

Declaration

text
export declare function createMem0PlatformMemoryProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactory;

Call signature

text
createMem0PlatformMemoryProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactory

Parameters

ParameterTypeRequiredDescription
optionsManagedExternalProviderFactoryOptionsNoOptional parameter; accepted values are defined by the type column.

Returns

  • Type: MemoryManagementProviderFactory
  • Description: The return contract is defined by the type shown above.

createMemoryBankManagedProviderFactory

Create Memory Bank Managed Provider Factory function with 1 public call signature; parameters and return types are listed below.

  • Kind: function
  • Import: import { createMemoryBankManagedProviderFactory } from '@codesoul-co/hypha-memory';
  • Source module: managed-provider-factories

Declaration

text
export declare function createMemoryBankManagedProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactory;

Call signature

text
createMemoryBankManagedProviderFactory(options?: ManagedExternalProviderFactoryOptions): MemoryManagementProviderFactory

Parameters

ParameterTypeRequiredDescription
optionsManagedExternalProviderFactoryOptionsNoOptional parameter; accepted values are defined by the type column.

Returns

  • Type: MemoryManagementProviderFactory
  • Description: The return contract is defined by the type shown above.

ManagedExternalProviderFactoryOptions

Managed External Provider Factory Options interface with 1 public fields or methods.

  • Kind: interface
  • Import: import type { ManagedExternalProviderFactoryOptions } from '@codesoul-co/hypha-memory';
  • Source module: managed-provider-factories

Declaration

text
export interface ManagedExternalProviderFactoryOptions {
    fetch?: Mem0HttpFetch;
}

Contract members

MemberKindSignatureDescription
fetchmethodfetch?(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.