> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/ja/apurikshon/packages/package-deployment.md).

# パッケージの割り当て

Main (Required) や Available などの管理グループを通じた RealmJoin パッケージの割り当て、競合する割り当ての優先順位付け、そして基本サブスクリプションから管理サブスクリプションへの変換。

{% embed url="<https://www.youtube.com/watch?v=BdF3rvMbjFs>" %}

割り当てにより、どのユーザーとデバイスがパッケージをどのように受け取るかが決まります。これらは、 **割り当て** の［概要］タブにあるセクションで管理します [パッケージの詳細ページ](https://docs.realmjoin.com/ja/apurikshon/packages/package-details.md)。割り当て方法は、パッケージが次のいずれとしてサブスクライブされたかによって異なります。 [管理対象または基本](https://docs.realmjoin.com/ja/apurikshon/packages.md#managed-and-basic-subscriptions).

## 管理対象サブスクリプション

管理対象としてサブスクライブされたパッケージには、割り当てタイプごとに1つずつ、RealmJoin が管理する Entra ID グループが付属します。シナリオに合うグループのメンバーにすることで、ユーザーおよびデバイスを割り当てます。グループは RealmJoin Portal と Microsoft Entra ID の両方から管理できます。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fxi4sVnycw6e2HHezKaHS%2Fimage.png?alt=media&amp;token=3189db63-7807-4d93-a362-be02243dc789" alt=""><figcaption><p>パッケージの管理対象グループ</p></figcaption></figure>

デフォルトでは、グループ名は次の形式になります `app - <platform> - <app name>` （例： `app - Win - Igor Pavlov 7-Zip`）が Main 用で、他のタイプには次のようなサフィックスが付きます `（プレビュー）`, `（利用可能）`, `（アンインストール）` または `（更新）` 。命名スキームは次の場所で変更できます [グループ命名設定](https://docs.realmjoin.com/ja/to/general.md#group-naming-scheme).

{% hint style="info" %}
管理対象サブスクリプションを推奨します。プレビュー段階および [Update Automation](https://docs.realmjoin.com/ja/apurikshon/packages/package-updates.md#automation).
{% endhint %}

### 管理対象グループ

#### **Main（必須）**

RealmJoin または Intune がアプリケーションを自動的にインストールします。これらのアプリケーションは必須であり、デバイス上に見つからない場合、両方のソリューションが継続的にインストールを試みます。

#### **利用可能**

{% tabs %}
{% tab title="RealmJoin" %}
アプリケーションは RealmJoin Agent のトレイに表示され、ユーザーがダウンロードとインストールを手動で開始する必要があります。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FQkUe67EPZRg2mfEceVou%2Fimage.png?alt=media&amp;token=219923c1-59bb-47c0-857d-7ecdcd7fb94e" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Intune" %}
アプリケーションは Company Portal -> Apps に表示され、ユーザーがダウンロードとインストールを手動で開始する必要があります。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FtYyz0zHDoH8pVUeVeEBX%2Fimage.png?alt=media&amp;token=eb278ba8-9e42-4b45-a4e0-bcd3d428fcf0" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

#### プレビュー

プレビュー グループ内のユーザーとデバイスは、他のグループより先にパッケージの新しいバージョンを受け取ります。詳細については、 [プレビューを使用した段階的更新](https://docs.realmjoin.com/ja/apurikshon/packages/package-updates.md#staged-updates-with-preview).

#### アンインストール

RealmJoin または Intune は、割り当てられたユーザーおよびデバイスからパッケージをアンインストールします。

RealmJoin デプロイでは、Choco パッケージだけにアンインストール グループが作成されます。Craft パッケージには作成されません。

アンインストールの割り当ては、設定されたレベルに関わらず、Main および Available の割り当てより優先されます。アンインストール グループ内のデバイスでは、サインインしたユーザーが Main グループ内にいる場合でもパッケージがアンインストールされ、その逆も同様です。これより優先順位が高いのは [除外](#exclude) の割り当てのみです。詳細については、 [割り当ての優先順位](#assignment-priority-and-conflicts).

#### 更新

更新グループはオンデマンドで作成され、ソフトウェア タイトルの個別インストールを自動的に管理対象に取り込むため、セキュリティ パッチを含む新しいバージョンもこれらのデバイスに届きます。これは Intune の **利用可能** アプリを最新の状態に保つためのメカニズムであり、古いデバイスを一時的に次のように割り当てます **必須**.

詳細については、 [更新グループ](https://docs.realmjoin.com/ja/apurikshon/packages/update-group.md).

#### 除外

次を通じて明示的に有効化する必要があります **その他** > **除外の割り当て** （参照 [追加グループを有効化し、既定のグループを復元する](#enable-additional-and-restore-default-groups)）。指定したグループのユーザーおよびデバイスは、パッケージ全体および関連する管理対象グループでの割り当てから除外されます。

{% hint style="info" %}
このオプションは特定のケースでのみ使用すべきであり、割り当ての競合を管理するためのものではありません。除外メカニズムを使用する必要がないよう、ユーザーからグループへの明確な割り当てで常に割り当てを管理してください。多層的な割り当て構成は強く推奨しません。
{% endhint %}

**使用状況**

グループの除外割り当ては、割り当てられた除外グループ内のユーザーが、パッケージの管理対象グループ内で管理されないようにするために使用します。同じパッケージ内の管理対象グループからユーザーを削除することはありません。代わりに、特定のパッケージが同じユーザーに同時に割り当てられないようにします。

たとえば、64 ビット版 Adobe Reader パッケージ グループに割り当てられているユーザーが、32 ビット版も受け取らないようにするには、除外機能を使用します。64 ビット版パッケージ グループを、32 ビット版パッケージの除外グループとして割り当てます。

{% hint style="warning" %}
除外は他のすべてより先に評価されます。サインインしているユーザーまたは *または* デバイスがパッケージの除外グループのメンバーである場合、そのパッケージの他の割り当ては一切評価されません。Main、Available、Preview、Update、直接ユーザー割り当て、さらに **アンインストールも対象外です** 。そのパッケージはそのデバイスで単に無視され、インストールもアンインストールもされません。詳細については、 [割り当ての優先順位](#assignment-priority-and-conflicts).
{% endhint %}

#### Intune アプリの除外割り当て

Intune アプリもグループから除外できます。アプリの詳細ページで、次の場所にある［その他］>［除外の割り当て］を開きます *直接グループ* リストで、グループを除外する対象の意図を選択し（**必須**, **利用可能** または **アンインストール**）、グループを追加します。RealmJoin はネイティブの Intune 除外を作成するため、そのグループは次の場所にも表示されます *除外されたグループ* Intune 管理センター内の、その意図の項目にも表示されます。このオプションは、管理対象としてサブスクライブされているかどうかに関わらず、すべての Intune アプリで使用できます。

除外は、他の割り当てとともに次の場所に一覧表示されます *直接グループ*。除外を削除しても、その意図に対する除外だけが削除されます。同じグループの他の意図に対する除外はそのまま残ります。除外の追加および削除は監査ログに記録されます。

これらの除外を評価するのは RealmJoin ではなく Intune です。

* **意図ごと** — 除外は、それが作成された意図にのみ適用されます。グループを次から除外しても、 *必須* グループが次としても割り当てられている場合、Company Portal からアプリが非表示になることはありません *利用可能*.
* **除外が優先** — 同じ意図内では、除外されたグループは、次を含む含められたグループより優先されます *すべてのユーザー* と *すべてのデバイス* の割り当て。グループを同じ意図に対して同時に含めることも除外することもできないため、選択ツールには、選択した意図にまだ割り当てのないグループのみが表示されます。
* **同じグループ タイプ** — ユーザー対象の割り当てからはユーザー グループを、デバイス対象の割り当てからはデバイス グループを除外します。Intune は、ユーザー割り当てからデバイス グループを除外すること、またはその逆をサポートしていません。
* **アンインストールなし** — 除外は割り当てを停止するだけです。既にアプリがインストールされているデバイスでは、アプリは引き続きインストールされたままです。削除するには、 *アンインストール* の割り当てを使用します。
* **メイン アプリのみ** — 除外はメインの Intune アプリに作成されます。管理対象更新中、プレビュー アプリは独自の割り当てを維持します。

変更は次回の Intune チェックイン時にデバイスに反映されます。以下を参照してください [アプリの割り当てに関する Microsoft のドキュメント](https://learn.microsoft.com/en-us/intune/intune-service/apps/apps-deploy) 詳細はこちら。

### 割り当ての優先順位と競合

管理対象パッケージは、ユーザー（ユーザー グループ経由または直接）およびデバイス（デバイス グループ経由、詳細については [デバイスへのパッケージの割り当て](https://docs.realmjoin.com/ja/realmjoin-agent/realmjoin-client/multi-user-devices.md#option-a-assign-packages-to-devices)）に割り当てることができます。デバイスとサインインしているユーザーが同じパッケージの異なるグループに属する可能性があるため、RealmJoin バックエンドはデバイスの構成を生成する際に競合を決定論的に解決します。

管理対象パッケージでは、グループ管理は RealmJoin Portal によって処理され、作成後に各グループの GUID を使用します。これにより、ポータルは各グループに関連付けられたプロビジョニング タイプを識別し、それらの優先順位を決定できます。これにより、ユーザーまたはデバイスが誤って複数のプロビジョニング グループに割り当てられたシナリオでも、決定論的な動作が保証されます。

パッケージごとに、サインインしているユーザー、そのユーザーのグループ、デバイスのグループの割り当てが収集され、次の順序で評価されます。

1. **除外** — 収集された割り当てのうち、 *いずれかの* が除外の割り当てである場合、パッケージは完全に除外されます。アンインストールを含め、他の項目は評価されません。
2. **アンインストール** — 収集された割り当てのうち、 *いずれかの* 残りの割り当てのうち、いずれかがアンインストールの割り当てである場合、ユーザー グループ、デバイス グループ、または直接ユーザー割り当てのいずれに由来するかに関わらず、パッケージはアンインストールされます。
3. **直接ユーザー割り当て** — ユーザーに直接（グループ経由ではなく）割り当てられたパッケージは、ユーザー グループまたはデバイス グループのいずれに由来するかに関わらず、すべてのグループ割り当てより優先されます。
4. **グループ割り当て** — ユーザー グループとデバイス グループは同等に扱われ、プロビジョニング タイプによって（高い順に）順位付けされます：\
   \[Update] - Preview - Available - Required\
   ユーザーのグループとデバイスのグループが同じプロビジョニング タイプの場合は、ユーザー グループの割り当てが使用されます。

実質的な優先順位（高い順）は次のとおりです。

\[Exclude] - Uninstall - \[Update] - Preview - Available - Required

#### 管理対象およびクラシックの優先順位カスケード

上記の順序は既定の **管理対象カスケード**であり、この場合は Available の割り当てが Main（Required）の割り当てより優先されます。反対の動作、つまり Main と Available の両方のグループに属するユーザーまたはデバイスにパッケージを必須としてインストールする動作が必要な場合は、次に切り替えてください **クラシック カスケード**:

* **管理対象カスケード** （既定）：\[Exclude] - Uninstall - \[Update] - Preview - **利用可能** - **必須**
* **クラシック カスケード**： \[Exclude] - Uninstall - \[Update] - Preview - **必須** - **利用可能**

カスケードは次の2つのレベルで設定できます。

* **Tenant 全体** — ［設定］>［一般］>［アプリ構成］で、次を有効にします *管理対象アプリのクラシック優先順位カスケード*。スイッチを変更すると確認が求められ、パッケージごとのオーバーライドがないすべてのユーザーおよびすべてのパッケージに直ちに反映されます。詳細については、 [管理対象アプリの優先順位カスケード](https://docs.realmjoin.com/ja/to/general.md#managed-app-priority-cascade).
* **パッケージごと** — パッケージの [詳細設定](https://docs.realmjoin.com/ja/apurikshon/packages/package-settings.md#expert-settings)、 *優先順位カスケード* 設定は、そのパッケージに限り Tenant の既定値をオーバーライドします： *Tenant の既定値を使用* （推奨）、 *管理対象カスケード* または *クラシック カスケード*.

このスイッチは管理対象パッケージにのみ影響し、Main と Available 間の順位にのみ影響します。Exclude、Uninstall、Update、Preview はその位置を維持し、Basic パッケージは、その割り当てのいずれかが Required である場合、常に必須としてインストールされます。

{% hint style="info" %}
デバイス グループの割り当ては、Tenant でデバイス割り当てが有効な場合にのみ評価されます。Tenant でデバイス割り当て機能が有効かどうかについては、RJ サポートにお問い合わせください。有効でない場合、Exclude および Uninstall グループを含むデバイスのグループ メンバーシップは考慮されません。

Exclude または Uninstall の割り当ては、現在のデバイスでそのエキスパート設定により割り当て自体がフィルター除外されている場合は無視されます（例： *VDI のみ* / *VDI では無視*, *ハイブリッド参加デバイスのみ* / *ハイブリッド参加デバイスでは無視*, *個人用デバイスでは無視*）。詳細については、 [詳細設定](https://docs.realmjoin.com/ja/apurikshon/packages/package-settings.md#expert-settings).
{% endhint %}

{% hint style="warning" %}
上記のルールは、RealmJoin Agent が割り当てを解決する方法を説明したものです。Intune 経由でデプロイされたパッケージでは、同じグループが Intune アプリに割り当てられ、Intune は独自の競合解決を適用します。特に、Intune はユーザー グループの割り当てからデバイス グループを除外すること、またはその逆をサポートしていません。詳細については、 [Intune アプリの除外割り当て](#exclude-assignments-for-intune-apps)。以下を参照してください [アプリ割り当ての競合に関する Microsoft のドキュメント](https://learn.microsoft.com/en-us/intune/intune-service/apps/apps-deploy#how-conflicts-between-app-intents-are-resolved) 詳細はこちら。
{% endhint %}

### メンバーの割り当てと移動

{% hint style="warning" %}
ユーザーおよびデバイスは、任意の時点で1つの RealmJoin 管理対象グループにのみ属するようにしてください。
{% endhint %}

次の **管理対象メンバー** リストには、パッケージの管理対象グループ内のすべてのユーザーおよびデバイスと、それらが所属するグループが表示されます。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fgit-blob-4969c2c91384131426f4d4e1cbf6fe10e2b60910%2Fpkg-managed-members.png?alt=media" alt="Managed members list with Move to links and a nested member"><figcaption><p>管理対象メンバー</p></figcaption></figure>

* **割り当てます** ユーザーまたはデバイスを Main グループに追加します。
* **移動先：\[main] \[preview] \[available] \[uninstall]** メンバーを現在のグループから選択したグループに移動します。
* 削除アイコンは、メンバーをそのグループから削除します。
* 入れ子になったグループのメンバーは次のように表示されます *間接（入れ子）* 。これらは入れ子になったグループでのみ変更できます。

既存のグループなどから多数のメンバーを一度にコピーするには、 **その他** > **一括操作** を管理対象グループ自身のページで使用します。

### 追加グループを有効化し、既定のグループを復元する

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Ft9P4J6LHAbAkgcaZPbQQ%2Fimage.png?alt=media&amp;token=a0593e78-3f33-4fca-8d07-c6a480de1e95" alt=""><figcaption></figcaption></figure>

次の **その他** のボタン **直接グループ** リストでは、次の操作を利用できます：

* **更新グループを有効にする** / **更新グループを無効にする** - 次を参照 [更新グループ](https://docs.realmjoin.com/ja/apurikshon/packages/update-group.md).
* **除外の割り当て** - 次を割り当てる [除外](#exclude) グループ。
* **既定のグループを復元** - 削除された管理対象グループを再作成します。

## 基本サブスクリプション（レガシー）

基本パッケージには、関連付けられた Microsoft Entra グループがありません。次を使用してください **割り当てます** 次の **直接グループ** または **直接ユーザー** リストで、グループ、デバイス、またはユーザーを手動で割り当てます。

基本パッケージの新しい割り当ては、既定で Available です。次を使用してください **\[設定]** 割り当てのリンクでこれを変更します。詳細については、 [割り当て設定](#assignment-settings).

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FPaBdqESviHIokxBnQA5Y%2Fimage.png?alt=media&amp;token=a4f392b9-dc49-438d-b373-320477e51987" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FwNCcuDXYYbQu0yLBm8Qr%2Fimage.png?alt=media&amp;token=77b1f499-24d8-401e-83cb-7b7325c82c76" alt=""><figcaption></figcaption></figure>

### 基本から管理対象への移行

RealmJoin 基本パッケージは管理対象に変換できます。この変換は、Intune 基本パッケージおよび次としてマークされたパッケージでは利用できません *プレリリース*.

{% stepper %}
{% step %}

### パッケージを変換する

基本 RealmJoin パッケージを開き、次を選択します **その他** > **管理対象アプリに変換** 次の **直接グループ** リスト。変換は直ちに開始されます。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FlwCxNzo8vWbyzYTGSVPL%2Fimage.png?alt=media&amp;token=634e3140-c165-418a-b787-3c4289e9101d" alt=""><figcaption><p>パッケージ リストで基本パッケージを識別する</p></figcaption></figure>

RealmJoin は次を実行します：

* 既定の管理対象グループを作成し、Tenant の [自動化の既定値](https://docs.realmjoin.com/ja/apurikshon/packages/package-updates.md#automation),
* 以前に割り当てられたグループを、対応する管理対象グループに入れ子にします：Required グループは Main に、Available は Available に、Uninstall は Uninstall に、
* 直接割り当てられたユーザーを、対応する管理対象グループに追加します。

基本の割り当てに対して行われた設定は、管理対象グループに引き継がれます。

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FObw0jcTQ0A7FtnKDHtAk%2Fimage.png?alt=media&amp;token=f3dc43b2-7b19-49d5-95e2-13ba2d462bae" alt=""><figcaption><p>移行前</p></figcaption></figure>

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FSQIb1asGXoiG1bcMSJZV%2Fimage.png?alt=media&amp;token=6d872b0f-a838-48bc-9a6f-30a3b54f0564" alt=""><figcaption><p>移行後</p></figcaption></figure>
{% endstep %}

{% step %}

### プレビュー パッケージと結合する（提供されている場合）

同じバージョンのプレリリース パッケージが存在する場合、ダイアログ **プレビュー アプリと結合** が開きます。新しいプレビューとして使用するパッケージを選択するか、次を選択します **結合せずに続行**.
{% endstep %}

{% step %}

### オプション：メンバーを管理対象グループに直接取り込む

入れ子になったグループを直接メンバーに置き換えるには、管理対象グループを開いて次を選択します **その他** > **メンバーを引き上げる**。入れ子になったグループを選択し、次を選択します **割り当てを削除** を選択して後で入れ子のグループを削除するか、または **割り当てを維持** を選択して維持し、次をクリックします **実行**.

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FHCS9QnvLCQiN4Yc2uMxM%2Fimage.png?alt=media&amp;token=8da99fb2-2903-4487-84a0-b6163f15ccaa" alt=""><figcaption><p>メンバーを引き上げる</p></figcaption></figure>
{% endstep %}
{% endstepper %}

{% hint style="warning" %}

* **除外の割り当ては変換されません。** これらは変換中に削除されます。必要に応じて、管理対象パッケージ上で次を通じて再作成してください **その他** > **除外の割り当て** 。
* このパッケージのユーザーが同じパッケージの別の基本サブスクリプションにも割り当てられている場合、変換はブロックされます。まず重複を解消してください。
  {% endhint %}

## 割り当て設定

次の各割り当てには、 **直接グループ** と **直接ユーザー** リストには **\[設定]** リンクがあります。これを開くと、 **割り当て設定**が開き、パッケージの次の設定を上書きします [エキスパート設定](https://docs.realmjoin.com/ja/apurikshon/packages/package-settings.md#expert-settings) が、この1つの割り当てに対して適用されます。これらを表示するには、次が必要です `CanSeeAppAssignmentSettings`、変更するには `CanChangeAppAssignmentSettings`.

{% tabs %}
{% tab title="RealmJoin パッケージ" %}

<figure><img src="https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fgit-blob-48abd4bd53d75454ae478c4a4d493fd9b02ef86f%2Fpkg-assignment-settings.png?alt=media" alt="Assignment settings dialog of a RealmJoin package"><figcaption><p>RealmJoin パッケージの割り当て設定</p></figcaption></figure>

* **非表示** - ユーザーのリストからパッケージを非表示にします。
* **必須** - パッケージを Available ではなく Required としてインストールします。割り当てタイプが管理対象グループに従う管理対象パッケージでは利用できません。
* **自動アップグレード**, **VDI のみ / VDI では無視**, **ハイブリッド参加デバイスのみ / ハイブリッド参加デバイスでは無視**, **個人用デバイスでは無視**, **展開速度**, **メイン アプリの制限** と **ユーザー部分の制限** - パッケージの [エキスパート設定](https://docs.realmjoin.com/ja/apurikshon/packages/package-settings.md#expert-settings) と同じ設定を、この割り当てにのみ適用します。未設定のままの設定はパッケージの設定に従います。
* **引数** - この割り当てのインストール引数。例：別の言語。
  {% endtab %}

{% tab title="Intune パッケージ" %}

* **必須** - アプリを Available ではなく Required として割り当てます。管理対象パッケージでは利用できません。
* **更新の優先順位** - Android アプリのみ。Managed Google Play がアプリを更新する方法： **既定値**, **延期** または **優先**.
  {% endtab %}
  {% endtabs %}


---

# 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.realmjoin.com/ja/apurikshon/packages/package-deployment.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.
