pinecone client

非公式Pinecone.ioクライアント

Pinecone.io Vectorデータベースの非公式のフェッチベースのクライアントは、優れたタイプスクリプトサポートを備えています。

Pineconeは最近、同様のクライアントをリリースしました。完全にタイプされたメタデータについてうるさくない場合、それは素晴らしい選択肢です。

ハイライト

• すべてのベクトル操作エンドポイントのサポート
• タイプスクリプトジェネリックを備えた完全にタイプされたメタデータ
• nullメタデータ値を自動的に削除します（Pinecone Not Nulls）
• 最新のフェッチベースのランタイム（Cloudlflareワーカー、デノなど）をサポートします
• Intellisense/TSサーバーを使用した編集者ドキュメント
• 小さなパッケージサイズ。 5kb未満のGzipped
• 完全な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であり、CommonJSエクスポートを提供しなくなりました。プロジェクトがCommonJSを使用する場合、ESMに変換するか、動的import()関数を使用する必要があります。 CommonJS / ESMに関する質問について問題を開かないでください。

ランタイム

• サポート：Deno、Node V18+、CloudFlareワーカー、ブラウザ
• サポートされていない：ネイティブフェッチの実装のないもの（node <v17）

npm install pinecone-client

 import { PineconeClient } from 'pinecone-client' ;

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

設定

インストールしたら、API呼び出しを行うには、 PineconeClientクラスのインスタンスを作成する必要があります。

 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テストでより多くの使用方法を見つけることもできます。