Skip to content

[Cherry-pick][7.x] Merge pull request #182 from neo4j/update-vector-docs #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2024
Merged

[Cherry-pick][7.x] Merge pull request #182 from neo4j/update-vector-docs #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/ROOT/pages/directives/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Particularly useful for types that are not correctly pluralized or are non-Engli
| Indicates that there should be a uniqueness constraint in the database for the fields that it is applied to.

| xref::/directives/indexes-and-constraints.adoc#_vector_index_search[`@vector`]
| Perform a vector index search on your database either based by passing in a vector index or a search phrase. label:beta[]
| Perform a vector index search on your database either based by passing in a vector index or a search phrase.

|===

Expand Down Expand Up @@ -149,4 +149,4 @@ of any required fields that is passed as arguments to the custom resolver.
| xref:/integrations/relay-compatibility.adoc[`@relayId`]
| Specifies that the field should be used as the global node identifier for Relay.

|===
|===
33 changes: 14 additions & 19 deletions modules/ROOT/pages/directives/indexes-and-constraints.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,6 @@ await neoSchema.assertIndexesAndConstraints();

:description: Directives related to generative AI in the Neo4j GraphQL Library.

[role=label--beta]
== Vector index search

With the `@vector` GraphQL directive you can query your database to perform a vector index search.
Expand Down Expand Up @@ -331,15 +330,13 @@ This defines the query to be performed on all `Product` nodes which have a vecto
----
query FindSimilarProducts($vector: [Float]!) {
searchByDescription(vector: $vector) {
productsConnection {
edges {
cursor
score
node {
id
name
description
}
edges {
cursor
score
node {
id
name
description
}
}
}
Expand Down Expand Up @@ -415,15 +412,13 @@ This defines the query to be performed on all `Product` nodes which have a vecto
----
query SearchProductsByPhrase($phrase: String!) {
searchByPhrase(phrase: $phrase) {
productsConnection {
edges {
cursor
score
node {
id
name
description
}
edges {
cursor
score
node {
id
name
description
}
}
}
Expand Down