pinecone client

非官方Pinecone.io客户端

Pinecone.io vector数据库的非官方提取客户端具有出色的打字稿支持。

Pinecone最近发布了一个类似的客户。如果您对完全键入的元数据不挑剔，这是一个不错的选择。

亮点

• 支持所有向量操作终点
• 带有打字稿仿制药的完全键入元数据
• 自动删除null元数据值（Pinecone没有空）
• 支持基于现代提取的运行时间（Cloudlflare工人，DENO等）
• Intellisense/TS服务器的编辑文档
• 小包装尺寸。少于5kb的GZB
• 完整的E2E测试覆盖范围

示例用法

 import { PineconeClient } from 'pinecone-client' ;

// Specify the type of your metadata
type Metadata = { size : number , tags ?: string [ ] | null } ;

// Instantiate a client
const pinecone = new PineconeClient < Metadata > ( { namespace : 'test' } ) ;

// Upsert vectors with metadata.
await pinecone . upsert ( {
  vectors : [
    { id : '1' , values : [ 1 , 2 , 3 ] , metadata : { size : 3 , tags : [ 'a' , 'b' , 'c' ] } } ,
    { id : '2' , values : [ 4 , 5 , 6 ] , metadata : { size : 10 , tags : null } } ,
  ] ,
} ) ;

// Query vectors with metadata filters.
const { matches } = await pinecone . query ( {
  topK : 2 ,
  id : '2' ,
  filter : { size : { $lt : 20 } } ,
  includeMetadata : true ,
} ) ;

// typeof matches = {
//   id: string;
//   score: number;
//   metadata: Metadata;
// }[]; 

安装

警告：此软件包是本机ESM，不再提供CONCORJS导出。如果您的项目使用CONCORJ，则必须转换为ESM或使用Dynamic import()函数。请不要打开有关COMPONJS / ESM的问题的问题。

运行时

• 支持：DENO，节点V18+，Cloudflare工人，浏览器
• 不支持：没有本机提取实现的任何东西（节点<v17）

npm install pinecone-client

 import { PineconeClient } from 'pinecone-client' ;

const pinecone = new PineconeClient ( { /* ... */ } ) ; 

设置

安装后，您需要创建一个PineconeClient类的实例才能进行API调用。

 import { PineconeClient } from 'pinecone-client' ;

// A type representing your metadata
type Metadata = { } ;

const pinecone = new PineconeClient < Metadata > ( {
  apiKey : '<your api key>' ,
  baseUrl : '<your index url>' ,
  namespace : 'testing' ,
} ) ;

Apikey和baseurl都是可选的，将从以下环境变量中读取：

• process.env.PINECONE_API_KEY
• process.env.PINECONE_BASE_URL

API

客户使用相同的方法名称和参数支持来自Pinecone API的所有向量操作。它还支持创建和删除索引。

有关使用Pinecone文档链接的详细文档，请参见源代码。

支持的方法：

• pinecone.delete()
• pinecone.describeIndexStats()
• pinecone.fetch()
• pinecone.query()
• pinecone.update()
• pinecone.upsert()
• pinecone.createIndex()
• pinecone.deleteIndex()

您还可以在E2E测试中找到更多示例用法。