Repolode
pinecone-io

pinecone-io/pinecone-ts-client

Pinecone 官方 TypeScript/Node.js SDK,用于操作托管的向量与全文检索数据库。

Star
279
Fork
50
未关闭 Issue
20
最近提交
前天

这是什么?

这是 Pinecone 官方提供的 TypeScript 与 Node.js 客户端。服务端应用可以通过它创建和管理索引,存储文档与原始向量,并对 Pinecone 索引执行全文检索、向量检索以及带元数据过滤的查询。

SDK 支持三种使用方式:带全文检索的文档存储、自行生成向量后直接写入和查询,以及集成嵌入(由 Pinecone 使用托管模型根据文档文本生成向量)。此外还提供嵌入与重排序模型的推理接口,以及用于上传文件并进行对话的 Pinecone Assistant API 客户端。

该包需要 Node.js 22 及以上版本和 TypeScript 5.2 及以上版本。由于代码中需要直接使用 API Key,它仅适用于服务端,不应打包进浏览器端代码。

核心功能

  • 01存储文档,并按多个字段进行全文检索和过滤
  • 02支持向量的写入、查询、获取、更新与删除,并可按元数据过滤
  • 03可创建 serverless 索引,也可管理已有的 pod 索引
  • 04通过集成嵌入,由 Pinecone 托管模型在服务端生成向量
  • 05提供嵌入与重排序模型的独立推理接口
  • 06支持泛型元数据类型,获得完整的 TypeScript 类型提示

适用场景

  • 在 Node.js 后端为自有文档增加语义搜索
  • 构建检索增强生成(RAG)流程,存储并查询向量
  • 在一次查询中结合文本字段的关键词检索与向量相似度
  • 基于向量相似度构建推荐系统

快速上手

  1. 1

    从 npm 安装 SDK

    npm install @pinecone-database/pinecone
  2. 2

    若在 TypeScript Node 项目中使用,安装 Node 类型声明

    npm install --save-dev @types/node
  3. 3

    设置 PINECONE_API_KEY 环境变量,并运行 README 中的全文搜索快速入门代码

使用前须知

  • 仅适用于服务器端;在浏览器中使用可能暴露 API 密钥。
  • 需要 Pinecone 账户和 API 密钥,并且需要 Node.js 22 或更新版本。

标签

常见问题

pinecone-ts-client 是什么?
Pinecone 官方 TypeScript/Node.js SDK,用于操作托管的向量与全文检索数据库。 这是 Pinecone 官方提供的 TypeScript 与 Node.js 客户端。服务端应用可以通过它创建和管理索引,存储文档与原始向量,并对 Pinecone 索引执行全文检索、向量检索以及带元数据过滤的查询。
pinecone-ts-client 可以免费使用吗?用的什么许可证?
pinecone-ts-client 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
pinecone-ts-client 还在维护吗?
活跃维护中。pinecone-ts-client 最近一次提交是在 2026年11月5日。
pinecone-ts-client 适合用来做什么?
在 Node.js 后端为自有文档增加语义搜索 构建检索增强生成(RAG)流程,存储并查询向量 在一次查询中结合文本字段的关键词检索与向量相似度 基于向量相似度构建推荐系统
pinecone-ts-client 怎么安装和运行?
从 npm 安装 SDK: npm install @pinecone-database/pinecone 若在 TypeScript Node 项目中使用,安装 Node 类型声明: npm install --save-dev @types/node 设置 PINECONE_API_KEY 环境变量,并运行 README 中的全文搜索快速入门代码
在哪里获取 pinecone-ts-client?
源代码和安装说明在 GitHub 上:https://github.com/pinecone-io/pinecone-ts-client

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目