SQL アシスタントとは
SQL アシスタントは、SORACOM Query Studio で自然言語の質問から SQL クエリを生成する機能です。シンプルモードとアドバンスドモードのどちらでも質問できます。
質問を送信すると、SQL アシスタントは質問に合わせた SQL クエリを生成します。生成した SQL クエリを SQL アシスタントが自動的に実行するかどうかは、エージェントモード の設定によって異なります。また、推論レベル を変更して、回答までの時間と回答の品質のバランスを調整できます。
SQL アシスタントで SQL クエリを生成して実行する
アドバンスドモードで、エージェントモードを無効にした状態で SQL クエリを生成して実行する手順を説明します。
SQL アシスタントが生成する SQL クエリ
- SQL アシスタントは、Query のデータウェアハウスに収集されたテーブルと、登録済みのユーザーテーブルだけを参照します。テーブルについては、SORACOM Query の概要 を参照してください。
- 実行できる SQL クエリは SELECT 文だけです。SELECT 文以外の SQL クエリを実行すると、「不正な SQL（利用できない SQL コマンドが含まれています）」(
ANA0012) というエラーが表示されます。このエラーが表示された場合、SQL クエリは実行されていないため、クエリ実行回数としてカウントされません。 - 質問に対して SQL クエリを生成できない場合は、SQL クエリを生成せずに、理由を回答します。
SQL クエリについての質問は、SORACOM サポートのサポート対象外です。詳しくは、SORACOM Query Studio の利用スタイル を参照してください。
SORACOM Query Studio を表示する の手順に従って、SORACOM Query Studio を表示します。
をクリックします。
アドバンスドモードに切り替わり、SQL クエリエディタと SQL アシスタントが表示されます。エージェントモードは、初期状態では無効です。
SQL アシスタントの入力欄に質問を入力して、[
] をクリックします。ここでは、「各ステータスの SIM の件数を表示してください。」を入力します。
質問が SQL アシスタントに送信されます。回答が表示されるまで少しお待ちください。
SQL クエリエディタに、質問にあわせた SQL クエリが表示されます。SQL アシスタントの回答には、SQL クエリを生成した方針と、生成した SQL クエリが表示されます。
エージェントモードが無効な場合は、SQL クエリは実行されません。SQL クエリを生成しただけでは、クエリ実行回数としてカウントされません。
生成された SQL クエリを確認して、 をクリックします。
SQL クエリの実行結果が表示されます。詳しくは、クエリを実行する を参照してください。
SQL クエリを修正するには
SQL アシスタントの入力欄に修正内容を入力して送信すると、SQL クエリが更新されます。SQL クエリエディタで SQL クエリを直接編集することもできます。
推論レベルを変更する
推論レベルを高くすると、SQL アシスタントが回答を返すまでの時間が長くなることがあります。その分、回答や生成される SQL クエリの品質が向上する場合があります。
推論レベルは、アドバンスドモードで変更できます。シンプルモードでは、最初の質問を送信すると SQL アシスタントに が表示され、推論レベルを変更できます。
以下では、アドバンスドモードで推論レベルを変更する手順を説明します。
をクリックします。
SQL アシスタントの をクリックします。
は、初期状態では折りたたまれています。
で「低」「中（デフォルト）」「高」のいずれかを選択します。
- 推論レベルの初期値は「中（デフォルト）」です。
- 推論レベルは、SORACOM アカウントではなくブラウザごとに保存されます。別のブラウザや別の端末では、「中（デフォルト）」が選択されます。
- 推論レベルを変更しても、クエリ実行回数のカウント方法は変わりません。
エージェントモード
エージェントモードは、SQL アシスタントが生成した SQL クエリを自動的に実行する機能です。エージェントモードが有効な場合、SQL アシスタントは生成した SQL クエリを実行して実行結果を確認し、結果が正しいと判断されるまで SQL クエリを調整しながら回答をまとめます。このとき、1 つの質問に答えるまでに SQL クエリを複数回実行することがあります。
エージェントモードが無効な場合、SQL アシスタントは生成した SQL クエリを SQL クエリエディタに表示するだけで、実行はしません。SQL クエリの内容を確認してから実行する場合は、アドバンスドモードでエージェントモードを無効にします。
| 項目 | エージェントモードが有効な場合 | エージェントモードが無効な場合 |
|---|---|---|
| SQL クエリの実行 | SQL アシスタントが自動的に実行します。 | をクリックして実行します。 |
| 実行結果に応じた SQL クエリの調整 | SQL アシスタントが自動的に調整して実行し直します。 | 行われません。 |
| 1 つの質問に対する SQL クエリの実行回数 | 複数回になることがあります。 | をクリックした回数です。 |
エージェントモードでは 1 回の質問で複数回のクエリ実行がカウントされる場合があります
SQL アシスタントがデータに対して実行した SQL クエリは、SQL クエリエディタで実行した SQL クエリと同じように、1 回ごとにクエリ実行回数としてカウントされます。SQL アシスタントが実行した SQL クエリに専用の枠が用意されていたり、カウントが割り引かれたりすることはありません。
エージェントモードでは、1 つの質問に答えるまでに SQL クエリを複数回実行することがあります。1 回の SQL クエリで回答できる質問の場合は、1 回だけ実行されます。
実行される回数は、質問に含まれる項目の数と一致するとは限りません。たとえば、3 つの項目を含む質問に対して、SQL クエリが 5 回実行されることがあります。
カウントされる場合とカウントされない場合は、次のとおりです。
- 実行結果が 0 件の場合もカウントされます。
- SQL クエリがタイムアウトした場合もカウントされます。
- SQL クエリの実行に成功したあとで、実行結果のエクスポートに失敗した場合もカウントされます。
- SQL エラーで失敗した場合はカウントされません。カラム名の誤りなど、SQL クエリ自体に問題がある場合は、
ANA0005というエラーが表示されます。エージェントモードで SQL クエリを調整して実行し直した場合も、失敗した SQL クエリはカウントされません。 - SELECT 文以外の SQL クエリは、実行される前に拒否されるため、カウントされません。このとき、
ANA0012というエラーが表示されます。 - SQL アシスタントが SQL クエリを生成しただけで実行しなかった場合はカウントされません。
ANA0005 または ANA0012 のエラーが表示された場合、その SQL クエリはクエリ実行回数としてカウントされていません。
クエリ実行回数を確認する方法は、SQL クエリ実行回数を確認する を参照してください。確認できるのは現在の使用量と上限だけです。SQL アシスタントが実行した SQL クエリと、SQL クエリエディタで実行した SQL クエリを区別して確認することはできません。
プランごとのクエリ実行回数は、SORACOM Query のプラン を参照してください。
自動実行が 5 回に達すると確認を求めます
1 つの質問に対して SQL クエリを 5 回実行すると、SQL アシスタントは「しばらく自動実行していました。この分析を続けますか？」というメッセージを表示して、いったん停止します。
この確認は 5 回目の SQL クエリを実行したあとに表示されます。確認が表示された時点で、最大 5 回分がクエリ実行回数としてカウントされています。SQL エラーで失敗した SQL クエリは、クエリ実行回数としてカウントされません。
エージェントモードを有効 / 無効にする
エージェントモードはアドバンスドモードでのみ有効 / 無効にできます
シンプルモードでは、エージェントモードが常に有効です。エージェントモードを有効 / 無効にする場合は、アドバンスドモードに切り替えてください。切り替える手順は、SORACOM Query Studio の利用スタイル を参照してください。
SORACOM Query Studio を表示した直後と、ページを再読み込みしたあとは、シンプルモードが選択されています。
SQL アシスタントの をクリックします。
エージェントモードの有効/無効が切り替わります。
実行した SQL クエリを確認する
エージェントモードで SQL クエリを実行している間は、SQL アシスタントが実行中の内容を順に表示します。
自動実行が完了すると、実行の経過が 1 つにまとまって表示されます。 をクリックすると、SQL アシスタントが実行した SQL クエリが順に表示されます。さらに をクリックすると、実行した SQL クエリを確認したり、SQL クエリエディタにコピーしたりできます。
