类 BaseStore抽象类

持久键值存储的抽象基类。

存储支持持久性和内存，这些持久性和内存可以在线程之间共享，并限定于用户 ID、助手 ID 或其他任意命名空间。

功能

  • 用于组织的分层命名空间
  • 带有元数据的键值存储
  • 向量相似度搜索（如果已配置）
  • 过滤和分页

层次结构 (查看完整)

构造函数

constructor

方法

batch delete get listNamespaces put search start stop

构造函数

constructor

方法

抽象方法 batch

  • batch<Op>(operations): Promise<OperationResults<Op>>

  • 在单个批次中执行多个操作。这比单独执行操作更有效率。

    类型参数

    参数

    • operations: Op

      要执行的操作数组

    返回 Promise<OperationResults<Op>>

    Promise 解析为与操作匹配的结果

删除

  • delete(namespace, key): Promise<void>

  • 从存储中删除一个项目。

    参数

    • namespace: string[]

      项目的分层路径

    • key: string

      命名空间内的唯一标识符

    返回 Promise<void>

获取

  • get(namespace, key): Promise<null | Item>

  • 通过其命名空间和键检索单个项目。

    参数

    • namespace: string[]

      项目的分层路径

    • key: string

      命名空间内的唯一标识符

    返回 Promise<null | Item>

    Promise 解析为项目，如果未找到则为 null

列出命名空间

  • listNamespaces(options?): Promise<string[][]>

  • 列出和过滤存储中的命名空间。用于探索数据组织和导航命名空间层次结构。

    参数

    • 可选 options: {
          limit?: number;
          maxDepth?: number;
          offset?: number;
          prefix?: string[];
          suffix?: string[];
      }

      列出命名空间的选项

      • 可选 limit?: number
      • 可选 maxDepth?: number
      • 可选 offset?: number
      • 可选 prefix?: string[]
      • 可选 suffix?: string[]

    返回 Promise<string[][]>

    Promise 解析为命名空间路径列表

    示例

    // List all namespaces under "documents"
    await store.listNamespaces({
      prefix: ["documents"],
      maxDepth: 2
    });

    // List namespaces ending with "v1"
    await store.listNamespaces({
      suffix: ["v1"],
      limit: 50
    });

放置

  • put(namespace, key, value, index?): Promise<void>

  • 存储或更新一个项目。

    参数

    • namespace: string[]

      项目的分层路径

    • key: string

      命名空间内的唯一标识符

    • value: Record<string, any>

      包含项目数据的对象

    • 可选 index: false | string[]

      可选的索引配置

    返回 Promise<void>

    示例

    // Simple storage
    await store.put(["docs"], "report", { title: "Annual Report" });

    // With specific field indexing
    await store.put(
      ["docs"],
      "report",
      {
        title: "Q4 Report",
        chapters: [{ content: "..." }, { content: "..." }]
      },
      ["title", "chapters[*].content"]
    );

搜索

  • search(namespacePrefix, options?): Promise<SearchItem[]>

  • 在命名空间前缀内搜索项目。支持元数据过滤和向量相似度搜索。

    参数

    • namespacePrefix: string[]

      要在其中搜索的分层路径前缀

    • 可选 options: {
      可选 options: {
          limit?: number;
          offset?: number;
          query?: string;
      }

      用于过滤和分页的搜索选项

      • 可选 filter?: Record<string, any>
      • 可选 limit?: number
      • 可选 offset?: number
      • 可选 query?: string

    返回 Promise<SearchItem[]>

    Promise 解析为带有相关性分数的匹配项目列表

    示例

    // Search with filters
    await store.search(["documents"], {
      filter: { type: "report", status: "active" },
      limit: 5,
      offset: 10
    });

    // Vector similarity search
    await store.search(["users", "content"], {
      query: "technical documentation about APIs",
      limit: 20
    });

启动

  • start(): void

  • 启动存储。如果需要初始化，请覆盖。

    返回 void

停止

  • stop(): void

  • 停止存储。如果需要清理，请覆盖。

    返回 void

设置

成员可见性

主题

在本页

构造函数batchdeletegetlistNamespacesputsearchstartstop