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: doc/source/semantic_indexes.rst
+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
@@ -1,4 +1,4 @@
1
-
.. _Semantic Indexes:
1
+
.. _Semantic Indexes:
2
2
3
3
==================================
4
4
Semantic Indexes
@@ -7,12 +7,12 @@ Semantic Indexes
7
7
Full Text Index
8
8
----------------
9
9
From version 6.0.0 neomodel provides a way to interact with neo4j `Full Text indexing <https://neo4j.com/docs/cypher-manual/current/indexes/semantic-indexes/full-text-indexes/>`_.
10
-
The Full Text Index can be be created for both node and relationship properties. Only available for Neo4j version 5.16 or higher.
10
+
The Full Text Index can be created for both node and relationship properties. Only available for Neo4j version 5.16 or higher.
11
11
12
12
Defining a Full Text Index on a Property
13
13
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
14
Within neomodel, indexing is a decision that is made at class definition time as the index needs to be built. A Full Text index is defined using :class:`~neomodel.properties.FulltextIndex`
15
-
To define a property with a full text index we use the following symantics::
15
+
To define a property with a full text index we use the following syntax::
@@ -54,13 +54,13 @@ The :class:`~neomodel.semantic_filters.FulltextFilter` can be used in conjunctio
54
54
55
55
.. attention::
56
56
If you use FulltextFilter in conjunction with normal filter types, only nodes that fit the filters will return thus, you may get less than the topk specified.
57
-
Furthermore, all node filters **should** work with FulltextFilter, relationship filters will also work but WILL NOT return the fulltext similiarty score alongside the relationship filter, instead the topk nodes and their appropriate relationships will be returned.
57
+
Furthermore, all node filters **should** work with FulltextFilter, relationship filters will also work but WILL NOT return the fulltext similarity score alongside the relationship filter, instead the topk nodes and their appropriate relationships will be returned.
58
58
59
59
RelationshipProperty
60
60
^^^^^^^^^^^^^^^^^^^^
61
61
62
62
Currently neomodel has not implemented an OGM method for querying full text indexes on relationships.
63
-
If this is something that you like please submit a github issue requirements highlighting your usage pattern.
63
+
If this is something that you would like, please submit a GitHub issue with requirements highlighting your usage pattern.
64
64
65
65
Alternatively, whilst this has not been implemented yet you can still leverage `db.cypher_query` with the correct syntax to perform your required query.
66
66
@@ -74,20 +74,20 @@ Defining a Vector Index on a Property
74
74
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
75
76
76
Within neomodel, indexing is a decision that is made at class definition time as the index needs to be built. A vector index is defined using :class:`~neomodel.properties.VectorIndex`.
77
-
To define a property with a vector index we use the following symantics::
77
+
To define a property with a vector index we use the following syntax::
Can be queried using :class:`~neomodel.semantic_filters.VectorFilter`. Such as::
@@ -111,11 +111,11 @@ The :class:`~neomodel.semantic_filters.VectorFilter` can be used in conjunction
111
111
112
112
.. attention::
113
113
If you use VectorFilter in conjunction with normal filter types, only nodes that fit the filters will return thus, you may get less than the topk specified.
114
-
Furthermore, all node filters **should** work with VectorFilter, relationship filters will also work but WILL NOT return the vector similiarty score alongside the relationship filter, instead the topk nodes and their appropriate relationships will be returned.
114
+
Furthermore, all node filters **should** work with VectorFilter, relationship filters will also work but WILL NOT return the vector similarity score alongside the relationship filter, instead the topk nodes and their appropriate relationships will be returned.
115
115
116
116
RelationshipProperty
117
117
^^^^^^^^^^^^^^^^^^^^
118
118
Currently neomodel has not implemented an OGM method for querying vector indexes on relationships.
119
-
If this is something that you like please submit a github issue requirements highlighting your usage pattern.
119
+
If this is something that you would like, please submit a GitHub issue with requirements highlighting your usage pattern.
120
120
121
121
Alternatively, whilst this has not been implemented yet you can still leverage `db.cypher_query` with the correct syntax to perform your required query.
0 commit comments