Project Icon

pinecone-ts-client

Pinecone 向量数据库的官方 TypeScript/Node 客户端

Pinecone Node.js 官方 TypeScript 客户端,提供简单易用的安装和配置指南。支持通过环境变量或配置对象传入 API 密钥,方便创建和管理 serverless 和 pod-based 索引,并且支持扩展和删除保护功能。提供详细的迁移指南和丰富的示例代码,帮助用户快速上手和迁移到新版本。兼容 TypeScript 4.1 及以上版本,支持多种索引配置和集合操作。

Pinecone-ts-client 项目介绍

Pinecone-ts-client 是一款用于 Pinecone 的官方 Node.js SDK,使用 TypeScript 编写。Pinecone 是一个强大的向量数据库,广泛用于存储和查询高级搜索引擎中使用的矢量。

文档资源

示例代码

以下示例代码展示了 Pinecone SDK 的一些使用场景。更多复杂示例可查看:

SDK 升级指南

2.x 升级至 3.x

在此版本中的 configureIndex 操作有重大变化,更新后的结构包括新增 deletionProtection 选项,并可以通过 spec.podpodTypereplicas 字段进行更新。更多详细内容请参考相应的文档。

1.x 升级至 2.x

2.x 版本中进行了多项更改以支持 Pinecone 的无服务器索引。该版本的详细更改请参考 v2 迁移指南。无服务器索引从 2.x 及更高版本开始可用。

使用要求

Pinecone TypeScript SDK 兼容 TypeScript 版本 >=4.1 和 Node 版本 >=18.x。

安装方法

要安装 Pinecone SDK,可以使用以下 npm 命令:

npm install @pinecone-database/pinecone

生产环境使用

Pinecone TypeScript SDK 旨在用于服务器端,非浏览器环境。如果在浏览器端使用,可能会造成 API 密钥泄露。在这种情况下,请务必轮换 API 密钥。

初始化客户端

初始化 Pinecone 客户端需要一个 API 密钥。该密钥可以通过环境变量或代码配置对象指定。API 密钥可以在 Pinecone 控制台 中获取。

使用环境变量

设置环境变量以配置 API 密钥:

PINECONE_API_KEY="your_api_key"

使用配置对象

如果希望在代码中传递配置,可以通过构造函数接受配置对象:

import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone({
  apiKey: 'your_api_key',
  maxRetries: 5,
});

使用代理服务器

如果需要通过代理与 Pinecone 交互,可以使用 undici 库构建一个自定义的 ProxyAgent。可以参考示例代码了解具体实现方法。

创建索引

可以使用最小配置创建无服务器索引,或者通过可选配置创建基于 pod 的索引。索引配置详细信息请参考相关文档。

其他功能

Pinecone SDK 提供丰富的功能,例如处理向量数据的索引操作、创建集合、与推理 API 交互等。详细操作指南可以在官方文档中找到。

测试

Pinecone SDK 的测试过程自动在 CI 中进行,由 GitHub actions 和工作流配置实现。如需了解更多信息,请查看 .github 目录中的相关文件或 CONTRIBUTING.md

Pinecone-ts-client 是一个功能强大且灵活的工具,适合需要处理大规模向量数据的开发者。通过 TypeScript 提供的类型支持,开发者可以在项目中更好地实现各种高级搜索和数据操作。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

Trae

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号