pinecone client

Неофициальный клиент pinecone.io

Неофициальный клиент, основанный на извлечении, для базы данных вектора PineCone.io с отличной поддержкой типовойпис.

Pinecone недавно выпустил аналогичного клиента. Это отличный вариант, если вы не разборчивы в полных напечатанных метаданных.

Основные моменты

• Поддержка всех векторных конечных точек работы
• Полностью напечатанные метаданные с дженериками TypeScript
• Автоматически удалять значения метаданных нулевых метаданных (Pinecone не нулевы)
• Поддерживает современные сборы на основе выборов (работники Cloudlflare, Deno и т. Д.)
• Документация по редактору с сервером Intellisense/TS
• Крошечный размер упаковки. Менее 5 КБ GZIPD
• Полный тестовый охват 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 или использовать функцию Dynamic import() . Пожалуйста, не открывайте вопросы для вопросов, касающихся CommonJS / 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

Клиент поддерживает все векторные операции из API Pinecone, используя те же имена методов и параметры. Это также поддерживает создание и удаление индексов.

Для получения подробной документации со ссылками на документы Pinecone см. Исходный код.

Поддерживаемые методы:

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

Вы также можете найти больше примеров использования в тестах E2E.