Skip to content

Commit 707eccb

Browse files
standardise procedure formatting to use () (#1389)
1 parent e1bdbc5 commit 707eccb

File tree

6 files changed

+53
-53
lines changed

6 files changed

+53
-53
lines changed

modules/ROOT/pages/clauses/call.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ RETURN count(*) AS results
208208
`YIELD` can be used to filter for specific results.
209209
This requires knowing the names of the arguments within a procedure's signature, which can either be found in the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/[Operations Manual -> Procedures] or in the `signature` column returned by a `SHOW PROCEDURES` command (see example below).
210210
211-
.Find the argument names of `db.propertyKeys`
211+
.Find the argument names of `db.propertyKeys()`
212212
[source, cypher]
213213
----
214214
SHOW PROCEDURES YIELD name, signature

modules/ROOT/pages/genai-integrations.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@ This function sends one API request every time it is called, which may result in
6565
If you want to generate many embeddings at once, use xref:genai-integrations.adoc#multiple-embeddings[].
6666

6767

68-
Use the `db.create.setNodeVectorProperty` procedure to store an embedding to a node property.
68+
Use the `db.create.setNodeVectorProperty()` procedure to store an embedding to a node property.
6969

70-
.Signature for `db.create.setNodeVectorProperty` label:procedure[]
70+
.Signature for `db.create.setNodeVectorProperty()` label:procedure[]
7171
[source,syntax]
7272
----
7373
db.create.setNodeVectorProperty(node :: NODE, key :: STRING, vector :: ANY)
7474
----
7575

76-
Use the `db.create.setRelationshipVectorProperty` procedure to store an embedding to a relationship property.
76+
Use the `db.create.setRelationshipVectorProperty()` procedure to store an embedding to a relationship property.
7777

78-
.Signature for `db.create.setRelationshipVectorProperty` label:procedure[]
78+
.Signature for `db.create.setRelationshipVectorProperty()` label:procedure[]
7979
[source,syntax]
8080
----
8181
db.create.setRelationshipVectorProperty(relationship :: RELATIONSHIP, key :: STRING, vector :: ANY)
@@ -122,14 +122,14 @@ This result only shows the first 4 of the 1536 numbers in the embedding.
122122
[[multiple-embeddings]]
123123
== Generating a batch of embeddings and store them
124124

125-
Use the `genai.vector.encodeBatch` procedure to generate many vector embeddings with a single API request.
125+
Use the `genai.vector.encodeBatch()` procedure to generate many vector embeddings with a single API request.
126126
This procedure takes a list of resources as an input, and returns the same number of result rows, instead of a single one.
127127

128128
[NOTE]
129129
This procedure attempts to generate embeddings for all supplied resources in a single API request.
130130
Therefore, it is recommended to see the respective provider's documentation for details on, for example, the maximum number of embeddings that can be generated per request.
131131

132-
.Signature for `genai.vector.encodeBatch` label:procedure[]
132+
.Signature for `genai.vector.encodeBatch()` label:procedure[]
133133
[source,syntax]
134134
----
135135
genai.vector.encodeBatch(resources :: LIST<STRING>, provider :: STRING, configuration :: MAP = {}) :: (index :: INTEGER, resource :: STRING, vector :: LIST<FLOAT>)
@@ -166,7 +166,7 @@ CALL db.create.setNodeVectorProperty(moviesList[index], 'embedding', vector) //
166166
167167
<1> xref:functions/aggregating.adoc#functions-collect[Collect] all 20 `Movie` nodes into a `LIST<NODE>`.
168168
<2> Use a xref:expressions/list-expressions.adoc#list-comprehension[list comprehension] (`[]`) to extract the `title` and `plot` properties of the movies in `moviesList` into a new `LIST<STRING>`.
169-
<3> `db.create.setNodeVectorProperty` is run for each `vector` returned by `genai.vector.encodeBatch`, and stores that vector as a property named `embedding` on the corresponding node.
169+
<3> `db.create.setNodeVectorProperty()` is run for each `vector` returned by `genai.vector.encodeBatch()`, and stores that vector as a property named `embedding` on the corresponding node.
170170
====
171171

172172
.Create embeddings from a large number of properties and store them
@@ -208,7 +208,7 @@ For an alternative method more suitable to processing large amounts of data, see
208208
== GenAI providers
209209

210210
The following GenAI providers are supported for generating vector embeddings.
211-
Each provider has its own configuration map that can be passed to `genai.vector.encode` or `genai.vector.encodeBatch`.
211+
Each provider has its own configuration map that can be passed to `genai.vector.encode()` or `genai.vector.encodeBatch()`.
212212

213213
[[vertex-ai]]
214214
=== Vertex AI

modules/ROOT/pages/indexes/semantic-indexes/full-text-indexes.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ OPTIONS {
124124

125125
<1> The `fulltext.analyzer` setting can be used to configure an index-specific analyzer.
126126
In this case, it is set to the `english` analyzer.
127-
The possible values for the `fulltext.analyzer` setting can be listed with the `db.index.fulltext.listAvailableAnalyzers` procedure.
127+
The possible values for the `fulltext.analyzer` setting can be listed with the `db.index.fulltext.listAvailableAnalyzers()` procedure.
128128
<2> The `fulltext.eventually_consistent` setting, if set to `true`, will put the index in an _eventually consistent_ update mode.
129129
This means that updates will be applied in a background thread "as soon as possible", instead of during a transaction commit, which is true for other indexes.
130130

@@ -134,13 +134,13 @@ For more information on how to configure full-text indexes, refer to the link:{n
134134
== Query full-text indexes
135135

136136
Unlike xref:indexes/search-performance-indexes/managing-indexes.adoc[search-performance indexes], full-text indexes are not automatically used by the xref:planning-and-tuning/execution-plans.adoc[Cypher query planner].
137-
To query a full-text index, use either the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes`] or the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships`] procedure.
137+
To query a full-text index, use either the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes()`] or the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships()`] procedure.
138138

139139
[NOTE]
140140
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
141141
To check the `state` of a full-text index -- whether it is `ONLINE` (usable) or `POPULATING` (still being built; the `populationPercent` column shows the progress of the index creation) -- run the following command: `SHOW FULLTEXT INDEXES`.
142142

143-
This query uses the `db.index.fulltext.queryNodes` to look for `nils` in the previously created full-text index `namesAndTeams`:
143+
This query uses the `db.index.fulltext.queryNodes()` procedure to look for `nils` in the previously created full-text index `namesAndTeams`:
144144

145145
.Query a full-text index for a node property
146146
[source, cypher]
@@ -172,7 +172,7 @@ This is possible because both the property values that are indexed, and the quer
172172

173173
The `score` results are always returned in _descending score order_, where the best matching result entry is put first.
174174

175-
This query uses the `db.index.fulltext.queryRelationships` to query the previously created `communications` full-text index for any `message` containing "meeting":
175+
This query uses the `db.index.fulltext.queryRelationships()` procedure to query the previously created `communications` full-text index for any `message` containing "meeting":
176176

177177
.Query a full-text index for a relationship property
178178
[source, cypher]
@@ -362,19 +362,19 @@ The procedures for full-text indexes are listed in the table below:
362362
| Usage | Procedure/Command | Description
363363

364364
| Eventually consistent indexes.
365-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_awaitEventuallyConsistentIndexRefresh[`db.index.fulltext.awaitEventuallyConsistentIndexRefresh`]
365+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_awaitEventuallyConsistentIndexRefresh[`db.index.fulltext.awaitEventuallyConsistentIndexRefresh()`]
366366
| Wait for the updates from recently committed transactions to be applied to any eventually-consistent full-text indexes.
367367

368368
| List available analyzers.
369-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_listAvailableAnalyzers[`db.index.fulltext.listAvailableAnalyzers`]
369+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_listAvailableAnalyzers[`db.index.fulltext.listAvailableAnalyzers()`]
370370
| List the available analyzers that the full-text indexes can be configured with.
371371

372372
| Use full-text node index.
373-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes`]
373+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_queryNodes[`db.index.fulltext.queryNodes()`]
374374
| Query the given full-text index. Returns the matching nodes and their Lucene query score, ordered by score.
375375

376376
| Use full-text relationship index.
377-
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships`]
377+
| https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_index_fulltext_queryRelationships[`db.index.fulltext.queryRelationships()`]
378378
| Query the given full-text index. Returns the matching relationships and their Lucene query score, ordered by score.
379379

380380
|===

modules/ROOT/pages/indexes/semantic-indexes/vector-indexes.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -180,13 +180,13 @@ Default value::: `100`
180180
[[query-vector-index]]
181181
== Query vector indexes
182182

183-
To query a node vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`] procedure.
183+
To query a node vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes()`] procedure.
184184

185185
[NOTE]
186186
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
187187
To check the `state` of a vector index -- whether it is `ONLINE` (usable) or `POPULATING` (still being built; the `populationPercent` column shows the progress of the index creation) -- run the following command: `SHOW VECTOR INDEXES`.
188188

189-
.Signature for `db.index.vector.queryNodes`
189+
.Signature for `db.index.vector.queryNodes()`
190190
[source,syntax]
191191
----
192192
db.index.vector.queryNodes(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: ANY) :: (node :: NODE, score :: FLOAT)
@@ -228,13 +228,13 @@ If the query vector itself is not wanted, adding the predicate `WHERE score < 1`
228228

229229
To query a relationship vector index, use the link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryRelationships[`db.index.vector.queryRelationships`] procedure.
230230

231-
.Signature for `db.index.vector.queryRelationships`
231+
.Signature for `db.index.vector.queryRelationships()`
232232
[source,syntax]
233233
----
234234
db.index.vector.queryRelationships(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: ANY) :: (relationship :: RELATIONSHIP, score :: FLOAT)
235235
----
236236

237-
`db.index.vector.queryRelationships` has the same argument descriptions as `db.index.vector.queryNodes`.
237+
`db.index.vector.queryRelationships()` has the same argument descriptions as `db.index.vector.queryNodes()`.
238238

239239
[TIP]
240240
Use xref:functions/vector.adoc[] to compute the similarity score between two specific vector pairs without using a vector index.
@@ -471,21 +471,21 @@ image::euclidean-similarity-equation.svg["The Euclidean of vector v and vector u
471471
| Usage | Procedure | Description
472472

473473
| Use node vector index.
474-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes`]
474+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryNodes[`db.index.vector.queryNodes()`]
475475
| Query the given node vector index.
476476
Returns the requested number of approximate nearest neighbor nodes and their similarity score, ordered by score.
477477

478478
| Use relationship vector index.
479-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryRelationships[`db.index.vector.queryRelationships`]
479+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_queryRelationships[`db.index.vector.queryRelationships()`]
480480
| Query the given relationship vector index.
481481
Returns the requested number of approximate nearest neighbor relationships and their similarity score, ordered by score.
482482

483483
| Set node vector property.
484-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty`]
484+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty()`]
485485
| Update a given node property with the given vector in a more space-efficient way than directly using xref:clauses/set.adoc#set-set-a-property[`SET`].
486486

487487
| Set relationship vector property.
488-
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setRelationshipVectorProperty[`db.create.setRelationshipVectorProperty`]
488+
| link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setRelationshipVectorProperty[`db.create.setRelationshipVectorProperty()`]
489489
| Update a given relationship property with the given vector in a more space-efficient way than directly using xref:clauses/set.adoc#set-set-a-property[`SET`].
490490

491491
|===
@@ -514,7 +514,7 @@ The following table lists the issues and, if fixed, the version in which they we
514514
|===
515515
| Known issues | Fixed in
516516

517-
| The creation of a vector index using the legacy procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`] may fail with an error in Neo4j 5.18 and later if the database was last written to with a version prior to Neo4j 5.11, and the legacy procedure is the first write operation used on the newer version.
517+
| The creation of a vector index using the legacy procedure link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex()`] may fail with an error in Neo4j 5.18 and later if the database was last written to with a version prior to Neo4j 5.11, and the legacy procedure is the first write operation used on the newer version.
518518
In Neo4j 5.20, the error was clarified.
519519
[TIP]
520520
--

modules/ROOT/pages/indexes/syntax.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ ON EACH “[“ r.propertyName[, ...] “]”
177177

178178
The following settings can be specified for full-text indexes:
179179

180-
* `fulltext.analyzer` - specifies what analyzer to use (the `db.index.fulltext.listAvailableAnalyzers` procedure lists what analyzers are available).
180+
* `fulltext.analyzer` - specifies what analyzer to use (the `db.index.fulltext.listAvailableAnalyzers()` procedure lists what analyzers are available).
181181
* `fulltext.eventually_consistent` - specifies whether a full-text index is eventually consistent.
182182
If set to `true`, it will ensure that updates from committing transactions are applied in a background thread.
183183

@@ -250,13 +250,13 @@ To use them, specific procedures must be called. Their signatures can be seen be
250250
[[query-full-text-index]]
251251
=== Full-text indexes
252252

253-
.Query full-text index on nodes: db.index.fulltext.queryNodes
253+
.Query full-text index on nodes: db.index.fulltext.queryNodes()
254254
[source,syntax]
255255
----
256256
CALL db.index.fulltext.queryNodes(indexName :: STRING, queryString :: STRING, options = {} :: MAP)
257257
----
258258

259-
.Query full-text index on relationships: db.index.fulltext.queryRelationships
259+
.Query full-text index on relationships: db.index.fulltext.queryRelationships()
260260
[source, syntax]
261261
----
262262
CALL db.index.fulltext.queryRelationships(indexName :: STRING, queryString :: STRING, options = {} :: MAP)
@@ -275,13 +275,13 @@ For more information, see xref:indexes/semantic-indexes/full-text-indexes.adoc#q
275275
[[query-vector-index]]
276276
=== Vector indexes
277277

278-
.Query vector-text index on nodes: db.index.vector.queryNodes
278+
.Query vector-text index on nodes: db.index.vector.queryNodes()
279279
[source,syntax]
280280
----
281281
CALL db.index.vector.queryNodes(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: LIST<INTEGER | FLOAT>)
282282
----
283283

284-
.Query vector-text index on relationships: db.index.vector.queryRelationships
284+
.Query vector-text index on relationships: db.index.vector.queryRelationships()
285285
[source,syntax]
286286
----
287287
CALL db.index.vector.queryRelationships(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: LIST<INTEGER | FLOAT>)

0 commit comments

Comments
 (0)