Alibaba製OSS Chat2DBのSQL生成機能を紐解いてみる

3.Chat2DBを実装を見てみる

Chat2DBでSQL生成や自然言語による解説ができることがわかりました。次に，Chat2DBがどのようなプロンプトを利用しているのかを見てみましょう。

Chat2DBはOSSなので，OpenAI APIを呼び出している周辺のコードを探せば，プロンプトを組み立てる実装を見つけることができます。ChatController.javaを見ると，buildPromptというメソッドがあり，ここでテーブルの情報などを用いてプロンプトを組み立てていることがわかります。プロンプトの大部分は共通で，「请根据以下table properties和SQL input」に続く一文が呼び出す機能によって異なるようです。buildPromptの呼び出し後の処理を見ると，モデルごとに分岐する処理と，生成したプロンプトをinfoレベルでログに出力する処理が書かれています。自分でコードをビルドして実行すれば，ログに書かれたプロンプトを見ることができそうです。さっそく試してみましょう。

2023-06-23 16:47:41.303  INFO 89778 --- [io-10821-exec-2] c.a.d.s.w.a.c.ai.ChatController          :  请根据以下table properties和SQL input将自然语言转换成SQL查询.

 MYSQL SQL tables, with their properties:

 country(Code, Name, Continent, Region, SurfaceArea, IndepYear, Population, LifeExpectancy, GNP, GNPOld, LocalName, GovernmentForm, HeadOfState, Capital, Code2)
countrylanguage(CountryCode, Language, IsOfficial, Percentage)
city(ID, Name, CountryCode, District, Population)


 SQL input: 英語が公用語の国最も人口が多い都市の国名と都市名と人口を取得

テーブル定義と自然言語の入力を組み合わせてプロンプトを生成していることがわかりました。しかし，テーブル定義はテーブル名とカラム名のみをプロンプトに含めているため，型の情報がカラム名から推測しにくいカラムに対する条件などはうまく付与できない可能性があります。試してみましょう。

ContinentカラムはEnumで，大陸名が英語で格納されます。しかし，プロンプトには型の情報がないため，大陸名が「南アメリカ」であるレコードを抽出する，というSQLが生成されてしまいました。

実装を見てわかるように，Chat2DBのAIGC機能のプロンプトは非常にシンプルなものであり，あまり高精度な出力は期待できません。あくまでも参考程度とするのが良さそうです。ただし，SQL変換機能はテーブル定義に依存しないため，割と実用性は高そうです。

4.Chat2DBのプロンプトを日本語にしてみる

最後に，ソースコードを少し変更してプロンプトを日本語にして，日本語でSQLの解説が出力できるようにしてみましょう。さきほど，「请根据以下table properties和SQL input」に続く一文が機能によって異なる，ということを紹介しました。機能ごとのプロンプトはこちらのenumで定義されています。SQL_EXPLAINを「SQLを日本語で解説」に書き換えて実行してみましょう。解説するSQLは，さきほど中国語の解説を生成したものと同じものを利用します。

2023-07-09 13:14:50.726  INFO 37245 --- [io-10821-exec-3] c.a.d.s.w.a.c.ai.ChatController          :  请根据以下SQL inputSQLを日本語で解説.

 SQL input: SELECT c.Capital, cl.LanguageFROM country cLEFT JOIN countrylanguage cl on c.Code = cl.CountryCodeORDER BY c.Population DESCLIMIT 5

このように，若干不自然なプロンプトが生成されました。前半の「请根据以下SQL input」も修正すれば良いのですが，ひとまずこのままで出力を見てみましょう。

それらしい解説が日本語で生成されました。

先ほども述べたように，デフォルトのChat2DBはプロンプトもシンプルで，出力も中国語ですが，プロンプト生成の実装がわかりやすく，自分でカスタムするのも容易です。プロンプトをカスタマイズすることで，自分が実行したいタスクに最適化したDBクライアントソフトウェアに仕上げることもできそうです。

5.まとめ

Alibaba製のOSS Chat2DBのSQL生成機能を検証しました。プロンプトが非常にシンプルであり，SQL生成やその他のAIGC機能は参考程度の精度です。OSSの特性を活かしてカスタムすることで，より高い実用性が見えてくるのではないでしょうか。

次世代システム研究室では，グループ全体のインテグレーションを支援してくれるアーキテクトを募集しています。アプリケーション開発者の方，次世代システム研究室にご興味を持って頂ける方がいらっしゃいましたら，ぜひ募集職種一覧からご応募をお願いします。

参考

GitHub – chat2db/Chat2DB