Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 3.56 KB

README.md

File metadata and controls

94 lines (65 loc) · 3.56 KB
Raw

Qdrant   Qdrant

JavaScript/TypeScript library for the Qdrant vector search engine.

npm version OpenAPI Docs Apache 2.0 License Discord Roadmap 2023

JavaScript Qdrant SDK

This repository contains packages of the JS SDK for the Qdrant vector search engine.

There are published 3 packages:

JS/TS Examples

Installation

pnpm i @qdrant/js-client-rest
# or
npm install @qdrant/js-client-rest
# or
yarn add @qdrant/js-client-rest

Usage

Run the Qdrant Docker container:

docker run -p 6333:6333 qdrant/qdrant

Instantiate a client

import {QdrantClient} from '@qdrant/js-client-rest';

// TO connect to Qdrant running locally
const client = new QdrantClient({url: 'http://127.0.0.1:6333'});

// or connect to Qdrant Cloud
const client = new QdrantClient({
    url: 'https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.us-east-0-1.aws.cloud.qdrant.io',
    apiKey: '<your-api-key>',
});

Make requests

Using one of the available facade methods:

const result = await client.getCollections();
console.log('List of collections:', result.collections);

More examples can be found in the examples folder.

Support

TypeScript types are provided alongside JavaScript sources to be used in:

  • Node.js (ESM and CJS) - >= 18.0.0
  • Deno
  • Browser (fetch API)
  • Cloudflare Workers (OpenAPI only)

Releases

Major and minor versions align with Qdrant's engine releases, whilst patch are reserved for fixes regarding the current minor release. New releases are made from the master branch.

Contributing

In order to contribute there are a couple of things you may need to setup. We make use of pnpm instead of npm or yarn to manage and install packages in this monorepo, make sure it's installed on your local environment.

After checking out the repository and desired branch, run pnpm install to install all package's dependencies and run the compilation steps. This will work for the monorepo.

For anything outside the monorepo, e.g.: examples/node-js-basic feel free to use npm for installing packages and running scripts.