Add 'cosine' as supported similarity function

[gkorland]

Add 'cosine' as supported similarity function

Summary by CodeRabbit

• Documentation
  • Updated the documentation to clarify that both 'euclidean' and 'cosine' similarity functions are supported when creating vector indexes.

[coderabbitai]

Walkthrough

The documentation for vector index creation has been updated to specify that both 'euclidean' and 'cosine' similarity functions are supported. This replaces the previous documentation, which only mentioned 'euclidean'. No changes were made to code or exported/public entities; the update is limited to clarifying the supported options in the documentation.

Changes

File(s)	Change Summary
cypher/indexing.md	Updated documentation to state that both 'euclidean' and 'cosine' similarity functions are supported for vector indexes.

Possibly related PRs

• add cosine option #64: Updates documentation to reflect support for both "euclidean" and "cosine" similarity functions in vector indexes.
• document new vector api #62: Documents the new vector API, including the addition of the cosineDistance function and vector index parameters.

Suggested reviewers

• swilly22

Poem

In the docs, a change so neat,
Now 'cosine' joins 'euclidean's seat.
Vectors compare with angles or space,
Both methods now have their place.
Hopping through docs, I’m happy to see,
Clarity blooms for you and for me!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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: 0

🧹 Nitpick comments (1)

cypher/indexing.md (1)

252-252: Improve conciseness and clarity in listing supported functions.

The phrase “At the moment the only supported similarity functions are 'euclidean' or 'cosine'.” can be made more concise and accurate by using an adverb and the conjunction “and”:

- At the moment the only supported similarity functions are 'euclidean' or 'cosine'.
+ Currently, the only supported similarity functions are 'euclidean' and 'cosine'.

🧰 Tools

🪛 LanguageTool

[style] ~252-~252: For conciseness, consider replacing this expression with an adverb.
Context: ...d similarity function must be provided. At the moment the only supported similarity functions...

(AT_THE_MOMENT)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f2a84e and 0b09517.

📒 Files selected for processing (1)

• cypher/indexing.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

cypher/indexing.md

[style] ~252-~252: For conciseness, consider replacing this expression with an adverb.
Context: ...d similarity function must be provided. At the moment the only supported similarity functions...

(AT_THE_MOMENT)