firstbatch sdk ts

FirstBatch SDK

O FirstBatch SDK fornece uma interface para integrar bancos de dados de vetores e alimentação de experiências personalizadas de IA em seu aplicativo.

• Gerencie perfeitamente as sessões de usuário com IDs persistentes ou sessões temporárias.
• Envie ações de sinal como curtidas, cliques, etc. para atualizar as incorporações do usuário em tempo real.
• Pegue lotes personalizados de dados adaptados às incorporações de cada usuário.
• Suporte para múltiplas integrações de banco de dados vetorial: Pinecone, Weaviate, etc.
• Algoritmos internos para casos de uso de personalização comuns.

Para obter mais informações, consulte o Guia de incorporação do usuário ou a documentação do SDK.

Instalação

Instale o pacote do NPM:

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

Uso

O FirstBatch SDK é usado em conjunto com uma loja de vetores existente, onde você registra o Vector Store no nosso SDK e cria sessões de personalização.

Adicionando um cliente

Primeiro, inicialize um banco de dados vetorial de sua escolha; Nosso SDK suporta:

• Pinecone
• Tecelava
• TieSens (trabalho em andamento)
• Supabase (trabalho em andamento)

Vamos analisar um exemplo usando o 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' ) ;

Em seguida, crie uma loja de vetores com este índice e passe -o no 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 ) ;

Personalização

Agora, podemos criar uma sessão com um algoritmo adequado ao nosso caso de uso e fornecer personalização aos nossos usuários.

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

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

Suponha que o usuário tenha gostado do primeiro conteúdo do batch acima. Podemos fornecer personalização sobre isso da seguinte maneira:

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

Aqui, LIKE o Signal é um dos muitos sinais predefinidos fornecidos pelo nosso SDK. Você também pode definir seus próprios sinais:

 import type { Signal } from 'firstbatch' ;

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

Prédio

Instale as dependências:

bun install

Então, construa tudo com:

bun run build
bun b # alternative 

Observação

Se você receber um erro como "chave de conteúdo esperada ... existir", basta excluir a pasta .parcel-cache e criar novamente.

Teste

Execute todos os testes via:

bun run test
bun t # alternative

O BUN procurará .env.test durante os testes.

Estilo

Verifique a formatação:

bun format

TILE TUDO:

bun lint