qdrant js

QDRANTベクター検索エンジン用のJavaScript/TypeScriptライブラリ。

JavaScript QDRANT SDK

このリポジトリには、QDRANTベクター検索エンジン用のJS SDKのパッケージが含まれています。

公開された3つのパッケージがあります：

• @qdrant/qdrant-jsコード - SDK自体を備えたメインパッケージ。
• @qdrant/js-client-restコード - qdrant用の軽量休憩クライアント。
• @qdrant/js-client-grpcコード-GRPCクライアント用QDRANT。

JS/TSの例

インストール

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

使用法

QDRANT DOCKERコンテナを実行します。

docker run -p 6333:6333 qdrant/qdrant

クライアントをインスタンス化します

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

リクエストを行います

利用可能なファサード方法の1つを使用してください。

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

その他の例はexamplesフォルダーに記載されています。

サポート

タイプスクリプトタイプは、以下で使用するJavaScriptソースと一緒に提供されます。

• node.js（ESMおよびCJS） - >= 18.0.0
• デノ
• ブラウザ（FetchAPI）
• CloudFlare労働者（Openapiのみ）

リリース

主要バージョンとマイナーバージョンは、Qdrantのエンジンリリースに合わせていますが、パッチは現在のマイナーリリースに関する修正用に予約されています。新しいリリースはmasterブランチから作成されています。

貢献

貢献するためには、セットアップする必要があるかもしれないものがいくつかあります。 npmまたはyarnの代わりにpnpmを使用して、このモノレポでパッケージを管理およびインストールし、ローカル環境にインストールされていることを確認します。

リポジトリと希望のブランチをチェックアウトした後、 pnpm installを実行して、すべてのパッケージの依存関係をインストールし、コンパイル手順を実行します。これはモノレポで機能します。

モノレポ以外のものについては、例： examples/node-js-basicパッケージのインストールや実行の実行にnpmを使用してください。