npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

firstbatch

v0.1.8

Published

<p align="center"> <!-- <img src="https://raw.githubusercontent.com/firstbatchxyz/firstbatch-sdk-ts/master/logo.svg" alt="logo" width="142"> --> <img src="./logo.svg" alt="logo" width="142"> </p>

Downloads

3

Readme

  • [x] Seamlessly manage user sessions with persistent IDs or temporary sessions.
  • [x] Send signal actions like likes, clicks, etc. to update user embeddings in real-time.
  • [x] Fetch personalized batches of data tailored to each user's embeddings.
  • [x] Support for multiple vector database integrations: Pinecone, Weaviate, etc.
  • [x] Built-in algorithms for common personalization use cases.

For more information, see the User Embedding Guide or the SDK Documentation.

Installation

Install the package from NPM:

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

Usage

FirstBatch SDK is used together with an existing vector store, where you register the vector store to our SDK and then create personalization sessions from it.

Adding a Client

First, initialize a Vector Database of your choice; our SDK supports:

Let us go over an example using 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');

Then, create a Vector Store with this index and pass it in the 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);

Personalization

Now, we can create a session with an algorithm that suits our use-case, and provide personalization to our users.

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

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

Suppose that the user has liked the first content from the batch above. We can provide personalization over this as follows:

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

Here, LIKE signal is one of the many preset signals provided by our SDK. You can also define your own signals:

import type {Signal} from 'firstbatch';

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

Building

Install the dependencies:

bun install

Then, build everything with:

bun run build
bun b # alternative

[!NOTE]

If you get an error like "expected content key ... to exist" simply delete the .parcel-cache folder and build again.

Testing

Run all tests via:

bun run test
bun t # alternative

Bun will look for .env.test during the tests.

Styling

Check formatting:

bun format

Lint everything:

bun lint