qdrant js

JavaScript/TypeScription Bibliothek für die QDRant -Vektor -Suchmaschine.

JavaScript Qdrant SDK

Dieses Repository enthält Pakete des JS SDK für die QDrant -Vektor -Suchmaschine.

Es gibt 3 Pakete veröffentlicht:

• @qdrant/qdrant-js CODE- Das Hauptpaket mit dem SDK selbst.
• @qdrant/js-client-rest Code-Leichter REST-Client für QDRANT.
• @qdrant/js-client-grpc Code-GRPC-Client für QDRant.

JS/TS -Beispiele

Installation

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

Verwendung

Führen Sie den QDrant Docker -Container aus:

docker run -p 6333:6333 qdrant/qdrant

Einen Kunden instanziieren

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

Anfragen stellen

Verwenden einer der verfügbaren Fassadenmethoden:

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

Weitere Beispiele finden Sie im examples -Ordner.

Unterstützung

Typscript -Typen werden neben JavaScript -Quellen bereitgestellt, die verwendet werden sollen.

• Node.js (ESM und CJS) - >= 18.0.0
• Deno
• Browser (API abrufen)
• Cloudflare -Mitarbeiter (nur OpenAPI)

Veröffentlichungen

Dur- und kleinere Versionen entsprechen den Motorveröffentlichungen von QDrant, während Patch für Korrekturen in Bezug auf die aktuelle Nebenveröffentlichung reserviert ist. Neuveröffentlichungen werden aus dem master -Zweig erfolgen.

Beitragen

Um einen Beitrag zu leisten, müssen Sie möglicherweise einige Dinge einrichten. Wir verwenden pnpm anstelle von npm oder yarn , um Pakete in diesem Monorepo zu verwalten und zu installieren, und stellen Sie sicher, dass es in Ihrer lokalen Umgebung installiert ist.

Führen Sie nach dem Überprüfen des Repositorys und der gewünschten Niederlassung pnpm install aus, um alle Abhängigkeiten des Pakets zu installieren und die Kompilierungsschritte auszuführen. Dies wird für den Monorepo funktionieren.

Für alles außerhalb des Monorepo, z. B. examples/node-js-basic können Sie npm zum Installieren von Paketen und zum Ausführen von Skripten verwenden.