<p align="center"> <img height="100" src="https://yellow-cdn.veclightyear.com/2b54e442/a5bad999-6e3d-4e63-8f0b-2d28a927142e.svg" alt="Qdrant"> &nbsp; <img height="80" src="https://yellow-cdn.veclightyear.com/2b54e442/fe409c21-fd9d-4324-bcfd-eeea030fdac9.svg" alt="Qdrant"> </p> <p align="center"> <b><a href="https://github.com/qdrant/qdrant">Qdrant</a>向量搜索引擎的JavaScript/TypeScript库。</b> </p> <p align="center"> <a href="https://www.npmjs.com/package/@qdrant/qdrant-js"><img src="https://yellow-cdn.veclightyear.com/2b54e442/71a6e7b0-b435-4d5d-b3a2-4cfe2dc1e03b.svg" alt="npm版本" height="18"></a> <a href="https://qdrant.github.io/qdrant/redoc/index.html"><img src="https://img.shields.io/badge/文档-OpenAPI%203.0-success" alt="OpenAPI文档"></a> <a href="https://github.com/qdrant/qdrant-client/blob/master/LICENSE"><img src="https://img.shields.io/badge/许可证-Apache%202.0-success" alt="Apache 2.0许可证"></a> <a href="https://qdrant.to/discord"><img src="https://yellow-cdn.veclightyear.com/2b54e442/a2936d3c-799a-440e-8e97-1b544796d0a7.svg?logo=discord" alt="Discord"></a> <a href="https://qdrant.to/roadmap"><img src="https://yellow-cdn.veclightyear.com/2b54e442/8ee32b89-b007-4cca-9dc0-9cd1e9b143ab.svg" alt="2023路线图"></a> </p>

JavaScript Qdrant SDK

这个仓库包含了Qdrant向量搜索引擎的JS SDK包。

已发布的3个包：

• @qdrant/qdrant-js 代码 - 包含SDK本身的主要包。
• @qdrant/js-client-rest 代码 - Qdrant的轻量级REST客户端。
• @qdrant/js-client-grpc 代码 - Qdrant的gRPC客户端。

JS/TS示例

安装

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源代码一起提供，可用于：

• Node.js (ESM和CJS) - >= 18.0.0
• Deno
• 浏览器 (fetch API)
• Cloudflare Workers (仅OpenAPI)

发布

主版本和次版本与Qdrant引擎的发布保持一致，而补丁版本则用于当前次版本的修复。新版本从master分支发布。

贡献

为了贡献，你可能需要设置一些东西。我们使用pnpm而不是npm或yarn来管理和安装这个monorepo中的包，请确保它已安装在你的本地环境中。

检出仓库和所需分支后，运行pnpm install安装所有包的依赖并运行编译步骤。这将适用于整个monorepo。

对于monorepo之外的任何内容，例如：examples/node-js-basic，可以随意使用npm来安装包和运行脚本。