firstbatch sdk ts

Firstbatch SDK

FirstBatch SDK는 벡터 데이터베이스를 통합하고 응용 프로그램에서 개인화 된 AI 경험을 전원하는 인터페이스를 제공합니다.

• 지속적인 ID 또는 임시 세션으로 사용자 세션을 원활하게 관리합니다.
• 사용자 임베딩을 실시간으로 업데이트하려면 좋아요, 클릭 등과 같은 신호 작업을 보내십시오.
• 각 사용자의 임베딩에 맞게 맞춤형 데이터 배치를 가져옵니다.
• 다중 벡터 데이터베이스 통합 지원 : Pinecone, Weaviate 등
• 일반적인 개인화 사용 사례를위한 내장 알고리즘.

자세한 내용은 사용자 임베딩 안내서 또는 SDK 문서를 참조하십시오.

설치

NPM에서 패키지 설치 :

npm install firstbatch  # npm
yarn add firstbatch     # yarn
pnpm add firstbatch     # pnpm 

용법

FirstBatch SDK는 기존 벡터 저장소와 함께 사용되며 벡터 스토어를 SDK에 등록한 다음 개인화 세션을 만듭니다.

클라이언트 추가

먼저 선택한 벡터 데이터베이스를 초기화하십시오. 우리의 SDK는 다음을 지원합니다.

• 피네콘
• 직조
• Typeense (진행중인 작업)
• Supabase (진행중인 작업)

Pinecone을 사용하여 예를 살펴 보겠습니다.

 import { Pinecone as PineconeClient } from '@pinecone-database/pinecone' ;
import { Pinecone , FirstBatch , Signals } from 'firstbatch' ;

// create Pinecone client
const pinecone = new PineconeClient ( { apiKey : 'pinecone-api-key' , environment : 'pinecone-env' } ) ;
await pinecone . describeIndex ( 'index-name' ) ;
const index = pinecone . index ( 'index-name' ) ;

그런 다음이 색인으로 벡터 저장소를 만들어 FirstBatch SDK에 전달하십시오.

 // create SDK
const personalized = await FirstBatch . new ( 'firstbatch-api-key' ) ;

// add vector store to SDK
const vectorStore = new Pinecone ( index ) ;
const vdbid = 'pinecone-example-db' ;
await personalized . addVectorStore ( vdbid , vectorStore ) ;

개인화

이제 우리는 사용 사례에 적합한 알고리즘으로 세션을 만들고 사용자에게 개인화를 제공 할 수 있습니다.

 // create a session
const session = personalized . session ( 'ALGORITHM_NAME' , vdbid ) ;

// make recommendations
const [ ids , batch ] = personalized . batch ( session ) ;

사용자가 위의 batch 에서 첫 번째 컨텐츠를 좋아 했다고 가정하십시오. 우리는 다음과 같이 이에 대한 개인화를 제공 할 수 있습니다.

 // the user liked the first content of the previous batch
const userPick = ids [ 0 ] ;

// signal this to the session
personalized . addSignal ( sessionId , Signals . LIKE , userPick ) ;

여기서는 Signal LIKE SDK가 제공하는 많은 사전 설정 신호 중 하나입니다. 자신의 신호를 정의 할 수도 있습니다.

 import type { Signal } from 'firstbatch' ;

const mySignal : Signal = { label : 'SOME_USER_ACTION' , weight : 0.5 } ; 

건물

종속성 설치 :

bun install

그런 다음 다음과 같이 모든 것을 구축하십시오.

bun run build
bun b # alternative 

메모

"예상 컨텐츠 키 ... 존재하기"와 같은 오류가 발생하면 .parcel-cache 폴더를 삭제하고 다시 빌드하십시오.

테스트

다음을 통해 모든 테스트를 실행합니다.

bun run test
bun t # alternative

Bun은 테스트 중에 .env.test 찾습니다.

스타일링

서식 확인 :

bun format

모든 것을 보풀 :

bun lint