document vector creation #40
Conversation
WalkthroughThe change introduces a new capability in Cypher queries, enabling the insertion of vectors. It showcases using the Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional Context UsedLanguageTool (24)
Additional comments not posted (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (3)
cypher/index.md (3)
Line range hint
193-193: Consider revising the verb tense for clarity.- With the introduction of the `vector` data-type a new type of index was introduce. + With the introduction of the `vector` data-type, a new type of index was introduced.
Line range hint
279-279: Add a comma after "for example" for better readability.- For example to drop the vector index over Product description invoke: + For example, to drop the vector index over Product description invoke:
Line range hint
235-235: Consider explaining the parameters used in thedb.idx.vector.queryNodesanddb.idx.vector.queryRelationshipsfunctions for better user understanding.Would you like me to add detailed descriptions for each parameter used in these functions?
| @@ -216,6 +216,17 @@ CREATE VECTOR INDEX FOR ()-[e:Call]->() ON (e.summary) OPTIONS {dimension:128, s | |||
| Please note when creating a vector index both the vector dimension and similarity function | |||
| must be provided. At the moment the only supported similarity function is 'euclidean'. | |||
There was a problem hiding this comment.
Capitalize "Euclidean" to adhere to standard conventions.
- the only supported similarity function is 'euclidean'.
+ the only supported similarity function is 'Euclidean'.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| must be provided. At the moment the only supported similarity function is 'euclidean'. | |
| must be provided. At the moment the only supported similarity function is 'Euclidean'. |
cypher/index.md
Outdated
| @@ -216,6 +216,17 @@ | |||
| Please note when creating a vector index both the vector dimension and similarity function | |||
| must be provided. At the moment the only supported similarity function is 'euclidean'. | |||
|
|
|||
| ## Inserting vectors | |||
|
|
|||
| To create a new vector use the [vecf32](https://docs.falkordb.com/cypher/functions.html#vector-functions) function | |||
There was a problem hiding this comment.
Consider adding a brief description or a direct link to the vecf32 function documentation for clarity.
Would you like me to add a brief explanation or find a suitable link for the vecf32 function documentation?
swilly22
force-pushed
the
vector-creation-doc
branch
from
1a5aa03 to
8cfff5f
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (3)
cypher/index.md (3)
Line range hint
193-193: Consider using the past participle "introduced" for grammatical correctness.- With the introduction of the `vector` data-type a new type of index was introduce. + With the introduction of the `vector` data-type a new type of index was introduced.
Line range hint
235-235: Consider adding a comma after "distance" for better readability.- To query the index use either `db.idx.vector.queryNodes` for node retrieval or `db.idx.vector.queryRelationships` for relationships. + To query the index, use either `db.idx.vector.queryNodes` for node retrieval or `db.idx.vector.queryRelationships` for relationships.
Line range hint
279-279: After "For example," a comma is usually used for better readability.- For example to drop the vector index over Product description invoke: + For example, to drop the vector index over Product description invoke:
Resolves: #39
Summary by CodeRabbit
vecf32function and their association with node attributes.