huchenxucs/chatdb

The official repository of "ChatDB: Augmenting LLMs with Databases as Their Symbolic Memory".

ChatDB: Augmenting LLMs with Databases as Their Symbolic Memory

Paper | Project Page

This is the official repository of the paper: ChatDB: Augmenting LLMs with Databases as Their Symbolic Memory.

We will continuously add new features to this code repository. Please stay tuned!

Large language models (LLMs) with memory are computationally universal. However, mainstream LLMs are not taking full advantage of memory, and the designs are heavily influenced by biological brains. Due to their approximate nature and proneness to the accumulation of errors, conventional neural memory mechanisms cannot support LLMs to simulate complex reasoning. In this paper, we seek inspiration from modern computer architectures to augment LLMs with symbolic memory for complex multi-hop reasoning. Such a symbolic memory framework is instantiated as an LLM and a set of SQL databases, where the LLM generates SQL instructions to manipulate the SQL databases. We validate the effectiveness of the proposed memory framework on a synthetic dataset requiring complex reasoning.

Quick Start

Install dependencies

conda create -n chatdb python=3.9
conda activate chatdb
pip install -r requirements.txt

Add keys

cp .env.template .env
# add OPENAI_API_KEY and MYSQL_PASSWORD

A minimal CLI demo in a fruit shop scenario

python chatdb.py

The CLI demo looks as follows.

Citation

If you find our work useful for your research, please consider citing the paper:

@misc{hu2023chatdb,
      title={ChatDB: Augmenting LLMs with Databases as Their Symbolic Memory},
      author={Chenxu Hu and Jie Fu and Chenzhuang Du and Simian Luo and Junbo Zhao and Hang Zhao},
      year={2023},
      eprint={2306.03901},
      archivePrefix={arXiv},
      primaryClass={cs.AI}
}

chatdb's Issues

SQL error: execute() first

Any Update for ChatDB code?

I am very interested in your code, I hope to reproduce it, when can I publish the source code, thank you

只能接入chatgpt么?或者是否可以自定义baseurl和model name.

点击 Get Started 返回 JSON

link:
https://accounts.chatdb.ai/sign-in?redirect_url=https%3A%2F%2Fwww.chatdb.ai%2Fdashboard

What's the meaning of function 'need_update_sql' in chatdb.py ?

Doesn't seem to see a different table schema

I've gone through your codes and paper but still confused about how you passed the table structure to the prompt to let the model know which operations it should take.
I've seen table_schema.py but it only contains fixed SQL sentences.
If this part of the design is missing, does it mean that the experiment is only valid in the fruit shop dataset scenario?

请问为什么在提问的时候会先输出一句“NOT NEED MEMORY”，好像也不会根据数据库来做出回答？

(chatdb) (venv) ErakeedeMacBook-Pro:ChatDB-main erakee$ python chatdb.py
START!
USER INPUT: apple's price
NOT NEED MEMORY: ```
Step1: Retrieve the price of apple
SELECT selling_price
FROM fruits
WHERE fruit_name = 'apple';

USER INPUT: calculate the total revenue for January 2023
NOT NEED MEMORY: ```
Step1: Calculate the total revenue for January 2023
SELECT SUM(total_price) AS total_revenue
FROM sales
WHERE sale_date >= '2023-01-01' AND sale_date < '2023-02-01';

bug

Is there any one facing this problem?
When I run chatdb.py it's shows :

C:\Users\anaconda3\envs\LLM\python.exe C:/User/Desktop/LLM/ChatDB/chatdb.py
Traceback (most recent call last):
  File "C:/Users/Desktop/LLM/ChatDB/chatdb.py", line 7, in <module>
    from call_ai_function import populate_sql_statement
  File "C:\Users\Desktop\LLM\ChatDB\call_ai_function.py", line 36, in <module>
    def populate_sql_statement(sql_str: str, previous_sql_results: list[list[dict]]) -> list[str]:
TypeError: 'type' object is not subscriptable

and if I change this def function to:

from typing import List
def populate_sql_statement(sql_str: str, previous_sql_results: List[List[dict]]) -> List[str]:

The result will be like this:

Thanks

关于sql_results_history, new_mem_ops 这两个变量的问题

请问这两个变量目前的代码里是完全没有用上吗？是本来打算完全用python实现chain_of_memory但遇到了问题所以这两个变量暂时没有使用吗？

文章中的50个问题会提供吗？

很想了解一下你们的项目，请问有文章中所说的50个问题以及他们的难度等级吗？

非常感兴趣这个项目，有交流群吗？

感谢开发者开源出来为社区做出的贡献，希望有一个方式可以和开发者交流使用体验和具体细节。

-

pymysql.err.OperationalError: (2003, "Can't connect to MySQL server on 'localhost'

运行python chatdb.py后报错

ConnectionRefusedError: [Errno 111] Connection refused

During handling of the above exception, another exception occurred:
pymysql.err.OperationalError: (2003, "Can't connect to MySQL server on 'localhost' ([Errno 111] Connection refused)")

File "/home/Documents/git_clone/ChatDB/mysql.py", line 59, in execute_sql
self.conn.rollback()
AttributeError: 'NoneType' object has no attribute 'rollback'

ChatGLM怎么使用这个项目呢？

怎么使用ChatGLM，而不是调用OPENAI的Key呢？需要修改哪些配置文件呢？