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

@orama/plugin-embeddings

v3.0.2

Published

Orama plugin for generating embeddings locally

Downloads

762

Readme

Orama Plugin Embeddings

Orama Plugin Embeddings allows you to generate fast text embeddings at insert and search time offline, directly on your machine - no OpenAI needed!

Installation

To get started with Orama Plugin Embeddings, just install it with npm:

npm i @orama/plugin-embeddings

Important note: to use this plugin, you'll also need to install one of the following TensorflowJS backend:

  • @tensorflow/tfjs
  • @tensorflow/tfjs-node
  • @tensorflow/tfjs-backend-webgl
  • @tensorflow/tfjs-backend-cpu
  • @tensorflow/tfjs-node-gpu
  • @tensorflow/tfjs-backend-wasm

For example, if you're running Orama on the browser, we highly recommend using @tensorflow/tfjs-backend-webgl:

npm i @tensorflow/tfjs-backend-webgl

If you're using Orama in Node.js, we recommend using @tensorflow/tfjs-node:

npm i @tensorflow/tfjs-node

Usage

import { create } from '@orama/orama'
import { pluginEmbeddings } from '@orama/plugin-embeddings'
import '@tensorflow/tfjs-node' // Or any other appropriate TensorflowJS backend

const plugin = await pluginEmbeddings({
  embeddings: {
    defaultProperty: 'embeddings', // Property used to store generated embeddings
    onInsert: {
      generate: true, // Generate embeddings at insert-time
      properties: ['description'], // properties to use for generating embeddings at insert time
      verbose: true,
    }
  }
})

const db = await create({
  schema: {
    description: 'string',
    embeddings: 'vector[512]' // Orama generates 512-dimensions vectors
  },
  plugins: [plugin]
})

Example usage at insert time:

await insert(db, {
  description: 'Classroom Headphones Bulk 5 Pack, Student On Ear Color Varieties'
})

await insert(db, {
  description: 'Kids Wired Headphones for School Students K-12'
})

await insert(db, {
  description: 'Kids Headphones Bulk 5-Pack for K-12 School'
})

await insert(db, {
  description: 'Bose QuietComfort Bluetooth Headphones'
})

Orama will automatically generate text embeddings and store them into the embeddings property.

Then, you can use the vector or hybrid setting to perform hybrid or vector search at runtime:

await search(db, {
  term: 'Headphones for 12th grade students',
  mode: 'vector'
})

Orama will generate embeddings at search time and perform vector or hybrid search for you.

License

Apache 2.0