pinecone client

Cliente pnecone.io não oficial

Um cliente baseado em busca não oficial para o banco de dados Pinecone.io Vector com excelente suporte ao TypeScript.

Pinecone lançou recentemente um cliente semelhante. É uma ótima opção se você não for exigente em metadados totalmente digitados.

Destaques

• Suporte para todos os pontos de extremidade de operação vetorial
• Metadados totalmente digitados com genéricos de texto datilografado
• Remova automaticamente os valores de metadados nulos (Pinecone não é nulo)
• Suporta os horários de execução baseados em busca moderna (Cloudlflare Workers, Deno, etc)
• Documentação no editor com o IntelliSense/TS Server
• Tamanho do pacote minúsculo. Menos de 5kb gzipped
• Cobertura completa do teste E2E

Exemplo de uso

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

Instalar

AVISO: Este pacote é o ESM nativo e não fornece mais uma exportação do CommonJS. Se o seu projeto usar o Commonjs, você deverá converter para ESM ou usar a função Dynamic import() . Por favor, não abra questões para perguntas sobre Commonjs / ESM.

Runtimes

• Apoiado: Deno, Node V18+, Cloudflare Workers, navegadores
• Não suportado: qualquer coisa sem uma implementação de busca nativa (nó <v17)

npm install pinecone-client

 import { PineconeClient } from 'pinecone-client' ;

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

Configurar

Depois de instalado, você precisa criar uma instância da classe PineconeClient para fazer chamadas de 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 e BASEURL são opcionais e serão lidos das seguintes variáveis ​​de ambiente:

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

API

O cliente suporta todas as operações do vetor da API Pinecone usando os mesmos nomes e parâmetros de métodos. Ele também suporta a criação e exclusão de índices.

Para documentação detalhada com links para os documentos Pinecone, consulte o código -fonte.

Métodos suportados:

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

Você também pode encontrar mais exemplo de uso nos testes E2E.