Skip to main content

USearch

Compatibility

Only available on Node.js.

USearch is a library for efficient similarity search and clustering of dense vectors.

Setup​

Install the usearch package, which is a Node.js binding for USearch.

npm install -S usearch
tip

See this section for general instructions on installing integration packages.

npm install @langchain/openai @langchain/community

Usage​

Create a new index from texts​

import { USearch } from "@langchain/community/vectorstores/usearch";
import { OpenAIEmbeddings } from "@langchain/openai";

const vectorStore = await USearch.fromTexts(
  ["Hello world", "Bye bye", "hello nice world"],
  [{ id: 2 }, { id: 1 }, { id: 3 }],
  new OpenAIEmbeddings()
);

const resultOne = await vectorStore.similaritySearch("hello world", 1);
console.log(resultOne);

API Reference:

Create a new index from a loader​

import { USearch } from "@langchain/community/vectorstores/usearch";
import { OpenAIEmbeddings } from "@langchain/openai";
import { TextLoader } from "langchain/document_loaders/fs/text";

// Create docs with a loader
const loader = new TextLoader("src/document_loaders/example_data/example.txt");
const docs = await loader.load();

// Load the docs into the vector store
const vectorStore = await USearch.fromDocuments(docs, new OpenAIEmbeddings());

// Search for the most similar document
const resultOne = await vectorStore.similaritySearch("hello world", 1);
console.log(resultOne);

API Reference:

Help us out by providing feedback on this documentation page: