firstbatch sdk ts

FirstBatch SDK

FirstBatch SDKは、ベクトルデータベースを統合し、アプリケーションでパーソナライズされたAIエクスペリエンスを促進するためのインターフェイスを提供します。

• 永続的なIDまたは一時セッションでユーザーセッションをシームレスに管理します。
• いいね、クリックなどのような信号アクションを送信して、ユーザーの埋め込みをリアルタイムで更新します。
• 各ユーザーの埋め込みに合わせたデータのパーソナライズされたバッチを取得します。
• 複数のベクトルデータベース統合のサポート：Pinecone、Weaviateなど。
• 一般的なパーソナライズユースケースの組み込みアルゴリズム。

詳細については、ユーザーEmbedding GuideまたはSDKドキュメントを参照してください。

インストール

NPMからパッケージをインストールします。

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

使用法

FirstBatch SDKは、既存のVectorストアと一緒に使用され、ベクトルストアをSDKに登録し、そこからパーソナライズセッションを作成します。

クライアントの追加

まず、選択したベクトルデータベースを初期化します。私たちのSDKはサポートしています：

• 松ぼっくり
• 織ります
• タイプセンス（進行中の作業）
• 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 ) ;

ここでは、SDKが提供する多くのプリセット信号のLIKEつです。自分の信号を定義することもできます。

 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

BUNは、テスト中に.env.testを探します。

スタイリング

フォーマットを確認してください：

bun format

すべてを癒す：

bun lint