firstbatch sdk ts

FirstBatch SDK

FirstBatch SDK menyediakan antarmuka untuk mengintegrasikan database vektor dan memperkuat pengalaman AI yang dipersonalisasi dalam aplikasi Anda.

• Mengelola sesi pengguna dengan mulus dengan ID persisten atau sesi sementara.
• Kirim tindakan sinyal seperti suka, klik, dll. Untuk memperbarui embeddings pengguna secara real-time.
• Ambil kumpulan data yang disesuaikan dengan embeddings masing -masing pengguna.
• Dukungan untuk beberapa integrasi basis data vektor: Pinecone, Weaviate, dll.
• Algoritma bawaan untuk kasus penggunaan personalisasi umum.

Untuk informasi lebih lanjut, lihat panduan embedding pengguna atau dokumentasi SDK.

Instalasi

Instal paket dari NPM:

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

Penggunaan

FirstBatch SDK digunakan bersama dengan toko vektor yang ada, di mana Anda mendaftarkan toko vektor ke SDK kami dan kemudian membuat sesi personalisasi darinya.

Menambahkan klien

Pertama, inisialisasi database vektor pilihan Anda; Dukungan SDK kami:

• Pinecone
• Weaviate
• TypeSense (bekerja sedang berlangsung)
• Supabase (pekerjaan sedang berlangsung)

Mari kita membahas contoh menggunakan 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' ) ;

Kemudian, buat toko vektor dengan indeks ini dan lewati di SDK FirstBatch.

 // 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 ) ;

Personalisasi

Sekarang, kami dapat membuat sesi dengan algoritma yang sesuai dengan kasus penggunaan kami, dan memberikan personalisasi kepada pengguna kami.

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

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

Misalkan pengguna menyukai konten pertama dari batch di atas. Kami dapat memberikan personalisasi atas ini sebagai berikut:

 // 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 ) ;

Di sini, LIKE sinyal adalah salah satu dari banyak sinyal preset yang disediakan oleh SDK kami. Anda juga dapat menentukan sinyal Anda sendiri:

 import type { Signal } from 'firstbatch' ;

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

Bangunan

Instal dependensi:

bun install

Lalu, bangun semuanya dengan:

bun run build
bun b # alternative 

Catatan

Jika Anda mendapatkan kesalahan seperti "kunci konten yang diharapkan ... ada" cukup hapus folder .parcel-cache dan bangun lagi.

Pengujian

Jalankan semua tes melalui:

bun run test
bun t # alternative

Bun akan mencari .env.test selama pengujian.

Gaya

Periksa format:

bun format

Lint Everything:

bun lint