From 6e0fa718abcaa5b5511055e82415ede6983a8038 Mon Sep 17 00:00:00 2001 From: Zineb Bendhiba Date: Mon, 6 Jan 2025 11:19:20 +0100 Subject: [PATCH] Add Qdrant document store documentation Fixes #450 --- docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/qdrant-store.adoc | 31 +++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/modules/ROOT/pages/qdrant-store.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index c62aa28b1..b299b825e 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -31,6 +31,7 @@ ** xref:in-process-embedding.adoc[In-Process Embeddings] ** xref:csv.adoc[Loading CSV files] ** xref:neo4j.adoc[Neo4j Store] +** xref:qdrant-store.adoc[Qdrant Store] * Additional tools ** xref:easy-rag.adoc[Easy RAG] diff --git a/docs/modules/ROOT/pages/qdrant-store.adoc b/docs/modules/ROOT/pages/qdrant-store.adoc new file mode 100644 index 000000000..8710e54eb --- /dev/null +++ b/docs/modules/ROOT/pages/qdrant-store.adoc @@ -0,0 +1,31 @@ += Qdrant Store for Retrieval Augmented Generation (RAG) + +include::./includes/attributes.adoc[] + +When implementing Retrieval Augmented Generation (RAG), a robust document store is crucial. This guide demonstrates how to leverage a https://qdrant.tech/[Qdrant] database as the document store. + +== Leveraging the Qdrant Document Store + +To make use of the Qdrant document store, you'll need to include the following dependency: + +[source,xml,subs=attributes+] +---- + + io.quarkiverse.langchain4j + quarkus-langchain4j-qdrant + +---- + +== Configuration Settings + +Customize the behavior of the extension by exploring various configuration options: + +include::includes/quarkus-langchain4j-qdrant.adoc[leveloffset=+1,opts=optional] + +== Dev Services +To use the Qdrant Dev Services, 3 configuration properties are required: + +* `quarkus.langchain4j.qdrant.devservices.service-name` which specifies the name of the collection to create +* `quarkus.langchain4j.qdrant.devservices.collection.vector-params.distance` which specifies the distance function used for comparing vectors +* `quarkus.langchain4j.qdrant.devservices.collection.vector-params.size` which specifies the size of the vectors. +