Skip to content

@codesoul-co/hypha-memory / hindsight-local-factory

模块用法

用于使用该功能边界的公共契约与操作。Hindsight local factory 模块公开 1 常量、2 函数、2 接口。

从包入口导入

ts
import {
  HINDSIGHT_LOCAL_FACTORY_ID,
  createHindsightLocalMemoryProviderFactory,
  registerHindsightLocalMemoryProvider,
} from '@codesoul-co/hypha-memory';

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

使用要点

  • 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 2 个函数是该模块的直接操作入口;每个 overload 的必需/可选参数与返回类型均在下方列出。
  • 1 个常量/枚举提供稳定值、Schema、Definition 或默认配置;应复用这些导出,避免在应用中复制内部值。

公共导出

Symbol种类签名说明
HINDSIGHT_LOCAL_FACTORY_ID常量const HINDSIGHT_LOCAL_FACTORY_ID: "memory.factory.memorybank.hindsight-local"hindsight-local-factory 模块导出的 HINDSIGHT LOCAL FACTORY ID 常量。
createHindsightLocalMemoryProviderFactory函数createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactoryCreate Hindsight Local Memory Provider Factory 函数,提供 1 个公开调用签名;参数与返回类型见下表。
registerHindsightLocalMemoryProvider函数registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistryRegister Hindsight Local Memory Provider 函数,提供 1 个公开调用签名;参数与返回类型见下表。
HindsightLocalConnection接口interface HindsightLocalConnectionHindsight Local Connection 接口,共包含 3 个公开字段或方法。
HindsightLocalFactoryOptions接口interface HindsightLocalFactoryOptionsHindsight Local Factory Options 接口,共包含 2 个公开字段或方法。

HINDSIGHT_LOCAL_FACTORY_ID

hindsight-local-factory 模块导出的 HINDSIGHT LOCAL FACTORY ID 常量。

  • 种类: 常量
  • 导入: import { HINDSIGHT_LOCAL_FACTORY_ID } from '@codesoul-co/hypha-memory';
  • 源码模块: hindsight-local-factory

声明

text
export declare const HINDSIGHT_LOCAL_FACTORY_ID: "memory.factory.memorybank.hindsight-local";

createHindsightLocalMemoryProviderFactory

Create Hindsight Local Memory Provider Factory 函数,提供 1 个公开调用签名;参数与返回类型见下表。

  • 种类: 函数
  • 导入: import { createHindsightLocalMemoryProviderFactory } from '@codesoul-co/hypha-memory';
  • 源码模块: hindsight-local-factory

声明

text
export declare function createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactory;

调用签名

text
createHindsightLocalMemoryProviderFactory(options?: HindsightLocalFactoryOptions): MemoryManagementProviderFactory

参数

参数类型必需说明
optionsHindsightLocalFactoryOptions可选参数;接受的值由类型列定义。

返回值

  • 类型: MemoryManagementProviderFactory
  • 说明: 返回值契约由上述类型定义。

registerHindsightLocalMemoryProvider

Register Hindsight Local Memory Provider 函数,提供 1 个公开调用签名;参数与返回类型见下表。

  • 种类: 函数
  • 导入: import { registerHindsightLocalMemoryProvider } from '@codesoul-co/hypha-memory';
  • 源码模块: hindsight-local-factory

声明

text
export declare function registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistry;

调用签名

text
registerHindsightLocalMemoryProvider(registry: MemoryManagementProviderRegistry, options?: HindsightLocalFactoryOptions): MemoryManagementProviderRegistry

参数

参数类型必需说明
registryMemoryManagementProviderRegistry必需参数;接受的值由类型列定义。
optionsHindsightLocalFactoryOptions可选参数;接受的值由类型列定义。

返回值

  • 类型: MemoryManagementProviderRegistry
  • 说明: 返回值契约由上述类型定义。

HindsightLocalConnection

Hindsight Local Connection 接口,共包含 3 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { HindsightLocalConnection } from '@codesoul-co/hypha-memory';
  • 源码模块: hindsight-local-factory

声明

text
export interface HindsightLocalConnection {
    baseUrl: string;
    bearerToken?: string;
    fetch?: Mem0HttpFetch;
}

契约成员

成员种类签名说明
baseUrl属性baseUrl: string公开属性;类型、只读和可选状态以签名列为准。
bearerToken属性bearerToken?: 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>公开方法;参数与返回类型以签名列为准。

HindsightLocalFactoryOptions

Hindsight Local Factory Options 接口,共包含 2 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { HindsightLocalFactoryOptions } from '@codesoul-co/hypha-memory';
  • 源码模块: hindsight-local-factory

声明

text
export interface HindsightLocalFactoryOptions {
    fetch?: Mem0HttpFetch;
    operationDeadlineMs?: number;
}

契约成员

成员种类签名说明
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>公开方法;参数与返回类型以签名列为准。
operationDeadlineMs属性operationDeadlineMs?: number公开属性;类型、只读和可选状态以签名列为准。