qdrant js

Bibliothèque JavaScript / TypeScript pour le moteur de recherche vectoriel QDrant.

Sdk JavaScript Qdrant

Ce référentiel contient des packages du SDK JS pour le moteur de recherche vectoriel QDRANT.

Il y a publié 3 packages:

• @qdrant/qdrant-js code - le package principal avec le SDK lui-même.
• @qdrant/js-client-rest Code - Client de repos léger pour QDRANT.
• @qdrant/js-client-grpc Code - Client GrpC pour QDRANT.

Exemples JS / TS

Installation

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

Usage

Exécutez le conteneur Docker QDrant:

docker run -p 6333:6333 qdrant/qdrant

Instancier un 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>' ,
} ) ;

Faire des demandes

Utilisation de l'une des méthodes de façade disponibles:

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

Plus d'exemples peuvent être trouvés dans le dossier examples .

Soutien

Les types de typeScript sont fournis parallèlement à des sources JavaScript à utiliser dans:

• Node.js (ESM et CJS) - >= 18.0.0
• Nez
• Navigateur (API Fetch)
• CloudFlare Workers (OpenAPI uniquement)

Sorties

Les versions majeures et mineures s'alignent sur les versions du moteur de QDRANT, tandis que le correctif est réservé aux correctifs concernant la version mineure actuelle. De nouvelles versions sont effectuées à partir de la branche master .

Contributif

Afin de contribuer, il y a quelques choses que vous devrez peut-être configurer. Nous utilisons pnpm au lieu de npm ou yarn pour gérer et installer des packages dans ce monorepo, assurez-vous qu'il est installé sur votre environnement local.

Après avoir vérifié le référentiel et la branche souhaitée, exécutez pnpm install pour installer toutes les dépendances du package et exécuter les étapes de compilation. Cela fonctionnera pour le Monorepo.

Pour tout en dehors du monorepo, par exemple: examples/node-js-basic n'hésitez pas à utiliser npm pour installer des packages et exécuter des scripts.