-
Notifications
You must be signed in to change notification settings - Fork 701
vector: various updates #21541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
vector: various updates #21541
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @dveeden, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've made several updates to the documentation related to vector data types and functions. The primary goal of these changes is to improve clarity, provide more comprehensive information, and align examples with documentation style guidelines.
Highlights
- Clarified MySQL Vector Data Type References: Updated documentation to refer to "MySQL vector data types" generally, removing the specific "9.0" version number, as the data type applies across MySQL 9.x versions.
- Enhanced Vector Function Documentation: Added a new column to the vector distance functions table to indicate which functions are supported by the VECTOR index.
- Improved Example Consistency: Standardized SQL examples for vector functions by removing the [tidb]> prompt, aligning them with common documentation practices.
- Guidance for OpenAI Embeddings: Included a note recommending VEC_COSINE_DISTANCE for use with OpenAI embeddings.
- Clarified Vector-to-Text Conversion: Expanded the explanation for VEC_FROM_TEXT to detail both implicit and explicit conversion scenarios between vector and text types.
- Precision in Terminology: Refined descriptions for vector functions, changing "same dimension" to "same number of dimensions" for greater accuracy.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces several updates to the vector documentation. The changes include removing the version number from 'MySQL vector data type' for clarity, updating code examples to a consistent style, adding explanations for vector/text conversions, listing which distance functions support indexing, and adding a recommendation for OpenAI embeddings.
My review focuses on ensuring the documentation adheres to the style guide. I've suggested a minor wording change to use the second person as recommended by the style guide. Overall, the changes are clear and improve the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?