Qdrant

Author: cristianrgreco

docs/modules/qdrant.md

@@ -1,6 +1,4 @@
-# Qdrant Module
-
-[Qdrant](https://qdrant.tech/) is an open-source, high-performance vector search engine/database. It provides a production-ready service with a convenient API to store, search, and manage points (i.e. vectors) with an additional payload.
+# Qdrant
 
 ## Install
 
@@ -10,15 +8,29 @@ npm install @testcontainers/qdrant --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [@qdrant/js-client-rest](https://www.npmjs.com/package/@qdrant/js-client-rest)
+
+        npm install @qdrant/js-client-rest
+
+Choose an image from the [container registry](https://hub.docker.com/r/qdrant/qdrant) and substitute `IMAGE`.
+
+### Fetch collections
+
 <!--codeinclude-->
-[Connect to Qdrant:](../../packages/modules/qdrant/src/qdrant-container.test.ts)
+[](../../packages/modules/qdrant/src/qdrant-container.test.ts)
 inside_block:connectQdrantSimple
 <!--/codeinclude-->
 
+### With API key
+
 <!--codeinclude-->
-[Connect to Qdrant with an API key:](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithApiKey
+[](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithApiKey
 <!--/codeinclude-->
 
+### With config file
+
 <!--codeinclude-->
-[Customize Qdrant instance with a config file:](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithConfig
+[](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithConfig
 <!--/codeinclude-->

packages/modules/qdrant/src/qdrant-container.test.ts

@@ -7,27 +7,27 @@ import { QdrantContainer } from "./qdrant-container";
 const IMAGE = getImage(__dirname);
 
 describe("QdrantContainer", { timeout: 100_000 }, () => {
-  // connectQdrantSimple {
   it("should connect to the client", async () => {
+    // connectQdrantSimple {
     await using container = await new QdrantContainer(IMAGE).start();
 
     const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}` });
 
     expect((await client.getCollections()).collections.length).toBe(0);
+    // }
   });
-  // }
 
-  // connectQdrantWithApiKey {
   it("should work with valid API keys", async () => {
+    // connectQdrantWithApiKey {
     const apiKey = crypto.randomUUID();
 
     await using container = await new QdrantContainer(IMAGE).withApiKey(apiKey).start();
 
     const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}`, apiKey });
+    // }
 
     expect((await client.getCollections()).collections.length).toBe(0);
   });
-  // }
 
   it("should fail for invalid API keys", async () => {
     const apiKey = crypto.randomUUID();
@@ -42,17 +42,17 @@ describe("QdrantContainer", { timeout: 100_000 }, () => {
     await expect(client.getCollections()).rejects.toThrow("Unauthorized");
   });
 
-  // connectQdrantWithConfig {
   it("should work with config files - valid API key", async () => {
+    // connectQdrantWithConfig {
     await using container = await new QdrantContainer(IMAGE)
       .withConfigFile(path.resolve(__dirname, "test_config.yaml"))
       .start();
 
     const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}`, apiKey: "SOME_TEST_KEY" });
+    // }
 
     expect((await client.getCollections()).collections.length).toBe(0);
   });
-  // }
 
   it("should work with config files - invalid API key", async () => {
     await using container = await new QdrantContainer(IMAGE)