Skip to content
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

note for TiDB Vector Search #19373

Open
shawn0915 opened this issue Nov 12, 2024 · 6 comments · Fixed by #19385
Open

note for TiDB Vector Search #19373

shawn0915 opened this issue Nov 12, 2024 · 6 comments · Fixed by #19385
Assignees

Comments

@shawn0915
Copy link
Contributor

File: /release-7.5/tidb-cloud/vector-search-get-started-using-python.md

TiDB Vector Search is currently in beta and only available for TiDB Cloud Serverless clusters.

we need to update this content cause tidb 8.4 release?

@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Nov 12, 2024

@shawn0915 Thank you for bringing this up. Let me clarify:

The document at https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python is specifically for TiDB Cloud users. The "beta" status and "only available for TiDB Cloud Serverless clusters" statement refers to the feature's availability within TiDB Cloud - meaning it's not yet supported on TiDB Cloud Dedicated clusters.

If you're interested in Vector Search documentation for TiDB v8.4, please refer to the TiDB Self-Managed documenattion at https://docs.pingcap.com/tidb/v8.4/vector-search-get-started-using-python.

@shawn0915
Copy link
Contributor Author

@Oreoxmt thanks for reply.

it's not yet supported on TiDB Cloud Dedicated clusters.

It is better to clarify the scope or the description like "available for TiDB Self-Managed clusters and [TiDB Cloud Serverless]" in both sides?

  • TiDB

https://docs.pingcap.com/tidb/v8.4/vector-search-get-started-using-python

The vector search feature is only available for TiDB Self-Managed clusters and TiDB Cloud Serverless clusters.

  • TiDB Cloud

https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python

TiDB Vector Search is currently in beta and only available for TiDB Cloud Serverless clusters.

BTW,

in tidb docs, "vector search" should be "Vector Search"?

@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Nov 12, 2024

@shawn0915

in tidb docs, "vector search" should be "Vector Search"?

  • Regarding capitalization:
    @qiancai Could you please confirm the preferred terminology? I notice that both "vector search" and "Vector Search" appear in the TiDB Cloud documentation. Should we standardize on one format for consistency?

@breezewish
Copy link
Member

Maybe we need to change occurance to this everywhere, like:

TiDB Vector Search is currently in beta and is not available for TiDB Cloud Dedicated clusters.

This could lead to less confusions.

@qiancai
Copy link
Collaborator

qiancai commented Nov 12, 2024

@shawn0915

in tidb docs, "vector search" should be "Vector Search"?

  • Regarding capitalization:
    @qiancai Could you please confirm the preferred terminology? I notice that both "vector search" and "Vector Search" appear in the TiDB Cloud documentation. Should we standardize on one format for consistency?

Yes, I've created a PR #19385 to standardize the capitalization of “vector search” and “Vector Search” across the TiDB Cloud documentation to improve consistency and readability. The changes follow these rules:

  • "TiDB Vector Search": Used when referring to TiDB’s specific product feature.
  • "vector search": Used when referring to the concept of vector search in a general or technical context.

@qiancai qiancai linked a pull request Nov 13, 2024 that will close this issue
17 tasks
@qiancai qiancai self-assigned this Nov 13, 2024
@breezewish
Copy link
Member

I guess a recent misunderstanding caused by current Serverless doc is here: pingcap/autoflow#399

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants