firstbatch sdk ts

FirstBatch SDK

FirstBatch SDK bietet eine Schnittstelle zum Integrieren von Vektordatenbanken und zur Leistung personalisierter KI -Erlebnisse in Ihre Anwendung.

• Verwalten Sie nahtlos Benutzersitzungen mit anhaltenden IDs oder temporären Sitzungen.
• Senden Sie Signalaktionen wie Likes, Klicks usw., um Benutzer-Einbetten in Echtzeit zu aktualisieren.
• Abrufen Sie personalisierte Datenstapel an, die auf die Einbettungen jedes Benutzers zugeschnitten sind.
• Unterstützung für mehrere Vektor -Datenbankintegrationen: Pnecone, Weaviate usw.
• Eingebaute Algorithmen für übliche Anwendungsfälle für Personalisierung.

Weitere Informationen finden Sie im Einbettungshandbuch oder in der SDK -Dokumentation.

Installation

Installieren Sie das Paket von NPM:

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

Verwendung

FirstBatch SDK wird zusammen mit einem vorhandenen Vektor Store verwendet, in dem Sie den Vektor Store in unserem SDK registrieren und anschließend Personalisierungssitzungen daraus erstellen.

Hinzufügen eines Kunden

Initialisieren Sie zunächst eine Vektordatenbank Ihrer Wahl. Unsere SDK unterstützt:

• Tannenzapfen
• Waviate
• Artense (Arbeit in Arbeit)
• Supabase (in Arbeit)

Lassen Sie uns ein Beispiel mit Pinecone durchgehen.

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

Erstellen Sie dann einen Vektorspeicher mit diesem Index und geben Sie ihn im FirstBatch SDK weiter.

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

Personalisierung

Jetzt können wir eine Sitzung mit einem Algorithmus erstellen, der zu unserem Anwendungsfall passt, und unseren Benutzern eine Personalisierung bieten.

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

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

Angenommen, der Benutzer hat den ersten Inhalt aus der obigen batch gemocht . Wir können die Personalisierung darüber wie folgt liefern:

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

Hier ist LIKE Signal eines der vielen voreingestellten Signale, die unser SDK bereitstellen. Sie können auch Ihre eigenen Signale definieren:

 import type { Signal } from 'firstbatch' ;

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

Gebäude

Installieren Sie die Abhängigkeiten:

bun install

Dann bauen Sie alles mit:

bun run build
bun b # alternative 

Notiz

Wenn Sie einen Fehler wie "Erwarteten Inhaltsschlüssel ... zu existieren" erhalten, löschen Sie einfach den Ordner .parcel-cache und erstellen Sie erneut.

Testen

Führen Sie alle Tests über: durch: durch:

bun run test
bun t # alternative

Bun wird während der Tests nach .env.test suchen.

Styling

Überprüfen Sie die Formatierung:

bun format

FININT ALLES:

bun lint