document new vector api #62

AviAvni · 2024-08-19T09:45:52Z

Summary by CodeRabbit

New Features
- Added vec.cosineDistance(_vector_, _vector_) function for computing the Cosine distance between vectors, enhancing vector operation capabilities.
- Introduced a new section in the documentation detailing options for creating a vector index, including required and optional parameters for effective configuration.
- New cosineDistance method added for calculating distances, extending functionality in mathematical or data processing contexts.

coderabbitai · 2024-08-19T09:46:01Z

Caution

Review failed

The pull request is closed.

Walkthrough

The update enhances the Cypher query language documentation with the new vec.cosineDistance function for computing Cosine distance between vectors. Additionally, a section on creating vector indexes has been introduced, detailing the necessary and optional parameters for configuration. These additions improve the clarity and functionality of vector operations within Cypher, enriching the user experience and expanding capabilities for similarity measurements.

Changes

Files	Change Summary
cypher/functions.md	Added new `vec.cosineDistance(_vector_, _vector_)` function for vector similarity.
cypher/index.md	Introduced a section on creating vector indexes with required and optional parameters.
.wordlist.txt	Added a new exported entity, `cosineDistance`, enhancing distance calculation capabilities.

Poem

🐇 In the land of Cypher, new features bloom,
Vectors dance, casting away the gloom.
With cosine distance, we’ll measure the space,
Indexes ready, in this querying race!
Hops of joy, for each little change,
Making our database world feel less strange! ✨

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5caa9c and 431a02d.

Files selected for processing (2)

cypher/functions.md (1 hunks)
cypher/index.md (1 hunks)

Additional context used

Markdownlint

cypher/index.md

203-203: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Additional comments not posted (2)

cypher/index.md (1)

202-210: Clarify the description of vector index options.

The description of the options is clear, but ensure that the default values for optional parameters are explicitly stated, as they are crucial for users configuring the index.

Tools

Markdownlint

203-203: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

cypher/functions.md (1)

217-217: LGTM! The function vec.cosineDistance is well-documented.

The addition of vec.cosineDistance is clear and consistent with the existing documentation format.

coderabbitai · 2024-08-19T09:49:06Z

cypher/index.md

+```
+{
+   dimension: INT, // Requiered, length of the vector to be indexed
+   similarityFunction: STRING, // Requiered, currently only euclidean is allowed
+   M: INT, // Optional, maximum number of outgoing edges per node. default 16
+   efConstruction: INT, // Optional, number of candidates during construction. default 200
+   efRuntime: INT // Optional, number of candidates during search. default 10
+}
+```


Add language specification to the fenced code block.

The fenced code block for the options should specify a language for better syntax highlighting.

-``` +```json

Tools

Markdownlint

203-203: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

document new vector api

431a02d

coderabbitai bot reviewed Aug 19, 2024

View reviewed changes

add word

438cb58

swilly22 approved these changes Aug 19, 2024

View reviewed changes

AviAvni merged commit 19ef0c4 into main Aug 19, 2024
1 check passed

AviAvni deleted the document-new-vector-api branch August 19, 2024 10:06

coderabbitai bot mentioned this pull request Sep 9, 2024

add rest table #75

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

document new vector api #62

document new vector api #62

AviAvni commented Aug 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 19, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Aug 19, 2024

document new vector api #62

document new vector api #62

Conversation

AviAvni commented Aug 19, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Aug 19, 2024 • edited Loading

Review failed

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Aug 19, 2024

Choose a reason for hiding this comment

AviAvni commented Aug 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 19, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)