Qdrant向量搜索引擎的JavaScript/TypeScript开发工具包
qdrant-js是Qdrant向量搜索引擎的JavaScript/TypeScript开发工具包。它包含qdrant-js、js-client-rest和js-client-grpc三个主要模块,分别提供核心SDK、REST客户端和gRPC客户端功能。该工具包支持Node.js、Deno、浏览器和Cloudflare Workers等多种环境,并提供简洁的API,方便开发者与Qdrant引擎进行交互和集成。
这个仓库包含了Qdrant向量搜索引擎的JS SDK包。
已发布的3个包:
@qdrant/qdrant-js
代码 - 包含SDK本身的主要包。@qdrant/js-client-rest
代码 - Qdrant的轻量级REST客户端。@qdrant/js-client-grpc
代码 - Qdrant的gRPC客户端。pnpm i @qdrant/js-client-rest # 或 npm install @qdrant/js-client-rest # 或 yarn add @qdrant/js-client-rest
运行Qdrant Docker容器:
docker run -p 6333:6333 qdrant/qdrant
import {QdrantClient} from '@qdrant/js-client-rest'; // 连接到本地运行的Qdrant const client = new QdrantClient({url: 'http://127.0.0.1:6333'}); // 或连接到Qdrant Cloud const client = new QdrantClient({ url: 'https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.us-east-0-1.aws.cloud.qdrant.io', apiKey: '<你的api密钥>', });
使用其中一个可用的外观方法:
const result = await client.getCollections(); console.log('集合列表:', result.collections);
更多示例可以在examples
文件夹中找到。
TypeScript类型与JavaScript源代码一起提供,可用于:
>= 18.0.0
主版本和次版本与Qdrant引擎的发布保持一致,而补丁版本则用于当前次版本的修复。新版本从master
分支发布。
为了贡献,你可能需要设置一些东西。我们使用pnpm
而不是npm
或yarn
来管理和安装这个monorepo中的包,请确保它已安装在你的本地环境中。
检出仓库和所需分支后,运行pnpm install
安装所有包的依赖并运行编译步骤。这将适用于整个monorepo。
对于monorepo之外的任何内容,例如:
examples/node-js-basic
,可以随意使用npm
来安装包和运行脚本。