firstbatch sdk ts

FirstBatch SDK

FirstBatch SDK proporciona una interfaz para integrar bases de datos vectoriales y alimentar experiencias de IA personalizadas en su aplicación.

• Administre sin problemas sesiones de usuario con ID persistentes o sesiones temporales.
• Envíe acciones de señal como me gusta, clics, etc. para actualizar las integridades de los usuarios en tiempo real.
• Obtenga lotes personalizados de datos adaptados a los incrustaciones de cada usuario.
• Soporte para múltiples integraciones de bases de datos vectoriales: pinecone, tejido, etc.
• Algoritmos incorporados para casos de uso de personalización comunes.

Para obtener más información, consulte la Guía de incrustación del usuario o la documentación SDK.

Instalación

Instale el paquete desde NPM:

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

Uso

FirstBatch SDK se usa junto con una tienda vectorial existente, donde registra la tienda Vector en nuestro SDK y luego crea sesiones de personalización a partir de ella.

Agregar un cliente

Primero, inicialice una base de datos vectorial de su elección; Nuestro SDK es compatible con:

• Piña
• Tejido
• Tipos de campo (trabajo en progreso)
• Supabase (trabajo en progreso)

Pasamos un ejemplo usando 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' ) ;

Luego, cree una tienda vectorial con este índice y paselo en el SDK de 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 ) ;

Personalización

Ahora, podemos crear una sesión con un algoritmo que se adapte a nuestro caso de uso y proporcionar personalización a nuestros usuarios.

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

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

Supongamos que al usuario le ha gustado el primer contenido del batch anterior. Podemos proporcionar personalización sobre esto de la siguiente manera:

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

Aquí, LIKE la señal es una de las muchas señales preestablecidas proporcionadas por nuestro SDK. También puede definir sus propias señales:

 import type { Signal } from 'firstbatch' ;

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

Edificio

Instale las dependencias:

bun install

Entonces, construya todo con:

bun run build
bun b # alternative 

Nota

Si recibe un error como "Clave de contenido esperada ... para existir", simplemente elimine la carpeta .parcel-cache y construya nuevamente.

Pruebas

Ejecute todas las pruebas a través de:

bun run test
bun t # alternative

Bun buscará .env.test durante las pruebas.

Estilo

Verificación de formato:

bun format

Pelusa todo:

bun lint