Skip to content

Commit

Permalink
Fixes for asciidoc files of vector db integration (neo4j-contrib#4107)
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Hunger <[email protected]>
  • Loading branch information
vga91 and jexp authored Jul 1, 2024
1 parent 1218242 commit 78d927b
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/asciidoc/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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.<key>.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]
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Besides the above config, the `apoc.vectordb.<type>.get` and the `apoc.vectordb.
|===


== Ad-hoc procedures
= Ad-hoc procedures

See the following pages for more details on specific vector db procedures

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
== Milvus

= Milvus

Here is a list of all available Milvus procedures:

Expand Down Expand Up @@ -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.<key>.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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
== Pinecone

= Pinecone

Here is a list of all available Pinecone procedures:

Expand Down Expand Up @@ -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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -36,7 +37,7 @@ where the 1st parameter can be a key defined by the apoc config `apoc.qdrant.<ke
With hostOrKey=null, the default is 'http://localhost:6333'.


=== Examples
== Examples

.Create a collection (it leverages https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/create_collection[this API])
[source,cypher]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
== Weaviate

= Weaviate

Here is a list of all available Weaviate procedures,
note that the list and the signature procedures are consistent with the others, like the Qdrant ones:
Expand Down Expand Up @@ -37,7 +38,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.weaviate.<key>.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]
Expand Down

0 comments on commit 78d927b

Please sign in to comment.