> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/maiagent-user-guide/ja/build/choose-channel/line-works.md).

# 会話プラットフォーム連携：LINE WORKS

LINE WORKS チャネルの連携：Developer Console で Client App と Bot を作成し、Service Account と Bot Secret を取得して、Callback URL の設定と有効化を行います。

LINE WORKS は、LINE の企業向けコミュニケーションツールです。連携すると、従業員は別のシステムを開くことなく、普段使っている LINE WORKS で直接 Agent と会話できます。1 対 1 のダイレクトメッセージとグループでの会話に対応しています。

{% hint style="info" %}
LINE WORKS と LINE は別のプラットフォームであり、認証情報も設定方法もまったく異なります。一般消費者向けの LINE 公式アカウントを連携する場合は、[チャネルの連携：LINE](https://docs.maiagent.ai/maiagent-user-guide/ja/build/choose-channel/line.md)を参照してください。
{% endhint %}

## 連携前の確認事項 <a href="#pre-integration-checklist" id="pre-integration-checklist"></a>

* [MaiAgent プラットフォーム](https://admin.maiagent.ai/)で「AI アシスタント」を作成済みであること
* LINE WORKS の管理者権限があること（[管理者画面](https://admin.worksmobile.com/)にログインできること）
* [LINE WORKS Developer Console](https://developers.worksmobile.com/)にアクセスできること

{% hint style="warning" %}
この連携には 6 つの認証情報が必要です。また、**チャネル作成後は認証情報を変更できません**。先にステップ 1 とステップ 2 を完了し、6 つの認証情報をすべて揃えてからステップ 3 に進んでください。
{% endhint %}

***

## ステップ 1：Client App の作成と Service Account の取得 <a href="#step-create-client-app" id="step-create-client-app"></a>

### 1. Developer Console の ClientApp ページを開く <a href="#step-go-to-clientapp" id="step-go-to-clientapp"></a>

[LINE WORKS Developer Console](https://developers.worksmobile.com/)にログインし、左側のメニューで <mark style="color:blue;">API</mark> → <mark style="color:blue;">ClientApp</mark> を選択して、<mark style="color:blue;">Add client app</mark> をクリックし、App を作成します。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-0d792c7b976ddc8399f167d41ee79992a0caa192%2Flineworks-console-clientapp-list.png?alt=media" alt="Developer Console の ClientApp 一覧ページ"><figcaption><p>Developer Console → API → ClientApp</p></figcaption></figure>

### 2. 4 つの認証情報を取得する <a href="#step-get-app-credentials" id="step-get-app-credentials"></a>

作成した App の詳細ページを開き、以下の 4 項目を取得します。

| 認証情報                | Console 上の場所                                                                                  |
| ------------------- | --------------------------------------------------------------------------------------------- |
| **Client ID**       | <mark style="color:blue;">Client ID</mark> フィールド                                              |
| **Client Secret**   | <mark style="color:blue;">Client Secret</mark> フィールド                                          |
| **Service Account** | <mark style="color:blue;">Service Account</mark> フィールド。形式は `xxxxx.serviceaccount@ご利用のドメイン` です |
| **Private Key**     | <mark style="color:blue;">Private Key</mark> セクション。作成時に `.key` ファイルをダウンロードできます                |

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-22a6737d44f3e40f43a4b72a81fc4568dc81dfc8%2Flineworks-console-clientapp-detail.png?alt=media" alt="Client ID、Client Secret、OAuth Scopes、Service Account、Private Key が表示される Client App の詳細ページ"><figcaption><p>Client App の詳細ページ — 4 つの認証情報と OAuth Scopes はすべてこのページにあります</p></figcaption></figure>

### 3. OAuth Scopes を設定する <a href="#step-set-oauth-scopes" id="step-set-oauth-scopes"></a>

同じページの <mark style="color:blue;">OAuth Scopes</mark> セクションで、以下の権限を付与してください。付与しないと、Agent はメッセージの送受信やメンバー名の取得ができません。

| Scope         | 説明                                   |
| ------------- | ------------------------------------ |
| `bot`         | Bot を管理します                           |
| `bot.message` | メッセージを送信します                          |
| `bot.read`    | Bot の設定を読み取ります                       |
| `user.read`   | メンバー情報を読み取ります（会話内で発言者名を表示するために使用します） |

{% hint style="info" %}
同じページの <mark style="color:blue;">トークン設定</mark> で、Access Token の有効期間を調整できます。MaiAgent がトークンの発行と更新を自動で管理するため、ここはデフォルト値のままで構いません。
{% endhint %}

{% hint style="danger" %}
**Private Key をダウンロードできるのは 1 回だけです。** Service Account の作成時に `.key` ファイルをダウンロードできますが、ページを離れると再取得できません。必ず安全な場所に保存してください。紛失した場合は再生成する必要があり、再生成すると既存の連携は直ちに無効になります。
{% endhint %}

秘密鍵は**暗号化されていない** PEM 形式である必要があります。先頭行は `BEGIN PRIVATE KEY` または `BEGIN RSA PRIVATE KEY` のマーカー（前後にそれぞれ 5 つのハイフンが付きます）、最終行は対応する `END` マーカーです。パスワードで保護された秘密鍵は MaiAgent で使用できません。暗号化されていないものを再生成してください。

***

## ステップ 2：Bot の作成と Bot ID・Bot Secret の取得 <a href="#step-create-bot" id="step-create-bot"></a>

Developer Console の左側のメニューで <mark style="color:blue;">Bot</mark> を選択し、Bot を作成して以下を取得します。

| 認証情報           | Console 上の場所                                                                                                |
| -------------- | ----------------------------------------------------------------------------------------------------------- |
| **Bot ID**     | <mark style="color:blue;">Bot ID</mark> フィールド                                                               |
| **Bot Secret** | <mark style="color:blue;">Bot Secret</mark> フィールド。LINE WORKS から届くメッセージが、ご利用の Bot から送られたものであることを検証するために使用します |

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-96baaf3f207c58a24ca25d1c10f0a2cdd692913a%2Flineworks-console-bot-detail.png?alt=media" alt="Bot 名、Bot ID、Bot Secret、Callback URL、Bot ポリシーが表示される Bot の詳細ページ"><figcaption><p>Bot の詳細ページ — Bot ID と Bot Secret はここにあります</p></figcaption></figure>

### グループでの会話に必要な設定 <a href="#step-enable-group-chat" id="step-enable-group-chat"></a>

Bot の <mark style="color:blue;">編集</mark> ページで <mark style="color:blue;">Bot ポリシー</mark> → <mark style="color:blue;">トークルームへの参加</mark> を探し、<mark style="color:blue;">チーム／グループ、1:N トークルームへの招待を許可</mark> にチェックを入れます。

チェックが入っていない場合、Bot は 1 対 1 のダイレクトメッセージにしか対応できず、グループに招待できません。

{% hint style="warning" %}
Bot 詳細ページの <mark style="color:blue;">Bot ポリシー</mark> の概要と、編集フォームの実際のチェック状態が一致しないケースが確認されています。表示が異なる場合は、<mark style="color:blue;">編集</mark> フォームのチェック状態を基準にしてください。
{% endhint %}

**Bot 名**もこのページで設定します。ユーザーがグループ内で Bot を @ メンションする際に入力する名前なので、入力しやすい名前にしてください。

{% hint style="info" %}
この段階では Callback URL の設定を省略します。MaiAgent が生成する Webhook URL が必要なため、**ステップ 4** で戻って設定します。
{% endhint %}

***

## ステップ 3：MaiAgent で LINE WORKS チャネルを作成する <a href="#step-create-channel-in-maiagent" id="step-create-channel-in-maiagent"></a>

### 1. チャネル連携を開く <a href="#step-go-to-channel-integration" id="step-go-to-channel-integration"></a>

MaiAgent の左側のメニューで <mark style="color:blue;">チャネル</mark> を選択し、右上の <mark style="color:blue;">チャネルを連携</mark> をクリックして、<mark style="color:blue;">LINE WORKS</mark> を選択します。

### 2. 基本設定を入力する <a href="#step-fill-basic-settings" id="step-fill-basic-settings"></a>

| フィールド               | 説明                                                                   |
| ------------------- | -------------------------------------------------------------------- |
| **名前**              | この連携に名前を付けます（必須）。MaiAgent 側のラベルであり、LINE WORKS に表示される Bot 名とは関係ありません。 |
| **AI アシスタント**       | 紐付ける Agent を選択します                                                    |
| **Bot ID**          | ステップ 2 で取得した値です（必須）                                                  |
| **Bot Secret**      | ステップ 2 で取得した値です（必須）                                                  |
| **Client ID**       | ステップ 1 で取得した値です（必須）                                                  |
| **Client Secret**   | ステップ 1 で取得した値です（必須）                                                  |
| **Service Account** | ステップ 1 で取得した値です（必須）                                                  |
| **Private Key**     | ステップ 1 でダウンロードした `.key` ファイルの内容を、先頭と末尾のマーカー行も含めてすべて貼り付けます（必須）        |

フォームは上部と下部の 2 つに分かれています。上部には名前、Agent、ステップ 2 で取得した Bot ID と Bot Secret があります。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-684d5f59dd73accc1c7177b4c3bc3b02345ab1a3%2Flineworks-create-form.png?alt=media" alt="名前、Agent、Bot ID、Bot Secret が並ぶ MaiAgent の LINE WORKS 作成フォーム上部"><figcaption><p>作成フォーム上部 — 名前、Agent、Bot ID、Bot Secret（画像内の値は例です）</p></figcaption></figure>

下にスクロールすると、ステップ 1 で取得した Client App の 3 つの認証情報と秘密鍵があります。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-456748551dd15070854358eaf0ceb8785d9f448d%2Flineworks-create-form-credentials.png?alt=media" alt="Client ID、Client Secret、Service Account、Private Key が並ぶ MaiAgent の LINE WORKS 作成フォーム下部"><figcaption><p>作成フォーム下部 — Client ID、Client Secret、Service Account、Private Key（画像内の値は例です）</p></figcaption></figure>

{% hint style="info" %}
Bot Secret と Client Secret は、入力後に黒丸でマスクされます。フィールド右側の目のアイコンをクリックすると内容を確認できます。Private Key には `.key` ファイルの内容をすべてそのまま貼り付けてください。改行も保持されます。
{% endhint %}

### 3. トークルームの設定 <a href="#step-chat-room-settings" id="step-chat-room-settings"></a>

| 設定                           | 説明                                                                                                                                                            |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **グループでは @Bot へのメンション時のみ返信** | 有効にすると、Bot はグループ内で @ メンションされた場合のみ返信します。**グループで使用する場合は有効にすることを推奨します**。無効の場合、グループ内のすべてのメッセージに対して Agent が返信します。                                                  |
| **リセットコマンドを有効化**             | 有効にすると、1 つ以上のコマンド文字列（例：「最初からやり直す」）を追加できます。ユーザーが LINE WORKS で送信したメッセージがいずれかのコマンドと完全に一致すると、そのユーザー用に新しい会話を開始します。コマンド自体には返信しません。ユーザーが次のメッセージを送ると、AI が新しい会話で回答します。 |

{% hint style="info" %}
「グループでは @Bot へのメンション時のみ返信」で照合するのは、**Developer Console で設定した Bot 名**であり、上の「名前」フィールドに入力した Inbox 名ではありません。Developer Console で Bot 名を変更すると、グループ内で @ メンションする名前も変わります。
{% endhint %}

### 4. 連携テスト <a href="#step-validate-credentials" id="step-validate-credentials"></a>

<mark style="color:blue;">連携テスト</mark> をクリックすると、MaiAgent が実際に LINE WORKS からアクセストークンを取得し、認証情報の組み合わせが正しいか確認します。

失敗した場合は、具体的な原因が画面に表示されます。よくあるエラーは次の 2 つです。

* <mark style="color:red;">認証情報の検証に失敗しました</mark> — Private Key が完全に貼り付けられているか（先頭と末尾のマーカー行を含み、途中の改行も欠けていないか）、暗号化されていない形式か、Service Account が完全か（`.serviceaccount@ドメイン` の後半部分を含むか）、Client ID と Client Secret が同じ App のものか、App にステップ 1 の 4 つの Scope が付与されているかを順に確認してください
* <mark style="color:red;">この Bot ID は別の受信トレイに紐付けられています</mark> — 同じ Bot を 2 つのチャネルに同時に接続することはできません。別の Bot を使用するか、既存のチャネルを先に削除してください

エラーメッセージはボタンの左側に表示されます。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-2861170cf6776a2e293279d60dc83f913bf8b18d%2Flineworks-validate-error.png?alt=media" alt="連携テストに失敗すると、連携テストボタンの左側にエラーメッセージが表示されます"><figcaption><p>連携テストのエラーメッセージの表示位置（この例では Bot ID がすでに紐付けられています）</p></figcaption></figure>

### 5. 作成して Webhook URL をコピーする <a href="#step-save-and-get-webhook-url" id="step-save-and-get-webhook-url"></a>

<mark style="color:blue;">チャネルを連携</mark> をクリックして作成を完了します。システムが **Webhook URL** を生成するので、次のステップで Developer Console に入力するためにコピーしておいてください。

このチャネルの設定ページに戻り、<mark style="color:blue;">API 連携</mark> フィールドからいつでも URL をコピーできます。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-a78d5c06347c503ad3522890174f6e39d536e127%2Flineworks-edit-page.png?alt=media" alt="Bot ID、Client ID、Service Account が読み取り専用で表示され、API 連携用の Webhook URL が用意されている LINE WORKS チャネルの設定ページ"><figcaption><p>作成後の設定ページ — 認証情報は表示されなくなりますが、Webhook URL はいつでもコピーできます</p></figcaption></figure>

***

## ステップ 4：Developer Console に戻って Callback URL を設定する <a href="#step-configure-callback-url" id="step-configure-callback-url"></a>

ステップ 2 で作成した Bot に戻り、<mark style="color:blue;">編集</mark> ページを開きます。

1. <mark style="color:blue;">Callback URL</mark> を <mark style="color:blue;">On</mark> に設定し、MaiAgent が生成した **Webhook URL** を入力します
2. <mark style="color:blue;">Callback Event Settings</mark> で受信するイベントにチェックを入れます。Agent が各種メッセージを処理できるよう、<mark style="color:blue;">Message Event</mark> 配下のすべての項目にチェックを入れることを推奨します。

| イベント                                     | 対応するユーザー操作      |
| ---------------------------------------- | --------------- |
| <mark style="color:blue;">TEXT</mark>    | テキストメッセージを送信します |
| <mark style="color:blue;">写真</mark>      | 画像を送信します        |
| <mark style="color:blue;">ファイル</mark>    | ファイルを送信します      |
| <mark style="color:blue;">音声</mark>      | 音声メッセージを送信します   |
| <mark style="color:blue;">動画</mark>      | 動画を送信します        |
| <mark style="color:blue;">位置情報の共有</mark> | 位置情報を共有します      |
| <mark style="color:blue;">スタンプ</mark>    | スタンプを送信します      |

3. グループで使用する場合は、<mark style="color:blue;">Join Event</mark> と <mark style="color:blue;">Joined Event</mark> にもチェックを入れることを推奨します
4. 設定を保存します

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-b55d63f49e2c97ae83bd1ea6737402a710e03e06%2Flineworks-console-bot-callback.png?alt=media" alt="Bot 編集ページの Callback URL と Callback Event Settings"><figcaption><p>Callback URL を On にして Webhook URL を入力し、その下でイベントの種類を選択します</p></figcaption></figure>

{% hint style="warning" %}
チェックを入れていない種類のイベントは、LINE WORKS から MaiAgent に送信されません。その種類のメッセージは発生しなかったものとして扱われ、Agent は返信せず、会話にも記録が残りません。
{% endhint %}

***

## ステップ 5：管理者画面で Bot を有効にする <a href="#step-activate-bot" id="step-activate-bot"></a>

[LINE WORKS 管理者画面](https://admin.worksmobile.com/)にログインし、左側の <mark style="color:blue;">サービス</mark> → <mark style="color:blue;">Bot</mark> を開き、右上の <mark style="color:blue;">Bot を追加</mark> をクリックして、ステップ 2 で作成した Bot を追加します。

追加すると、このページに Bot が表示されます。<mark style="color:blue;">利用権限</mark> フィールドで、どのメンバーに表示するかを設定できます（<mark style="color:blue;">すべて</mark> にすると、全メンバーが利用できます）。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-9bd2b2649536680af45839ab3c239677210c1100%2Flineworks-admin-bot.png?alt=media" alt="追加済みの Bot とその利用権限が表示される LINE WORKS 管理者画面のサービス → Bot ページ"><figcaption><p>管理者画面 → サービス → Bot — Bot を追加して利用権限を設定します</p></figcaption></figure>

{% hint style="warning" %}
このステップは見落としやすいので注意してください。Developer Console で Bot を作成しただけでは、**従業員の LINE WORKS にはまだ表示されません**。テナント管理者が管理者画面で追加して初めて、従業員が検索で見つけられるようになります。
{% endhint %}

***

## 利用を開始する <a href="#getting-started" id="getting-started"></a>

### 1 対 1 のダイレクトメッセージ <a href="#direct-message" id="direct-message"></a>

LINE WORKS で Bot 名を検索して会話を始めると、Agent が自動で返信します。

<figure><img src="https://2584873290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTvHx8hgwYGDTLD3A7xoW%2Fuploads%2Fgit-blob-61671de9af211a3e38edec25ce37d9a382dceea4%2Flineworks-chat-demo.png?alt=media" alt="LINE WORKS のトークルームで Agent と 1 対 1 で会話している様子"><figcaption><p>LINE WORKS のトークルームで Agent と直接会話できます</p></figcaption></figure>

{% hint style="info" %}
LINE WORKS のトークルームはプレーンテキストのみを表示し、**Markdown はレンダリングしません**。Agent が表や `**太字**`、`###` などの構文を出力すると、ユーザーには記号がそのまま表示されます。Agent のロール指示に書式ルールを追加し、リストには番号と改行を使い、Markdown 構文は使わないよう指定することを推奨します。
{% endhint %}

### グループでの会話 <a href="#group-conversation" id="group-conversation"></a>

Bot をグループに招待します。「グループでは @Bot へのメンション時のみ返信」を有効にしている場合は、`@Bot名 質問内容` と入力すると返信が返ってきます。

MaiAgent の<mark style="color:blue;">すべての会話</mark>では、同じグループは **1 つの会話**として表示され、メッセージに発言者名が表示されます。グループ内で複数のメンバーが発言しても、別々の会話に分かれることはありません。

### 対応するメッセージの種類 <a href="#supported-message-types" id="supported-message-types"></a>

| ユーザーが送信する内容             | Agent の処理方法             |
| ----------------------- | ----------------------- |
| テキスト                    | 直接回答します                 |
| 画像                      | 画像の内容を認識できます            |
| ファイル（PDF、Excel、Word など） | 内容を読み取り、関連する質問に回答します    |
| 音声メッセージ                 | テキストに変換して処理します          |
| 動画                      | 添付ファイルとして保存し、会話に記録します   |
| 位置情報                    | 「📍 位置情報が共有されました」と表示します |
| スタンプ                    | 「🏷 スタンプ」と表示します         |

Agent はテキストと添付ファイルでの返信に対応しています。1 件のテキストメッセージが LINE WORKS の上限である 1,000 文字を超える場合は、自動で分割して送信されるため、途中で切り捨てられることはありません。

***

## よくある質問 <a href="#faq" id="faq"></a>

### Agent が突然返信しなくなりました <a href="#troubleshoot-no-reply" id="troubleshoot-no-reply"></a>

まず、このチャネルの設定ページを開き、<mark style="color:red;">認証情報が無効です</mark>という警告が表示されていないか確認してください。

認証情報が無効になる最も一般的な原因は、**Developer Console で秘密鍵または Service Account を再生成したこと**です。古い認証情報が置き換えられると、MaiAgent はアクセストークンを取得できなくなります。

認証情報は既存のチャネルで変更できないため、新しい LINE WORKS チャネルを作成して、新しい認証情報を入力してください。

{% hint style="info" %}
認証情報が無効になったとき、外から分かる症状は Agent が返信しなくなることだけです。ユーザーにエラーメッセージは届きません。同僚から「Bot が反応しない」と報告されたら、まずここを確認してください。
{% endhint %}

### 認証情報を変更できないのはなぜですか？ <a href="#why-credentials-are-immutable" id="why-credentials-are-immutable"></a>

認証情報は機密データのため、MaiAgent は保存後にフロントエンドへ返さず、設定ページでの変更も受け付けません。通信中や画面上で認証情報が繰り返し露出するのを防ぐためです。Bot ID、Client ID、Service Account は読み取り専用で表示されるので、現在どの Bot に接続しているかを確認できます。

いずれかの認証情報を変更する場合は、このチャネルを削除して作成し直してください。

### グループで Bot を @ メンションしても反応しません <a href="#troubleshoot-group-mention" id="troubleshoot-group-mention"></a>

* @ メンションした名前が、MaiAgent の Inbox 名ではなく、**Developer Console の Bot 名**と一致しているか確認してください
* Bot の編集ページで、<mark style="color:blue;">Bot ポリシー</mark> → <mark style="color:blue;">トークルームへの参加</mark> の <mark style="color:blue;">チーム／グループ、1:N トークルームへの招待を許可</mark> にチェックが入っているか確認してください
* <mark style="color:blue;">Callback Event Settings</mark> で <mark style="color:blue;">TEXT</mark> にチェックが入っているか確認してください

### トークンを定期的に更新する必要はありますか？ <a href="#token-renewal" id="token-renewal"></a>

必要ありません。MaiAgent は Service Account で認証し、システムがアクセストークンを自動で発行・更新するため、時間の経過によって認証が無効になることはありません。Developer Console の認証情報を再生成しない限り、連携は有効なままです。


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maiagent.ai/maiagent-user-guide/ja/build/choose-channel/line-works.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
