-
Notifications
You must be signed in to change notification settings - Fork 3
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
docs: update README to reflect supported maintenance version #104
Conversation
MySQL vector syntax has changed in the latest maintenance version (see https://cloud.google.com/sql/docs/mysql/work-with-vectors). We are yet to update the integration to use this new syntax, so need to call out the supported versions while we work on a new version of the integration.
/gcbrun |
@juliaofferman do you mind adding to the PR description some details highlighting what the syntax changes are? |
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.
Approving, but can you also add this to the README and https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/blob/main/docs/vector_store.ipynb? Thanks!
/gcbrun |
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.
LGTM, ditto Averi's comment of adding a note to README.
Also see my other comment about updating description to give more details into what the differences in syntax are now.
Add note that maintenance versions between MYSQL_8_0_36.R20240401.03_00 and MYSQL_8_0_36.R20241208.01_00 are required to the overall README and vector_store notebook.
/gcbrun |
Underline was shorter than the section heading, causing "sphinx.errors.SphinxWarning: /home/runner/work/langchain-google-cloud-sql-mysql-python/langchain-google-cloud-sql-mysql-python/docs/README.rst:35:Title underline too short.". Fixed the underline to match text
/gcbrun |
1 similar comment
/gcbrun |
MySQL vector syntax has changed in the latest maintenance version (see https://cloud.google.com/sql/docs/mysql/work-with-vectors). We are yet to update the integration to use this new syntax, so need to call out the supported versions while we work on a new version of the integration. The updated syntax includes changing the ANN search function name, parameters, and where it can appear in a query. Additionally, create/drop/alter vector index syntax has changed. There are also some new restrictions, ie a table must have 1000 rows before creating an index.