pinecone client

Inoffizieller Pinecone.io -Client

Ein inoffizieller Abruf -basierter Client für die PineCone.IO -Vektor -Datenbank mit hervorragendem Typecript -Unterstützung.

Pinecone hat kürzlich einen ähnlichen Client veröffentlicht. Es ist eine großartige Option, wenn Sie nicht wählerisch über vollständig getippte Metadaten sind.

Highlights

• Unterstützung für alle Endpunkte des Vektorbetriebs
• Voll eingegeben
• Entfernen Sie die Null -Metadatenwerte automatisch (Pnecone Nulls nicht)
• Unterstützt moderne Laufzeiten mit modernen Fetch -basierten (CloudLflare -Arbeitern, Deno usw.)
• In-Editor-Dokumentation mit IntelliSense/TS Server
• Winzige Packungsgröße. Weniger als 5 KB Gzipped
• Vollständige E2E -Testabdeckung

Beispiel Verwendung

 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;
// }[]; 

Installieren

WARNUNG: Dieses Paket ist natives ESM und bietet keinen CommonJS -Export mehr. Wenn Ihr Projekt CommonJS verwendet, müssen Sie in ESM konvertieren oder die Funktion Dynamic import() verwenden. Bitte öffnen Sie keine Probleme für Fragen zu CommonJs / ESM.

Laufzeiten

• Unterstützt: Deno, Knoten v18+, Cloudflare -Mitarbeiter, Browser
• Nicht unterstützt: alles ohne eine native Fetch -Implementierung (Knoten <V17)

npm install pinecone-client

 import { PineconeClient } from 'pinecone-client' ;

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

Aufstellen

Nach der Installation müssen Sie eine Instanz der PineconeClient -Klasse erstellen, um API -Anrufe zu tätigen.

 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' ,
} ) ;

Sowohl Apikey als auch Baseurl sind optional und werden aus den folgenden Umgebungsvariablen gelesen:

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

API

Der Client unterstützt alle Vektoroperationen von der Pinecone -API unter Verwendung derselben Methodamen und Parameter. Es unterstützt auch das Erstellen und Löschen von Indizes.

Ausführliche Dokumentation mit Links zu den Pinecone -Dokumenten finden Sie im Quellcode.

Unterstützte Methoden:

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

In den E2E -Tests finden Sie auch mehr Beispielanwendungen.