# AIエージェント (ベータ版)

{% hint style="warning" %}
この機能は現在ベータ版です。仕様については予告なく変更となる場合がございます。
{% endhint %}

AIエージェントは、自然言語による指示を受けて、データ分析やNotebookの作成・編集を自律的に実行する機能です。 カタログやNotebookのコンテンツを参照しながら、ユーザーの意図に沿った分析を進めることができます。

{% hint style="info" %}
Codatum Agentへのリクエストに含まれる情報は、トレーニング目的には使用されません。 ただし、Notebookのコンテンツやデータソースの一部を含む情報が、選択されたLLMプラットフォームに送信されます。ご利用にあたっては、お客様の社内AI利用ポリシーをご確認ください。
{% endhint %}

## 主な機能

* 自然言語による指示の実行:
  * チャットで指示を入力するだけで、AIエージェントが必要な操作を自律的に実行します。
* コンテンツの参照:
  * カタログやNotebookのコンテンツを参照しながらクエリ作成などを実行します。
* テーブルの探索:
  * カタログの情報やテーブルのカラム情報をもとに、分析に利用するテーブルを自動で探索します。
* Notebookの作成・編集:
  * チャット欄に分析結果を返すだけでなく、新規Notebookの作成や既存Notebookの編集を行うことも可能です。

## 利用方法

セットアップ方法や、基本的な使い方は[ご利用ガイド](https://app.codatum.com/public/workspace/6683260fe9a1b289052c4dec/link/69dcaed11c620509f7c6cff3/notebook/69dc8c944c2ef1474da7bf1e/69dc8c944c2ef1474da7bf1f/?thm=LIGHT\&ts=1776128111386)でご確認いただけます。\
Agentは以下の2種類の表示モードで起動でき、それぞれASKモード・Agentモードの2つの操作モードで利用することができます。

* 表示モード
  * **サイドパネルモード**: UI上のAgentアイコンから起動します。Notebook閲覧時は右側にサイドパネルとして表示されます。
    * 閲覧中のNotebookをコンテキストとして利用することができるので、特定のNotebookを参照してAgentを実行する場合はサイドパネルモードの利用を推奨します。
  * **フルページモード**: UI上のサイドパネルから起動します。
    * 特定のNotebookを参照しないデータ探索やNotebookの作成時には、フルページモードの方がチャットの内容を確認しやすくなっております。
* 操作モード
  * **ASKモード**: クエリの実行を含むデータ分析を行いますが、Notebookの作成・編集は行いません。データについて調べたいときに利用します。
    * サイドパネルモードでAgentを実行する場合に、Notebookの編集を行いたくない際はASKモードを推奨します。
  * **Agentモード**: Notebookの作成・編集やチャートの追加など、すべての操作を実行します。Notebookの作成やチャートの追加などを行いたいときに利用します。

### 権限範囲

Codatum Agentによる操作はAgentを利用するユーザーの権限の範囲で実行されます。

* Editor
  * SQLの実行やNotebookの編集など幅広い操作が可能
* Viewer
  * Notebookのコンテンツや実行済みのデータの閲覧のみが可能

Agentが探索可能なNotebookや利用可能なコネクションについても実行するユーザーがアクセス可能な範囲に限定されます。

{% hint style="info" %}
Agentに独自の権限範囲を設定する機能は現状提供されておりません。 Agentに読み込ませたくないデータが存在する場合などは、SQLの実行を手動承認として都度確認するなど運用面での注意が必要となります。 エージェントコンテキストファイルに記載することで探索範囲等を一定制限することは可能です。
{% endhint %}

### Agentコンテキスト

テキストボックスの左上の「本」のアイコンをクリックすることで、Agentに渡されるコンテキストを確認することができます。

### コンテキストの指定

`@` を使って、AIエージェントに参照させるコンテキストを指定できます。

| 表示画面                   | 指定できるコンテキスト                   |
| ---------------------- | ----------------------------- |
| Notebook閲覧時（サイドパネルモード） | テーブル、Notebook、保存済みクエリ、SQLブロック |
| フルページモード、その他の画面表示時     | テーブル、Notebook、保存済みクエリ         |

## Agent画面

### 各種アイコン

Agentのチャット画面右上のアイコンから以下の操作を行うことができます

* 新しいチャット
  * 現在のチャットを離れて新しいチャットを開始します
    * コンテキストが肥大するとToken消費効率が悪化するので、異なる分析を行う場合などはチャット画面を切り替えることが推奨されます
* チャット履歴
  * 過去のチャットの履歴を確認することができます
* セッション情報
  * 開始時刻や合計トークンといった利用状況が確認できます
  * サイドパネルモードからフルページモードへの移動も可能です
* 閉じる
  * チャット画面を閉じます

チャット欄下部からは以下の操作を行うことができます

* フィードバック送信
  * Codatumチームにフィードバックを送信することが可能です
    * 「会話ログを含める」や「ページコンテキストを含める」にチェックをする場合には、会話に機密情報などが含まれていないかご注意ください

### Agent設定

テキストボックス下部のAgent設定から以下の設定が可能です

* ASKモード/Agentモードの切り替え
* 優先利用コネクションの切り替え:
  * 優先的に利用するコネクションを選択することができます
  * デフォルトのAutoの場合には最適なコネクションをエージェントが選択します
* ユーザー設定
  * Enterで改行
  * ツール実行の自動承認:
    * SQLの実行について、コネクション毎に自動で実行するかどうかを選択できます
    * BigQueryの場合は、ドライランの結果に基づいて自動実行可能なクエリ読み込みサイズの上限を設定することも可能です
  * エージェントコンテキストの自動読み込み:
    * エージェントコンテキストファイルを自動で読み込むかどうかを設定できます
  * AIプロファイルの切り替え:
    * 設定済みのAIプロファイルの中からどれを利用するかを選択できます
    * AIプロファイル毎にモデルやコンテキストノートブックの設定が可能なので、用途に応じて利用するモデルやコンテキストを使い分けることが可能です
    * 参考：[AIプロファイル](/codatum-ai/ai-profile.md)
  * 言語

## エージェントコンテキストファイル

以下の階層にエージェントコンテキストフォルダを作成することができます。

* ワークスペース
* チームスペース
* プライベートフォルダ

また、個別のNotebookに対して、`.agent`と命名したページを追加することでエージェントコンテキストページを作成することができます。

コンテキストファイルにSQLブロックを追加することで、特定の指標の算出方法などをAgentにコンテキストとして渡すことが可能です。

## 未対応のページ

現在、以下のページではAIエージェントによる操作ができません。

* ノートブックホーム
* クエリ
* カタログ
* ワークフロー
* レポート

## 利用状況の確認　　

トークンの使用量は、画面左端のナビゲーションから「ワークスペース設定」>「サブスクリプション」>「使用量」で確認できます。

## データプライバシー

Codatum Agentへのリクエストはトレーニング目的では使用されません。 Agentへのリクエスト実行時にコンテキストとしてNotebookの内容やデータの一部がLLMのエンドポイントに送信される場合がございます。

{% hint style="info" %}
[サービスサイトAIエージェントページ](https://codatum.jp/agent)より先行登録が可能です。
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.codatum.jp/codatum-ai/ai-agent.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.