firstbatch sdk ts

SDK FirstBatch

FirstBatch SDK fournit une interface pour intégrer les bases de données vectorielles et alimenter les expériences d'IA personnalisées dans votre application.

• Gérez de manière transparente les séances utilisateur avec des identifiants persistants ou des séances temporaires.
• Envoyez des actions de signal comme les likes, les clics, etc. pour mettre à jour les intégres des utilisateurs en temps réel.
• Reposez les lots de données personnalisées adaptées aux intégres de chaque utilisateur.
• Prise en charge des intégrations de la base de données vectorielle multiples: Pinecone, Weavate, etc.
• Algorithmes intégrés pour les cas d'utilisation de personnalisation courants.

Pour plus d'informations, consultez le Guide d'intégration de l'utilisateur ou la documentation SDK.

Installation

Installez le package à partir de NPM:

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

Usage

Le SDK FirstBatch est utilisé avec un magasin vectoriel existant, où vous enregistrez le magasin vectoriel à notre SDK, puis créez des séances de personnalisation à partir de celui-ci.

Ajout d'un client

Tout d'abord, initialisez une base de données vectorielle de votre choix; Notre SDK prend en charge:

• Pignon
• Tisser
• Typesense (travail en cours)
• Supabase (travail en cours)

Passons en revue un exemple à l'aide de 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' ) ;

Ensuite, créez un magasin vectoriel avec cet index et passez-le dans le 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 ) ;

Personnalisation

Maintenant, nous pouvons créer une session avec un algorithme qui convient à notre cas d'utilisation et fournir une personnalisation à nos utilisateurs.

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

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

Supposons que l'utilisateur ait aimé le premier contenu du batch ci-dessus. Nous pouvons fournir une personnalisation à ce sujet comme suit:

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

Ici, LIKE le signal est l'un des nombreux signaux prédéfinis fournis par notre SDK. Vous pouvez également définir vos propres signaux:

 import type { Signal } from 'firstbatch' ;

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

Bâtiment

Installez les dépendances:

bun install

Ensuite, construisez tout avec:

bun run build
bun b # alternative 

Note

Si vous obtenez une erreur comme "la clé de contenu attendue ... pour exister", supprimez simplement le dossier .parcel-cache et renaissez-vous.

Essai

Exécutez tous les tests via:

bun run test
bun t # alternative

Bun recherchera .env.test pendant les tests.

Coiffage

Vérifier le formatage:

bun format

Peluche tout:

bun lint