From 78d927b7a0f107c1816164545a9e0738595b9fc4 Mon Sep 17 00:00:00 2001 From: Giuseppe Villani Date: Mon, 1 Jul 2024 13:05:04 +0200 Subject: [PATCH] Fixes for asciidoc files of vector db integration (#4107) Co-authored-by: Michael Hunger --- docs/asciidoc/modules/ROOT/nav.adoc | 2 +- .../ROOT/pages/database-integration/vectordb/chroma.adoc | 5 +++-- .../ROOT/pages/database-integration/vectordb/custom.adoc | 4 ++-- .../ROOT/pages/database-integration/vectordb/index.adoc | 4 ++-- .../ROOT/pages/database-integration/vectordb/milvus.adoc | 5 +++-- .../ROOT/pages/database-integration/vectordb/pinecone.adoc | 5 +++-- .../ROOT/pages/database-integration/vectordb/qdrant.adoc | 5 +++-- .../ROOT/pages/database-integration/vectordb/weaviate.adoc | 5 +++-- 8 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/asciidoc/modules/ROOT/nav.adoc b/docs/asciidoc/modules/ROOT/nav.adoc index ed04ea5040..ef3ac084a5 100644 --- a/docs/asciidoc/modules/ROOT/nav.adoc +++ b/docs/asciidoc/modules/ROOT/nav.adoc @@ -39,7 +39,7 @@ include::partial$generated-documentation/nav.adoc[] ** xref::database-integration/bolt-neo4j.adoc[] ** xref::database-integration/load-ldap.adoc[] ** xref::database-integration/redis.adoc[] - ** xref:database-integration/vectordb/index.adoc[] + ** xref::database-integration/vectordb/index.adoc[] * xref:graph-updates/index.adoc[] ** xref::graph-updates/uuid.adoc[] diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/chroma.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/chroma.adoc index 8e064db1d6..d135220f49 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/chroma.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/chroma.adoc @@ -1,4 +1,5 @@ -== ChromaDB + += ChromaDB Here is a list of all available ChromaDB procedures, note that the list and the signature procedures are consistent with the others, like the Qdrant ones: @@ -35,7 +36,7 @@ note that the list and the signature procedures are consistent with the others, where the 1st parameter can be a key defined by the apoc config `apoc.chroma..host=myHost`. With hostOrKey=null, the default is 'http://localhost:8000'. -=== Examples +== Examples .Create a collection (it leverages https://docs.trychroma.com/usage-guide#creating-inspecting-and-deleting-collections[this API]) [source,cypher] diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/custom.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/custom.adoc index 730bad15e8..9344ed8b83 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/custom.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/custom.adoc @@ -1,5 +1,5 @@ -== Custom (i.e. other vector databases) += Custom (i.e. other vector databases) We can also interface with other db vectors that do not (yet) have dedicated procedures. For example, with https://docs.pinecone.io/guides/getting-started/overview[Pinecone], as we will see later. @@ -15,7 +15,7 @@ returning a result like the others `apoc.vectordb.*.get` ones |=== -=== Examples +== Examples The `apoc.vectordb.custom.get` can be used with every API that return something like this diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/index.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/index.adoc index d649284cca..4f1c537260 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/index.adoc @@ -42,7 +42,7 @@ Besides the above config, the `apoc.vectordb..get` and the `apoc.vectordb. |=== -== Ad-hoc procedures += Ad-hoc procedures See the following pages for more details on specific vector db procedures @@ -53,7 +53,7 @@ See the following pages for more details on specific vector db procedures - xref:./milvus.adoc[Milvus] -== Store Vector db info (i.e. `apoc.vectordb.configure`) += Store Vector db info (i.e. `apoc.vectordb.configure`) We can save some info in the System Database to be reused later, that is the host, login credentials, and mapping, to be used in `*.get` and `.*query` procedures, except for the `apoc.vectordb.custom.get` one. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/milvus.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/milvus.adoc index 6bbe4b9ac9..11fac11124 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/milvus.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/milvus.adoc @@ -1,4 +1,5 @@ -== Milvus + += Milvus Here is a list of all available Milvus procedures: @@ -34,7 +35,7 @@ Here is a list of all available Milvus procedures: where the 1st parameter can be a key defined by the apoc config `apoc.milvus..host=myHost`. With hostOrKey=null, the default host is 'http://localhost:19530'. -=== Examples +== Examples Here is a list of example using a local installation using th default port `19531`. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/pinecone.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/pinecone.adoc index 2b45ac7530..8972ce404d 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/pinecone.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/pinecone.adoc @@ -1,4 +1,5 @@ -== Pinecone + += Pinecone Here is a list of all available Pinecone procedures: @@ -49,7 +50,7 @@ and equal to the host name, with the other ones, that is, the one indicated in t image::pinecone-index.png[width=800] -=== Examples +== Examples The following example assume we want to create and manage an index called `test-index`. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/qdrant.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/qdrant.adoc index e21917f9f7..e3e684861d 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/qdrant.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/vectordb/qdrant.adoc @@ -1,4 +1,5 @@ -== Qdrant + += Qdrant Here is a list of all available Qdrant procedures, note that the list and the signature procedures are consistent with the others, like the ChromaDB ones: @@ -36,7 +37,7 @@ where the 1st parameter can be a key defined by the apoc config `apoc.qdrant..host=myHost`. With hostOrKey=null, the default is 'http://localhost:8080/v1'. -=== Examples +== Examples .Create a collection (it leverages https://weaviate.io/developers/weaviate/api/rest#tag/schema/post/schema[this API]) [source,cypher]