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測試中找到更多示例用法。