Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

enhance: replace pytidb-experimental with pytidb dep for tidb integration (#3073)

Mini25634786d785e63
diff --git a/camel/retrievers/auto_retriever.py b/camel/retrievers/auto_retriever.py
index c31a83bfb..859a32b3a 100644
--- a/camel/retrievers/auto_retriever.py
+++ b/camel/retrievers/auto_retriever.py
@@ -97,6 +97,7 @@ class AutoRetriever:
"URL (database url) and API key required for TiDB storage "
"are not provided. Format: "
"mysql+pymysql://<username>:<password>@<host>:4000/test"
+ "You can get the database url from https://tidbcloud.com/console/clusters"
)
return TiDBStorage(
vector_dim=self.embedding_model.get_output_dim(),
diff --git a/camel/storages/vectordb_storages/tidb.py b/camel/storages/vectordb_storages/tidb.py
index bd8c40c7d..5d42c0e60 100644
--- a/camel/storages/vectordb_storages/tidb.py
+++ b/camel/storages/vectordb_storages/tidb.py
@@ -44,7 +44,7 @@ class TiDBStorage(BaseVectorStorage):
r"""An implementation of the `BaseVectorStorage` for interacting with TiDB.
The detailed information about TiDB is available at:
- `TiDB Vector Search <https://ai.pingcap.com/>`_
+ `TiDB Vector Search <https://pingcap.com/ai>`_
Args:
vector_dim (int): The dimension of storing vectors.
@@ -107,10 +107,10 @@ class TiDBStorage(BaseVectorStorage):
)
def _get_table_model(self, collection_name: str) -> Any:
+ from pytidb.datatype import JSON
from pytidb.schema import Field, TableModel, VectorField
- from sqlalchemy import JSON
- class VectorDBRecord(TableModel):
+ class VectorDBRecordBase(TableModel, table=False):
id: Optional[str] = Field(None, primary_key=True)
vector: list[float] = VectorField(self.vector_dim)
payload: Optional[dict[str, Any]] = Field(None, sa_type=JSON)
@@ -119,7 +119,7 @@ class TiDBStorage(BaseVectorStorage):
# class names.
return type(
f"VectorDBRecord_{collection_name}",
- (VectorDBRecord,),
+ (VectorDBRecordBase,),
{"__tablename__": collection_name},
table=True,
)
@@ -128,8 +128,9 @@ class TiDBStorage(BaseVectorStorage):
r"""Opens an existing table or creates a new table in TiDB."""
table = self._client.open_table(self.collection_name)
if table is None:
+ table_model = self._get_table_model(self.collection_name)
table = self._client.create_table(
- schema=self._get_table_model(self.collection_name)
+ schema=table_model, if_exists="skip"
)
return table
@@ -166,6 +167,7 @@ class TiDBStorage(BaseVectorStorage):
table.
"""
vector_count = self._table.rows()
+
# Get vector dimension from table schema
columns = self._table.columns()
dim_value = None
@@ -303,7 +305,7 @@ class TiDBStorage(BaseVectorStorage):
for row in rows:
query_results.append(
VectorDBQueryResult.create(
- similarity=float(row['similarity_score']),
+ similarity=float(row['_score']),
id=str(row['id']),
payload=row['payload'],
vector=row['vector'],
diff --git a/docs/key_modules/storages.md b/docs/key_modules/storages.md
index 9c1db3f68..1512235c7 100644
--- a/docs/key_modules/storages.md
+++ b/docs/key_modules/storages.md
@@ -45,7 +45,7 @@ The <b>Storage</b> module in CAMEL-AI gives you a **unified interface for saving
- High scalability, real-time search
**TiDBStorage**
- - For [TiDB](https://ai.pingcap.com/) (hybrid vector/relational database)
+ - For [TiDB](https://pingcap.com/ai) (hybrid vector/relational database)
- Handles embeddings, knowledge graphs, ops data
**QdrantStorage**
diff --git a/pyproject.toml b/pyproject.toml
index b25ea01dd..7321d18fe 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -69,7 +69,7 @@ rag = [
"numpy>=1.2,<=2.2",
"qdrant-client>=1.9.0,<2",
"pymilvus>=2.4.0,<3",
- "pytidb-experimental==0.0.1.dev4",
+ "pytidb>=0.0.13",
"faiss-cpu>=1.7.2,<2",
"weaviate-client>=4.15.0",
"protobuf>=6.0.0",
@@ -200,7 +200,7 @@ huggingface = [
storage = [
"qdrant-client>=1.9.0,<2",
"pymilvus>=2.4.0,<3",
- "pytidb-experimental==0.0.1.dev4",
+ "pytidb>=0.0.13",
"faiss-cpu>=1.7.2,<2",
"neo4j>=5.18.0,<6",
"nebula3-python==3.8.2",
@@ -360,7 +360,7 @@ all = [
"networkx>=3.4.2,<4",
"qdrant-client>=1.9.0,<2",
"pymilvus>=2.4.0,<3",
- "pytidb-experimental==0.0.1.dev4",
+ "pytidb>=0.0.13",
"faiss-cpu>=1.7.2,<2",
"cohere>=5.11.0,<6",
"neo4j>=5.18.0,<6",
diff --git a/uv.lock b/uv.lock
index 78ccb821b..16fcbcf42 100644
--- a/uv.lock
+++ b/uv.lock
@@ -1,5 +1,5 @@
version = 1
-revision = 2
+revision = 3
requires-python = ">=3.10, <3.13"
resolution-markers = [
"python_full_version >= '3.12'",
@@ -756,7 +756,7 @@ all = [
{ name = "pytest-asyncio" },
{ name = "pytest-cov" },
{ name = "python-pptx" },
- { name = "pytidb-experimental" },
+ { name = "pytidb" },
{ name = "qdrant-client" },
{ name = "rank-bm25" },
{ name = "redis" },
@@ -1001,7 +1001,7 @@ rag = [
{ name = "protobuf" },
{ name = "pymilvus" },
{ name = "pyobvector" },
- { name = "pytidb-experimental" },
+ { name = "pytidb" },
{ name = "qdrant-client" },
{ name = "rank-bm25" },
{ name = "unstructured" },
@@ -1026,7 +1026,7 @@ storage = [
{ name = "psycopg", extra = ["binary"] },
{ name = "pymilvus" },
{ name = "pyobvector" },
- { name = "pytidb-experimental" },
+ { name = "pytidb" },
{ name = "qdrant-client" },
{ name = "redis" },
{ name = "surrealdb" },
@@ -1312,9 +1312,9 @@ requires-dist = [
{ name = "python-pptx", marker = "extra == 'document-tools'", specifier = ">=1.0.2" },
{ name = "python-pptx", marker = "extra == 'eigent'", specifier = ">=1.0.2" },
{ name = "python-pptx", marker = "extra == 'owl'", specifier = ">=1.0.2" },
- { name = "pytidb-experimental", marker = "extra == 'all'", specifier = "==0.0.1.dev4" },
- { name = "pytidb-experimental", marker = "extra == 'rag'", specifier = "==0.0.1.dev4" },
- { name = "pytidb-experimental", marker = "extra == 'storage'", specifier = "==0.0.1.dev4" },
+ { name = "pytidb", marker = "extra == 'all'", specifier = ">=0.0.13" },
+ { name = "pytidb", marker = "extra == 'rag'", specifier = ">=0.0.13" },
+ { name = "pytidb", marker = "extra == 'storage'", specifier = ">=0.0.13" },
{ name = "qdrant-client", marker = "extra == 'all'", specifier = ">=1.9.0,<2" },
{ name = "qdrant-client", marker = "extra == 'rag'", specifier = ">=1.9.0,<2" },
{ name = "qdrant-client", marker = "extra == 'storage'", specifier = ">=1.9.0,<2" },
@@ -6562,17 +6562,18 @@ source = { registry = "https://pypi.org/simple" }
sdist = { url = "https://files.pythonhosted.org/packages/ef/c6/2c5999de3bb1533521f1101e8fe56fd9c266732f4d48011c7c69b29d12ae/python3-xlib-0.15.tar.gz", hash = "sha256:dc4245f3ae4aa5949c1d112ee4723901ade37a96721ba9645f2bfa56e5b383f8", size = 132828, upload-time = "2014-05-31T12:28:59.603Z" }
[[package]]
-name = "pytidb-experimental"
-version = "0.0.1.dev4"
+name = "pytidb"
+version = "0.0.13"
source = { registry = "https://pypi.org/simple" }
dependencies = [
+ { name = "numpy" },
{ name = "pymysql" },
+ { name = "sqlalchemy" },
{ name = "sqlmodel" },
- { name = "tidb-vector" },
]
-sdist = { url = "https://files.pythonhosted.org/packages/32/b9/11fdb74a0cf645cb02ccff7a1f163333eedd461e364425caede13dba5d6b/pytidb_experimental-0.0.1.dev4.tar.gz", hash = "sha256:0161b77758af363a6d3f0c16df010effae2cea3b0f98ca08b6d0b9eb07760923", size = 15079, upload-time = "2025-03-21T03:11:07.625Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/a5/c1/511c5f7e6660b4929f730db68a45c183ce919064189f1c8718ccd67a9418/pytidb-0.0.13.tar.gz", hash = "sha256:0c5da2f84f97a7dce6552e3369bfd181af83e7cfbfaf9bc1e878a10686807030", size = 46666, upload-time = "2025-08-29T02:42:38.22Z" }
wheels = [
- { url = "https://files.pythonhosted.org/packages/8b/71/a531e6648455fd8a936530c67c619a33726f55331bacdac74aa6742d0baf/pytidb_experimental-0.0.1.dev4-py3-none-any.whl", hash = "sha256:5ba3f5bb533927b0f82421df4c6f379dafd4f2afe8cfaf15ec0f00833794f1d0", size = 17824, upload-time = "2025-03-21T03:11:06.299Z" },
+ { url = "https://files.pythonhosted.org/packages/47/93/e33501ceeb48a0cffe45c4a2816a2136b9c49461d1977facf81a9689cf3f/pytidb-0.0.13-py3-none-any.whl", hash = "sha256:85f9eefa21714c7e0d5ed5c24c710b07d4453fbfb0062774d03354941b35e180", size = 57598, upload-time = "2025-08-29T02:42:33.523Z" },
]
[[package]]
@@ -7955,18 +7956,6 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/32/d5/f9a850d79b0851d1d4ef6456097579a9005b31fea68726a4ae5f2d82ddd9/threadpoolctl-3.6.0-py3-none-any.whl", hash = "sha256:43a0b8fd5a2928500110039e43a5eed8480b918967083ea48dc3ab9f13c4a7fb", size = 18638, upload-time = "2025-03-13T13:49:21.846Z" },
]
-[[package]]
-name = "tidb-vector"
-version = "0.0.15"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
- { name = "numpy" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/b1/55/6247b3b8dd0c0ec05a7b0dd7d4f016d03337d6f089db9cc221a31de1308c/tidb_vector-0.0.15.tar.gz", hash = "sha256:dfd16b31b06f025737f5c7432a08e04265dde8a7c9c67d037e6e694c8125f6f5", size = 20702, upload-time = "2025-07-15T09:48:07.423Z" }
-wheels = [
- { url = "https://files.pythonhosted.org/packages/24/27/5a4aeeae058f75c1925646ff82215551903688ec33acc64ca46135eac631/tidb_vector-0.0.15-py3-none-any.whl", hash = "sha256:2bc7d02f5508ba153c8d67d049ab1e661c850e09e3a29286dc8b19945e512ad8", size = 21924, upload-time = "2025-07-15T09:48:05.834Z" },
-]
-
[[package]]
name = "tiktoken"
version = "0.7.0"