Skip to content

Commit ce0d4d5

Browse files
committed
added a code listing for feature configuration and a version requirement in the introduction page
1 parent db9447f commit ce0d4d5

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

modules/ROOT/pages/directives/indexes-and-constraints.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,25 @@ input VectorIndexInput {
306306
If the optional field `provider` is set, the type is used for a query by phrase, otherwise for a query by vector.
307307
Allowed values for the `provider` field are defined by the available link:https://neo4j.com/docs/cypher-manual/current/indexes/semantic-indexes/vector-indexes/[GenAI providers].
308308

309+
Additionally, add the following feature configuration when you are using queries by phrase and the GenAI plugin:
310+
311+
[source, graphql]
312+
----
313+
const neoSchema = new Neo4jGraphQL({
314+
typeDefs,
315+
driver,
316+
features: {
317+
vector: {
318+
OpenAI: {
319+
token: "my-open-ai-token",
320+
model: "text-embedding-3-small",
321+
},
322+
},
323+
},
324+
});
325+
----
326+
327+
309328
=== Usage
310329

311330
==== Query by vector index

modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ Additionally, prerelease version numbers may have additional suffixes, for examp
6969

7070
== Requirements
7171

72-
. https://neo4j.com/[Neo4j Database] version 4.4 and newer with https://neo4j.com/docs/apoc/current/[APOC] plugin.
72+
. https://neo4j.com/[Neo4j Database] version 4.4 or newer with https://neo4j.com/docs/apoc/current/[APOC] plugin.
73+
. Neo4j version 5.15 or newer when you are using the xref:/directives/indexes-and-constraints.adoc#_vector_index_search[`@vector` directive].
7374
. https://nodejs.org/en/[Node.js] 16+.
7475

7576
== Resources

0 commit comments

Comments
 (0)