You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clauses/call.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -208,7 +208,7 @@ RETURN count(*) AS results
208
208
`YIELD` can be used to filter for specific results.
209
209
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).
@@ -125,14 +129,14 @@ This result only shows the first 4 of the 1536 numbers in the embedding.
125
129
[[multiple-embeddings]]
126
130
== Generating a batch of embeddings and store them
127
131
128
-
Use the `genai.vector.encodeBatch` procedure to generate many vector embeddings with a single API request.
132
+
Use the `genai.vector.encodeBatch()` procedure to generate many vector embeddings with a single API request.
129
133
This procedure takes a list of resources as an input, and returns the same number of result rows, instead of a single one.
130
134
131
135
[NOTE]
132
136
This procedure attempts to generate embeddings for all supplied resources in a single API request.
133
137
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.
134
138
135
-
.Signature for `genai.vector.encodeBatch` label:procedure[]
139
+
.Signature for `genai.vector.encodeBatch()` label:procedure[]
<1> xref:functions/aggregating.adoc#functions-collect[Collect] all 20 `Movie` nodes into a `LIST<NODE>`.
171
175
<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>`.
172
-
<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.
176
+
<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.
173
177
====
174
178
175
179
.Create embeddings from a large number of properties and store them
@@ -212,7 +216,7 @@ For an alternative method more suitable to processing large amounts of data, see
212
216
== GenAI providers
213
217
214
218
The following GenAI providers are supported for generating vector embeddings.
215
-
Each provider has its own configuration map that can be passed to `genai.vector.encode` or `genai.vector.encodeBatch`.
219
+
Each provider has its own configuration map that can be passed to `genai.vector.encode()` or `genai.vector.encodeBatch()`.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/indexes/semantic-indexes/full-text-indexes.adoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ OPTIONS {
125
125
126
126
<1> The `fulltext.analyzer` setting can be used to configure an index-specific analyzer.
127
127
In this case, it is set to the `english` analyzer.
128
-
The possible values for the `fulltext.analyzer` setting can be listed with the `db.index.fulltext.listAvailableAnalyzers` procedure.
128
+
The possible values for the `fulltext.analyzer` setting can be listed with the `db.index.fulltext.listAvailableAnalyzers()` procedure.
129
129
<2> The `fulltext.eventually_consistent` setting, if set to `true`, will put the index in an _eventually consistent_ update mode.
130
130
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.
131
131
@@ -135,13 +135,13 @@ For more information on how to configure full-text indexes, refer to the link:{n
135
135
== Query full-text indexes
136
136
137
137
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].
138
-
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.
138
+
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.
139
139
140
140
[NOTE]
141
141
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
142
142
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`.
143
143
144
-
This query uses the `db.index.fulltext.queryNodes` to look for `nils` in the previously created full-text index `namesAndTeams`:
144
+
This query uses the `db.index.fulltext.queryNodes()` procedure to look for `nils` in the previously created full-text index `namesAndTeams`:
145
145
146
146
.Query a full-text index for a node property
147
147
[source, cypher]
@@ -173,7 +173,7 @@ This is possible because both the property values that are indexed, and the quer
173
173
174
174
The `score` results are always returned in _descending score order_, where the best matching result entry is put first.
175
175
176
-
This query uses the `db.index.fulltext.queryRelationships` to query the previously created `communications` full-text index for any `message` containing "meeting":
176
+
This query uses the `db.index.fulltext.queryRelationships()` procedure to query the previously created `communications` full-text index for any `message` containing "meeting":
177
177
178
178
.Query a full-text index for a relationship property
179
179
[source, cypher]
@@ -363,19 +363,19 @@ The procedures for full-text indexes are listed in the table below:
Copy file name to clipboardExpand all lines: modules/ROOT/pages/indexes/semantic-indexes/vector-indexes.adoc
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -194,13 +194,13 @@ Default value::: `100`
194
194
[[query-vector-index]]
195
195
== Query vector indexes
196
196
197
-
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.
197
+
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.
198
198
199
199
[NOTE]
200
200
An index cannot be used while its `state` is `POPULATING`, which occurs immediately after it is created.
201
201
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`.
@@ -242,13 +242,13 @@ If the query vector itself is not wanted, adding the predicate `WHERE score < 1`
242
242
243
243
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.
244
244
245
-
.Signature for `db.index.vector.queryRelationships` label:new[Introduced in 5.18]
245
+
.Signature for `db.index.vector.queryRelationships()` label:new[Introduced in 5.18]
| 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`]. Replaces link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty`]. label:beta[] label:new[Introduced in 5.13]
| 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`]. Replaces link:{neo4j-docs-base-uri}/operations-manual/current/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty()`]. label:beta[] label:new[Introduced in 5.13]
| 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`]. label:beta[] label:new[Introduced in 5.18]
511
511
512
512
|===
@@ -535,7 +535,7 @@ The following table lists the issues and, if fixed, the version in which they we
535
535
|===
536
536
| Known issues | Fixed in
537
537
538
-
| 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.
538
+
| 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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/indexes/syntax.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -177,7 +177,7 @@ ON EACH “[“ r.propertyName[, ...] “]”
177
177
178
178
The following settings can be specified for full-text indexes:
179
179
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).
181
181
* `fulltext.eventually_consistent` - specifies whether a full-text index is eventually consistent.
182
182
If set to `true`, it will ensure that updates from committing transactions are applied in a background thread.
183
183
@@ -250,13 +250,13 @@ To use them, specific procedures must be called. Their signatures can be seen be
250
250
[[query-full-text-index]]
251
251
=== Full-text indexes
252
252
253
-
.Query full-text index on nodes: db.index.fulltext.queryNodes
253
+
.Query full-text index on nodes: db.index.fulltext.queryNodes()
0 commit comments