Skip to content

Commit 3d8af9d

Browse files
Document db.create.setRelationshipVectorProperty procedure (neo4j#1478)
Co-authored-by: NataliaIvakina <[email protected]>
1 parent 2622e92 commit 3d8af9d

File tree

1 file changed

+47
-10
lines changed

1 file changed

+47
-10
lines changed

modules/ROOT/pages/reference/procedures.adoc

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ For more information, see xref:authentication-authorization/dbms-administration.
8484
| label:yes[]
8585
| label:new[Introduced in 5.13] label:beta[]
8686

87+
| xref:reference/procedures.adoc#procedure_db.create.setRelationshipVectorProperty[`db.create.setRelationshipVectorProperty()`]
88+
| label:yes[]
89+
| label:yes[]
90+
| label:new[Introduced in 5.18] label:beta[]
91+
8792
| xref:reference/procedures.adoc#procedure_db_createlabel[`db.createLabel()`]
8893
| label:yes[]
8994
| label:yes[]
@@ -129,6 +134,11 @@ For more information, see xref:authentication-authorization/dbms-administration.
129134
| label:yes[]
130135
| label:new[Introduced in 5.11] label:beta[Beta until 5.13]
131136

137+
| xref:reference/procedures.adoc#procedure_db.index.vector.queryRelationships[`db.index.vector.queryRelationships()`]
138+
| label:yes[]
139+
| label:yes[]
140+
| label:new[Introduced in 5.18]
141+
132142
| xref:reference/procedures.adoc#procedure_db_info[`db.info()`]
133143
| label:yes[]
134144
| label:yes[]
@@ -831,7 +841,7 @@ a|xref:reference/procedures.adoc#procedure_db_cdc_query[`db.cdc.query()`]
831841
a|
832842
Returns the current change identifier that can be used to stream changes from.
833843
| Signature
834-
m|cdc.current() :: (id :: STRING)
844+
m|db.cdc.current() :: (id :: STRING)
835845
| Mode
836846
m|READ
837847
|===
@@ -846,7 +856,7 @@ m|READ
846856
a|
847857
Returns the earliest change identifier that can be used to stream changes from.
848858
| Signature
849-
m|cdc.earliest() :: (id :: STRING)
859+
m|db.cdc.earliest() :: (id :: STRING)
850860
| Mode
851861
m|READ
852862
|===
@@ -861,7 +871,7 @@ m|READ
861871
a|
862872
Query changes happened from the provided change identifier.
863873
| Signature
864-
m|cdc.query(from = :: STRING, selectors = [] :: LIST<MAP>) :: (id :: STRING, txId :: INTEGER, seq :: INTEGER, metadata :: MAP, event :: MAP)
874+
m|db.cdc.query(from = :: STRING, selectors = [] :: LIST<MAP>) :: (id :: STRING, txId :: INTEGER, seq :: INTEGER, metadata :: MAP, event :: MAP)
865875
| Mode
866876
m|READ
867877

@@ -967,11 +977,24 @@ m|DBMS
967977
a|
968978
Set a vector property on a given node in a more space efficient representation than Cypher’s link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`].
969979
| Signature
970-
m| db.create.setNodeVectorProperty(node :: NODE, key :: STRING, vector :: LIST<FLOAT>)
980+
m| db.create.setNodeVectorProperty(node :: NODE, key :: STRING, vector :: ANY)
971981
| Mode
972982
m|WRITE
973983
|===
974984

985+
[role=label--new-5.18 label--beta]
986+
[[procedure_db.create.setRelationshipVectorProperty]]
987+
.db.create.setRelationshipVectorProperty()
988+
[cols="<15s,<85"]
989+
|===
990+
| Description
991+
a|
992+
Set a vector property on a given relationship in a more space efficient representation than Cypher's link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`].
993+
| Signature
994+
m| db.create.setRelationshipVectorProperty(relationship :: RELATIONSHIP, key :: STRING, vector :: ANY)
995+
| Mode
996+
m|WRITE
997+
|===
975998

976999
[[procedure_db_create_setVectorProperty]]
9771000
[role=label--new-5.11 label--beta label--deprecated-5.13]
@@ -982,7 +1005,7 @@ m|WRITE
9821005
a|
9831006
Set a vector property on a given node in a more space efficient representation than Cypher’s link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`].
9841007
| Signature
985-
m| db.create.setVectorProperty(node :: NODE, key :: STRING, vector :: LIST<FLOAT>) :: (node :: NODE)
1008+
m| db.create.setVectorProperty(node :: NODE, key :: STRING, vector :: ANY) :: (node :: NODE)
9861009
| Mode
9871010
m|WRITE
9881011
| Replaced by
@@ -1152,7 +1175,22 @@ Query the given vector index.
11521175
Returns requested number of nearest neighbors to the provided query vector, and their similarity score to that query vector, based on the configured similarity function for the index.
11531176
The similarity score is a value between [0, 1]; where `0` indicates least similar, `1` most similar.
11541177
| Signature
1155-
m| db.index.vector.queryNodes(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: LIST<FLOAT>) :: (node :: NODE, score :: FLOAT)
1178+
m| db.index.vector.queryNodes(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: ANY) :: (node :: NODE, score :: FLOAT)
1179+
| Mode
1180+
m|READ
1181+
|===
1182+
1183+
[role=label--new-5.18]
1184+
[[procedure_db.index.vector.queryRelationships]]
1185+
.db.index.vector.queryRelationships()
1186+
[cols="<15s,<85"]
1187+
|===
1188+
| Description
1189+
a|
1190+
Query the given relationship vector index.
1191+
Returns requested number of nearest neighbors to the provided query vector, and their similarity score to that query vector, based on the configured similarity function for the index. The similarity score is a value between `[0, 1]`; where `0` indicates least similar, `1` most similar.
1192+
| Signature
1193+
m| db.index.vector.queryRelationships(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: ANY) :: (relationship :: RELATIONSHIP, score :: FLOAT)
11561194
| Mode
11571195
m|READ
11581196
|===
@@ -2246,12 +2284,9 @@ It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13)
22462284
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime].
22472285
====
22482286

2249-
2250-
22512287
[[procedure_genai_vector_encodeBatch]]
22522288
[role=label--aura label--new-5.17]
22532289
.genai.vector.encodeBatch()
2254-
22552290
[cols="<15s,<85"]
22562291
|===
22572292
| Description
@@ -2263,7 +2298,9 @@ For each element in the given resource LIST this returns:
22632298
* the original 'resource' element itself,
22642299
* and the encoded 'vector'
22652300
| Signature
2266-
m|genai.vector.encodeBatch(resources :: LIST<STRING>, provider :: STRING, configuration :: MAP = {}) :: (index :: INTEGER, resource :: STRING, vector :: LIST<FLOAT>)
2301+
m|genai.vector.encodeBatch(resources :: LIST<STRING>, provider :: STRING, configuration = {} :: MAP) :: (index :: INTEGER, resource :: STRING, vector :: ANY)
2302+
| Mode
2303+
m|DEFAULT
22672304
|===
22682305

22692306
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/genai-integrations/#multiple-embeddings[Cypher Manual -> Generating a batch of embeddings].

0 commit comments

Comments
 (0)