> For the complete documentation index, see [llms.txt](https://docs.codatum.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codatum.jp/codatum-ai/agent-context.md). # エージェントコンテキスト エージェントコンテキストは、Codatum Agentへ自動的に渡す前提情報です。指標の定義、参照すべきNotebook、分析時の注意事項などを登録することで、毎回のメッセージに同じ説明を入力せずに利用できます。 {% hint style="info" %} エージェントコンテキストはアクセス権限を変更する機能ではありません。Codatum Agentが参照できる情報と実行できる操作は、利用するユーザーと[AIプロファイル](/codatum-ai/ai-profile.md)の権限範囲に制限されます。 {% endhint %} ## コンテキストの種類 Codatum Agentでは、次のコンテキストを自動的に読み込みます。 | 種類 | 設定場所 | 読み込まれる条件 | | -------- | --------------------------------------- | --------------------------- | | 個人 | プライベートフォルダ直下の`.agent`フォルダ | Codatum Agentの利用時 | | チームスペース | チームスペース直下の`.agent`フォルダ | そのチームスペース内のNotebookを開いている場合 | | Notebook | Notebook内の`.agent`ページ | そのNotebookを開いている場合 | | AIプロファイル | AIプロファイルの補足情報、コンテキストNotebook、コンテキストフォルダ | そのAIプロファイルを利用している場合 | プライベートフォルダとチームスペースの`.agent`フォルダでは、サブフォルダを含むすべてのNotebookが読み込まれます。AIプロファイルにフォルダを設定した場合も、サブフォルダを含むすべてのNotebookが読み込まれます。 ## `.agent`フォルダ プライベートフォルダまたはチームスペースのルートで追加メニューを開き、`新規エージェントコンテキストフォルダ`を選択すると、`.agent`フォルダと`Agent Context Index`ノートブックが作成されます。作成されたノートブックには、後述する推奨構成のテンプレートが入力されています。 `.agent`フォルダは次の場所に作成できます。 * プライベートフォルダの直下 * チームスペースの直下 ワークスペースフォルダの直下や、通常のサブフォルダ内には作成できません。 `.agent`フォルダ内のNotebookには、文章だけでなく、SQLブロックや保存済みの実行結果を含めることができます。SQLブロックを使用すると、指標の算出方法や標準クエリをコンテキストとして渡せます。 ## Notebookの`.agent`ページ Notebook内に`.agent`という名前のページを作成すると、そのNotebookを表示している場合にページの内容が読み込まれます。 Notebook固有の前提や注意事項には`.agent`ページを使用し、個人またはチーム共通の情報には`.agent`フォルダを使用します。 ## AIプロファイルのコンテキスト AIプロファイルには、次のコンテキストを設定できます。 * 補足情報 * コンテキストNotebook * コンテキストフォルダ コンテキストNotebookまたはフォルダを参照するには、利用するユーザーに対象の閲覧権限が必要です。参照できないNotebookが含まれるAIプロファイルは利用できません。 チームスペース内にコンテキスト専用のNotebookやフォルダを作成すると、チームスペースの権限によって編集者と閲覧者を管理できます。 ## 自動読み込みの設定 Agent画面の入力欄にある設定メニューから、次のエージェントコンテキストを種類ごとに自動読み込みするか設定できます。 * 個人 * チームスペース * Notebook AIプロファイルに設定されたコンテキストは、選択したAIプロファイルの設定として読み込まれます。 入力欄のコンテキスト使用量を開くと、現在自動読み込みの対象になっているNotebookやページを確認できます。 ## 常時読み込みと必要時の参照 遅延読み込みを有効にする設定項目はありません。常時読み込む情報と必要な場合だけ参照する情報は、Notebookの配置とAIプロファイルへの紐付けによって分けます。 | 読み込み方 | 設定 | 動作 | | ---------------------- | --------------------------------------------------------------- | ------------------------------------------------------------ | | 個人のコンテキストを常時読み込む | プライベートフォルダ直下の`.agent`フォルダにNotebookを配置し、自動読み込みの`個人`を有効にする | Codatum Agentの実行時に、フォルダとサブフォルダ内のすべてのNotebookを読み込みます | | チームスペースのコンテキストを読み込む | チームスペース直下の`.agent`フォルダにNotebookを配置し、自動読み込みの`チームスペース`を有効にする | そのチームスペースのNotebookを開いている場合に、フォルダとサブフォルダ内のすべてのNotebookを読み込みます | | Notebook固有のコンテキストを読み込む | Notebookに`.agent`ページを作成し、自動読み込みの`Notebook`を有効にする | そのNotebookを開いている場合に`.agent`ページを読み込みます | | AIプロファイルで常時読み込む | AIプロファイルのプレーンテキスト、コンテキストNotebook、コンテキストフォルダに設定する | そのAIプロファイルを使用するたびに読み込みます。フォルダを設定した場合はサブフォルダ内のNotebookも対象です | | 必要な場合だけ参照する | Indexだけを上記のいずれかへ配置し、詳細なNotebookは通常のフォルダへ配置して、Indexから対象ページへリンクする | Indexは自動的に読み込み、詳細なNotebookは質問に応じてリンクから参照します | 自動読み込みの`個人`、`チームスペース`、`Notebook`を無効にすると、該当するコンテキストは自動的に読み込まれません。無効化は遅延読み込みへの切り替えではありません。また、この設定はAIプロファイルに設定されたコンテキストには適用されません。 必要時に詳細なNotebookを参照させるには、利用するユーザーが対象を閲覧でき、AIプロファイルのNotebookアクセスが`権限のある全てのノートブック`に設定されている必要があります。`表示中のノートブックのみ`の場合、現在のNotebook外に配置した詳細情報は参照できません。 ## 推奨構成 `.agent`フォルダには詳細なナレッジを直接集約せず、必要な情報を探すためのIndexノートブックだけを置くことを推奨します。 `.agent`フォルダ内のNotebookはAgent実行時に自動読み込みされます。詳細な仕様や過去の分析を大量に配置すると、質問に関係のない情報にもコンテキストを使用し、必要な情報を判断しにくくなります。 詳細情報は通常のNotebookやフォルダに配置し、Indexノートブックには次の情報を記載します。 * どのような情報が存在するか * どのような質問で参照するか * 正本となるNotebookのページリンク * Notebookの保存場所 * 検索に利用できるキーワード * 情報が見つからない場合や判断できない場合の扱い この構成では、Codatum Agentは最初にIndexだけを読み込み、質問に必要なページのリンクから詳細を参照できます。 {% hint style="warning" %} 参照先には、Notebook名だけでなく対象ページへのリンクを必ず設定してください。Notebook名や保存場所だけでは、Codatum Agentが`.agent`フォルダ外のページを直接特定できず、検索結果に依存します。対象ページをCodatumで開き、ページのURLをコピーしてIndexへリンクとして挿入します。 {% endhint %} ### Indexノートブックの構成例 ```markdown # Agent Context Index ## 共通ルール * 指標の定義は「KPI定義」Notebookを正本とする * 定義が見つからない場合は推測せず、ユーザーへ確認する * SQLを作成する前に対象期間とタイムゾーンを確認する ## Knowledge Map ### 売上・受注 * 参照先: [売上・受注指標](https://app.codatum.com/workspace/WORKSPACE_ID/notebook/NOTEBOOK_ID/PAGE_ID) * 保存場所: チームスペース「Data Knowledge」 * 利用する場面: 売上、受注、キャンセルに関する分析 * 検索キーワード: 売上、受注、キャンセル、GMV ### 顧客 * 参照先: [顧客定義](https://app.codatum.com/workspace/WORKSPACE_ID/notebook/NOTEBOOK_ID/PAGE_ID) * 保存場所: チームスペース「Data Knowledge」 * 利用する場面: 新規顧客、既存顧客、継続率に関する分析 * 検索キーワード: 顧客、新規、既存、継続率 ``` 例の`WORKSPACE_ID`、`NOTEBOOK_ID`、`PAGE_ID`は、実際の対象ページのURLに置き換えます。リンクに加えてチームスペース名やフォルダ名も記載すると、参照先の目的と管理場所を判断しやすくなります。 ## 避ける構成 次のような構成は推奨されません。 * `.agent`フォルダへ詳細な仕様書や過去の分析をすべて配置する * 同じ指標の定義を複数のコンテキストへ重複して記載する * 正本や参照先を示さず、要約だけを記載する * 更新日や適用範囲が不明なルールを記載する * コンテキストによってアクセス権限やツール実行範囲を制御しようとする アクセス範囲や利用できるツールは、Notebook・チームスペースのアクセス権限とAIプロファイルの権限で設定してください。 ## 関連ページ * [Codatum Agent](/codatum-ai/ai-agent.md) * [AIプロファイル](/codatum-ai/ai-profile.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.codatum.jp/codatum-ai/agent-context.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.