firstbatch sdk ts

First Batch SDK

FirstBatch SDK提供了一個用於集成矢量數據庫並為您的應用程序中的個性化AI體驗供電的接口。

• 通過持續的ID或臨時會話無縫管理用戶會話。
• 發送信號操作，例如喜歡，點擊等，以實時更新用戶嵌入。
• 獲取針對每個用戶嵌入的個性化數據批次。
• 支持多個矢量數據庫集成：Pinecone，Weaviate等。
• 常見個性化用例的內置算法。

有關更多信息，請參見用戶嵌入指南或SDK文檔。

安裝

從NPM安裝軟件包：

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

用法

FirstBatch SDK與現有的矢量商店一起使用，在該商店中，您可以將矢量存儲庫註冊到我們的SDK，然後從中創建個性化會話。

添加客戶

首先，初始化您選擇的向量數據庫；我們的SDK支持：

• 松果
• 編織
• typesense（正在進行的工作）
• 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' ) ;

然後，使用此索引創建一個向量存儲，然後將其傳遞到第一批次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

BUN會在測試期間尋找.env.test 。

造型

檢查格式：

bun format

棉絨一切：

bun lint