firstbatch sdk ts

FirstBatch SDK

FirstBatch SDK предоставляет интерфейс для интеграции векторных баз данных и питания персонализированного опыта искусственного интеллекта в вашем приложении.

• Бессвободно управлять пользовательскими сеансами с постоянными идентификаторами или временными сессиями.
• Отправляйте действия сигналов, такие как лайки, клики и т. Д., Чтобы обновить вставки пользователей в режиме реального времени.
• Принесите персонализированные партии данных, адаптированные к встраиванию каждого пользователя.
• Поддержка интеграций с несколькими векторными базами данных: Pinecone, Weaviate и т. Д.
• Встроенные алгоритмы для общих вариантов использования персонализации.

Для получения дополнительной информации см. Руководство по внедрению пользователя или документацию SDK.

Установка

Установите пакет из NPM:

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

Использование

FirstBatch SDK используется вместе с существующим векторным магазином, где вы регистрируете векторный магазин в нашу SDK, а затем создаете из него сеансы персонализации.

Добавление клиента

Во -первых, инициализируйте векторную базу данных по вашему выбору; Наша SDK поддерживает:

• Pinecone
• Укоренившись
• Типы (работа в процессе)
• Supabase (работа в процессе)

Давайте перейдем к примеру, используя 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' ) ;

Затем создайте векторный хранилище с этим индексом и передайте его в 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 ) ;

Персонализация

Теперь мы можем создать сеанс с алгоритмом, который подходит для нашего использования и предоставить персонализацию нашим пользователям.

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

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

Предположим, что пользователю понравился первый контент из приведенной выше batch . Мы можем обеспечить персонализацию над этим следующим образом:

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

Здесь, LIKE сигнал, является одним из многих предустановленных сигналов, предоставленных нашим SDK. Вы также можете определить свои собственные сигналы:

 import type { Signal } from 'firstbatch' ;

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

Здание

Установите зависимости:

bun install

Затем постройте все с помощью:

bun run build
bun b # alternative 

Примечание

Если вы получите такую ​​ошибку, как «ожидаемый ключ контента ... чтобы существовать», просто удалите папку .parcel-cache и создайте снова.

Тестирование

Запустите все тесты через:

bun run test
bun t # alternative

Булочка будет искать .env.test во время тестов.

Стиль

Проверьте форматирование:

bun format

Все проведите:

bun lint