Skip to content

Commit 72c2757

Browse files
Fix docs
1 parent 9176a5e commit 72c2757

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/source/semantic_indexes.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _Semantic Indexes:
1+
.. _Semantic Indexes:
22

33
==================================
44
Semantic Indexes
@@ -7,12 +7,12 @@ Semantic Indexes
77
Full Text Index
88
----------------
99
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.
1111

1212
Defining a Full Text Index on a Property
1313
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1414
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::
1616
1717
StringProperty(fulltext_index=FulltextIndex(analyzer="standard-no-stop-words", eventually_consistent=False))
1818

@@ -54,13 +54,13 @@ The :class:`~neomodel.semantic_filters.FulltextFilter` can be used in conjunctio
5454

5555
.. attention::
5656
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.
5858

5959
RelationshipProperty
6060
^^^^^^^^^^^^^^^^^^^^
6161

6262
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.
6464

6565
Alternatively, whilst this has not been implemented yet you can still leverage `db.cypher_query` with the correct syntax to perform your required query.
6666

@@ -74,20 +74,20 @@ Defining a Vector Index on a Property
7474
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7575

7676
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::
7878

79-
ArrayProperty(base_property=FloatProperty(), vector_index=VectorIndex(dimensions=512, similarity_function="cosine")
79+
ArrayProperty(base_property=FloatProperty(), vector_index=VectorIndex(dimensions=512, similarity_function="cosine"))
8080
8181
Where,
8282
- ``dimensions``: The dimension of the vector. The default is 1536.
8383
- ``similarity_function``: The similarity algorithm to use. The default is ``cosine``.
8484

85-
The index must then be built, this occurs when the function :func:`~neomodel.sync_.core.install_all_labels` is run
85+
The index must then be built, this occurs when the function :func:`~neomodel.sync_.core.install_all_labels` is run.
8686

8787
The vector indexes will then have the name "vector_index_{node.__label__}_{propertyname_with_vector_index}".
8888

8989
.. attention::
90-
Neomodel creates a new vectorindex for each specified property, thus you cannot have two distinct properties being placed into the same index.
90+
Neomodel creates a new vector index for each specified property, thus you cannot have two distinct properties being placed into the same index.
9191

9292
Querying a Vector Index on a Property
9393
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -97,7 +97,7 @@ Node Property
9797
The following node vector index property::
9898

9999
class someNode(StructuredNode):
100-
vector = ArrayProperty(base_property=FloatProperty(), vector_index=VectorIndex(dimensions=512, similarity_function="cosine")
100+
vector = ArrayProperty(base_property=FloatProperty(), vector_index=VectorIndex(dimensions=512, similarity_function="cosine"))
101101
name = StringProperty()
102102

103103
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
111111

112112
.. attention::
113113
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.
115115

116116
RelationshipProperty
117117
^^^^^^^^^^^^^^^^^^^^
118118
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.
120120

121121
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

Comments
 (0)