pinecone client

비공식 PENECONE.IO 클라이언트

우수한 타입 스크립트 지원을 갖춘 Pinecone.io 벡터 데이터베이스의 비공식 페치 기반 클라이언트.

Pinecone은 최근 비슷한 고객을 출시했습니다. 완전히 입력 한 메타 데이터에 대해 까다 롭지 않으면 훌륭한 옵션입니다.

하이라이트

• 모든 벡터 작동 엔드 포인트를 지원합니다
• TypeScript 제네릭이있는 완전 유형 메타 데이터
• NULL 메타 데이터 값을 자동으로 제거합니다 (PENECONE NOT NULLS NULLS)
• 현대 페치 기반 런타임 (CloudLflare Workers, Deno 등)을 지원합니다.
• IntelliSense/TS 서버를 통한 내 편집자 문서
• 작은 패키지 크기. 5KB 미만
• 전체 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, Node V18+, CloudFlare Workers, 브라우저
• 지원되지 않은 : 기본 Fetch 구현이없는 모든 것 (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 테스트에서 더 많은 예제 사용법을 찾을 수 있습니다.