> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/ehs/3.7/first-steps/choose-the-ehs-firmware/introduction-to-standard-ehs-firmware/op5607-and-op5707/ehsx128-gen5-pmsm-pmsm-sh-ioconfig3.md).

# Machine drive IOConfig3

## Firmware specifications

<figure><img src="https://521571437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo99Izmvvw5eHT4ldzI4g%2Fuploads%2Fgit-blob-6e3a0fde96b6c0f97fcdd5644f09e3f2a71cd872%2FOP5700_ehs128_gen5_PMSM_ioconf3.png?alt=media" alt=""><figcaption></figcaption></figure>

* Compatible with Schematic Editor workflow
* Compatible with XG and XG2 platforms
* Solver eHS x128 Gen5
* 4x PMSM VdQ / BLDC and 2x PMSM Spatial Harmonics with
  * 1x Resolver and 1x encoder reserved per machine
  * double excitation PMSM resolver
* SFP inter-FPGA link
* FPGA Scope
* Power Measurement (RT-LAB S-Function workflow only)

## FPGA ports mapping table

<details>

<summary><strong>I/O mapping details table</strong></summary>

| Port Number | LoadIn                      | DataIn                               | DataOut                   |
| ----------- | --------------------------- | ------------------------------------ | ------------------------- |
| 1           | Config eHS                  | Inputs eHS                           | eHS Averaged              |
| 2           | Scenario / Rst eHS = Status | TSDO 1 - eHS 0 to 7                  | eHS DownSample            |
| 3           |                             | TSDO 2 - eHS 8 to 15                 | Digital In 4B - 0 to 7    |
| 4           | PWM 2B - 0 to 7             | TSDO 3 - eHS 16 to 23                | Digital In 4B - 8 to 15   |
| 5           | PWM 2B - 8 to 15            | TSDO 4 - eHS 24 to 31                | Digital In 4B- 16 to 23   |
| 6           | PWM 2B - 16 to 23           | TSDO 5 - eHS 32 to 39                | Digital In 4B- 24 to 31   |
| 7           | PWM 2B - 24 to 31           | TSDO 6 - eHS 40 to 47                | Analog In 1B - 0 to 7     |
| 8           | PWM 2A - 0 to 7             | TSDO 7 - eHS 48 to 55                | Analog In 1B - 8 to 15    |
| 9           | PWM 2A - 8 to 15            | TSDO 8 - eHS 56 to 63                | PMSM VDQ 1/2              |
| 10          | PWM 2A - 16 to 23           | TSDO 9 - eHS 64 to 71                | PMSM VDQ 3/4              |
| 11          | PWM 2A - 24 to 31           | Digital Out 2B - SDO 0 to 7          | PMSM SH 1/2               |
| 12          | Config AOMR (1A,3B)         | Digital Out 2B - SDO 8 to 15         | eHS Period Averaged       |
| 13          | eHS PWM 1 - eHS 24 to 31    | Digital Out 2B - SDO 16 to 23        | eHS Period DownSample     |
| 14          | eHS PWM 2 - eHS 0 to 7      | Digital Out 2B - SDO 24 to 31        | TimeOn Averaged           |
| 15          | eHS PWM 3 - eHS 8 to 15     | Digital Out 2A - SDO 0 to 7          | TimeOn DownSample         |
| 16          | eHS PWM 4 - eHS 16 to 23    | Digital Out 2A - SDO 8 to 15         | RMS and Power calculation |
| 17          | Config AIR                  | Digital Out 2A - SDO 16 to 23        |                           |
| 18          | Config PMSM VDQ 1/2         | Digital Out 2A - SDO 24 to 31        |                           |
| 19          | Config PMSM VDQ 3/4         | AOMR (1A,3B) /Analog Out 1A - 0 to 7 |                           |
| 20          | Config PMSM SH 1/2          | Analog Out 1A - 8 to 15              |                           |
| 21          |                             | AOMR (3A,4A) /Analog Out 3B - 0 to 7 |                           |
| 22          | SFP                         | Analog Out 3B - 8 to 15              |                           |
| 23          | Lookup table                | eHS PWM 1 - 0 to 7                   |                           |
| 24          | Config AOMR (3A,4A)         | eHS PWM 2 - 8 to 15                  |                           |
| 25          | RMS and Power calculation   | eHS PWM 3 - 16 to 23                 |                           |
| 26          |                             | eHS PWM 4 - 24 to 31                 |                           |
| 27          |                             | eHS SWG                              |                           |
| 28          |                             | PMSM VDQ 1/2                         |                           |
| 29          |                             | PMSM VDQ 3/4                         |                           |
| 30          |                             | PMSM SH 1/2                          |                           |
| 31          |                             | Analog Out 3A - 0 to 7               |                           |
| 32          |                             | Analog Out 3A - 8 to 15              |                           |
| 33          |                             |                                      |                           |
| 34          |                             | SFP                                  |                           |
| 35          |                             | Lookup Table Config                  |                           |
| 36          |                             | TSDO 10 - eHS 72 to 79               |                           |
| 37          |                             | TSDO 11 - eHS 80 to 87               |                           |
| 38          |                             | TSDO 12 - eHS 88 to 95               |                           |
| 39          |                             | Analog Out 4A - 0 to 7               |                           |
| 40          |                             | Analog Out 4A - 8 to 15              |                           |

</details>

## Supported I/O modules

### IOConfig3\_1

| Group 1A                                                                                                                        | Group 1B                                                                                                                    | Group 2A                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Group 2B                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Group 3A                                                                                                                        | Group 3B                                                                                                                        | Group 4A                                                                                                                        | Group 4B                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><a href="https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description">OP5330-3</a><br>16 Analog Outputs</p> | <p><a href="https://www.opal-rt.com/docs/op53xx/analog-input-modules/op5342-description">OP5342</a><br>16 Analog Inputs</p> | <p><a href="https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description">OP5369</a><sup>\*</sup><br>32 Digital Inputs</p>                                                                                                                                                                                                                                                                                                                               | <p><a href="https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description">OP5369</a><sup>\*</sup><br>32 Digital Outputs</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | <p><a href="https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description">OP5330-3</a><br>16 Analog Outputs</p> | <p><a href="https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description">OP5330-3</a><br>16 Analog Outputs</p> | <p><a href="https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description">OP5330-3</a><br>16 Analog Outputs</p> | <p><a href="https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description">OP5369</a><sup>\*</sup><br>32 Digital Outputs</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| or [OP5330-1](https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description), (via polymorphism)                 |                                                                                                                             | or [OP5353](https://www.opal-rt.com/docs/op53xx/digital-input-modules/op5353-description), [OP5351](https://www.opal-rt.com/docs/op53xx/digital-input-modules/op5351-description), [OP5357](https://www.opal-rt.com/docs/op53xx/digital-input-modules/op5357-description), [OP5358-3](https://www.opal-rt.com/docs/op53xx/digital-input-modules/op5358-description), [OP5358-5](https://www.opal-rt.com/docs/op53xx/digital-input-modules/op5358-description) (via polymorphism) | or [OP5360-1](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5360-2](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5360-3](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5352](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5352-description), [OP5354,](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5354-description) [OP5355](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5355-description), [OP5356-3](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5356-description), [OP5356-5](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5356-description) (via polymorphism) | or [OP5330-1](https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description), (via polymorphism)                 | or [OP5330-1](https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description), (via polymorphism)                 | or [OP5330-1](https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description), (via polymorphism)                 | or [OP5360-1](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5360-2](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5360-3](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5360-description), [OP5352](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5352-description), [OP5354,](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5354-description) [OP5355](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5355-description), [OP5356-3](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5356-description), [OP5356-5](https://www.opal-rt.com/docs/op53xx/digital-output-modules/op5356-description) (via polymorphism) |

<sup>\*</sup>Although the OP5369 supports bidirectional operation, the FPGA configuration limits subsections to a single direction.

## I/O module mapping and configuration (RT-LAB)

This section applies when using the **recommended S‑Function workflow** in **RT‑LAB**.

For I/O module mapping and configuration when using the **OPAL‑RT Board workflow**, refer to **I/O module mapping and configuration (HYPERSIM)**. The information provided there is also applicable when working with RT‑LAB.

### OpCtrl block configuration

Reference: [**OpCtrl**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/opctrl) block in RT-LAB

| Parameter                      | Value                                                                      |
| ------------------------------ | -------------------------------------------------------------------------- |
| **Primary Bitstream FileName** | VC707\_2-EX-0001-3\_10\_0\_41-eHSx128\_Gen5\_MachineDrive\_IOConfig3-4D-05 |
| **Board Type**                 | VC707                                                                      |

### Groups 1A, 3A, 3B and 4A - Analog outputs

Refer to [OP5350-3 pin assignment](https://www.opal-rt.com/docs/op53xx/analog-output-modules/op5330-description/db37f-pin-assignment) for hardware connections.

#### Schematic Editor analog outputs configuration

Electric circuit **measurement blocks** are directly mapped to the module's **analog outputs** in the Schematic Editor by selecting the block and assigning the desired module channel as the destination.

#### Analog Out block configuration

When using [**Analog Out**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/analog-out) blocks in the RT-LAB model, ensure you assign the correct **DataIn port number** to the channel group.

{% hint style="danger" %}
Mapping a single electric circuit measurement block to an analog output in Schematic Editor reserves all 16 channels for eHS, disabling Analog Out blocks in the RT‑LAB model.
{% endhint %}

| Parameter                                                               | CH00-07 | CH08-15 |
| ----------------------------------------------------------------------- | ------- | ------- |
| <p><strong>Group 1A</strong><br><strong>DataIn Port Number</strong></p> | 19      | 20      |
| <p><strong>Group 3A</strong><br><strong>DataIn Port Number</strong></p> | 21      | 22      |
| <p><strong>Group 3B</strong><br><strong>DataIn Port Number</strong></p> | 31      | 32      |
| <p><strong>Group 4A</strong><br><strong>DataIn Port Number</strong></p> | 39      | 40      |

### Group 1B - Analog inputs

Refer to [OP5342 pin assignment](https://www.opal-rt.com/docs/op53xx/analog-input-modules/op5342-description/db37f-pin-assignment) for hardware connections.

#### Schematic Editor analog inputs configuration

Electric circuit **sources blocks** are directly mapped to the module's **analog inputs** in the Schematic Editor by selecting the block and assigning the desired module channel as the source.

Electric circuit **machine blocks** can also have their **resolver excitation source** mapped to the module's **analog inputs** in the Schematic Editor by enabling the resolver for the machine block and assigning the desired module channel as the excitation source.

#### Analog In block configuration

When using [**Analog In**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/analog-in) blocks in the RT-LAB model, ensure you assign the correct **DataOut port number** to the channel group.​

| Parameter                                                                | CH00-07 | CH08-15 |
| ------------------------------------------------------------------------ | ------- | ------- |
| <p><strong>Group 1B</strong><br><strong>DataOut Port Number</strong></p> | 7       | 8       |

### Groups 2A, 2B and 4B - Digital inputs/outputs

Refer to [OP5369 pin assignment](https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description/db37f-pin-assignment) for hardware connections.

Each **OP5369** includes a **32‑channel digital I/O** module divided into four **8‑channel subsections**, each of which can be independently configured as either a digital input or a digital output.

#### Schematic Editor digital inputs/outputs configuration

Electric circuit **switch blocks** are directly mapped to the module’s **digital inputs** in Schematic Editor by selecting the block and assigning the desired module channel(s) as gate signal source(s).

Electric circuit **machine blocks** can have their **encoder outputs** mapped to the module's **digital outputs** in the Schematic Editor. However, the user does not select specific module channels; instead, encoder must be enabled for the machine, after which the encoder signals are automatically mapped to either **Group 2B**.

#### Mezzanine Option block configuration

To configure thresholds on the OP5369 32-channel digital I/O module, utilize the [**Mezzanine Option**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/mezzanine-option) block and set the desired threshold values for each 8-channel group.

**Mezzanine Option block for Group 2A**

| Parameter          | Value           |
| ------------------ | --------------- |
| **Mezzanine type** | OP5369 - 32 DIO |
| **Chassis slot**   | Slot 2 Module A |

**Mezzanine Option block for Group 2B**

| Parameter          | Value           |
| ------------------ | --------------- |
| **Mezzanine type** | OP5369 - 32 DIO |
| **Chassis slot**   | Slot 2 Module B |

**Mezzanine Option block for Group 4B**

| Parameter          | Value           |
| ------------------ | --------------- |
| **Mezzanine type** | OP5369 - 32 DIO |
| **Chassis slot**   | Slot 4 Module B |

#### Digital Input blocks configuration

When using [**Digital In**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/digital-in), [**PWM In**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/pwm-in), or [**Event Detector**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/event-detector) blocks in the RT-LAB model, ensure you assign the correct **DataOut port number** to the channel group.

| Parameter                                                                | CH00-07 | CH08-15 | CH16-23 | CH24-31 |
| ------------------------------------------------------------------------ | ------- | ------- | ------- | ------- |
| <p><strong>Group 4A</strong><br><strong>DataOut port number</strong></p> | 3       | 4       | 5       | 6       |

#### Digital Output block configuration

When using [**Digital Out**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/digital-out), [**PWM Out**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/pwm-out), or [**Event Generator**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/event-generator) blocks in the RT-LAB model, ensure you assign the correct **DataIn** **port number** to the channel group.

| Parameter                                                               | CH00-07 | CH08-15 | CH16-23 | CH24-31 |
| ----------------------------------------------------------------------- | ------- | ------- | ------- | ------- |
| <p><strong>Group 2B</strong><br><strong>DataIn port number</strong></p> | 11      | 12      | 13      | 14      |
| <p><strong>Group 4B</strong><br><strong>DataIn port number</strong></p> | 15      | 16      | 17      | 18      |

### SFP module

#### Schematic Editor SFP configuration

Electric circuit **sources blocks** can be mapped to the module's **SFP CH00** **input** in the Schematic Editor by selecting the block and assigning the desired **SFP input signal** as the source. All SFP input signals are carried through a **single SFP channel (CH00)**, which provides **32 input signals**. All other SFP channels are disabled in this firmware.

Electric circuit **measurement blocks** can be mapped to the module's **SFP CH00** **output** in the Schematic Editor by selecting the block and assigning the desired **SFP output signal** as the destination. All SFP output signals are carried through a **single SFP channel (CH00)**, which provides **32 output signals**. All other SFP channels are disabled in this firmware.

#### DataIn Send block configuration

Signals from the RT‑LAB model can be sent to the SFP CH00 output a [**DataIn Send**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/rt-lab-i-o-library/datain-send) block. Ensure you assign the correct **DataIn port number**.

{% hint style="danger" %}
Mapping a single electric circuit measurement block to an SFP output signal in Schematic Editor reserves all SFP output signals for eHS, disabling SFP output in the RT‑LAB model.
{% endhint %}

| Parameter              | SFP CH00 |
| ---------------------- | -------- |
| **DataIn Port Number** | 34       |

### Power measurement

To get RMS and power calculation from the eHS electric circuit, the [**Power Measurement Controller**](https://www.opal-rt.com/docs/rt-lab/simulink-blocks-reference/efpgasim-library/power-measurement-controller) block must be used in the RT-LAB model.

#### Power Measurement Controller block configuration

| Parameter                | Value |
| ------------------------ | ----- |
| **Load In Port Number**  | 25    |
| **Data Out Port Number** | 16    |

## I/O module mapping and configuration (HYPERSIM)

### OPAL-RT Board configuration

| Parameter                            | Value                                                                          |
| ------------------------------------ | ------------------------------------------------------------------------------ |
| **Chassis type**                     | VC707                                                                          |
| **Bitstream configuration location** | Standard repositories                                                          |
| **Bitstream configuration file**     | VC707\_2-EX-0001-3\_10\_0\_41-eHSx128\_Gen5\_MachineDrive\_IOConfig3-4D-05.pdi |

### Groups 1A, 3A, 3B and 4A - Analog outputs

Refer to [OP5369 pin assignment](https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description/db37f-pin-assignment) for hardware connections.

Electric circuit **measurement blocks** are directly mapped to the module's **analog outputs** in the Schematic Editor by selecting the block and assigning the desired module channel as the destination.

Mapping **HYPERSIM model signals** to the module's **analog outputs** follows the standard OPAL‑RT board workflow.

{% hint style="danger" %}
Mapping a single electric circuit measurement block to an analog output in Schematic Editor reserves all Group 1B - Analog inputs
{% endhint %}

### Group 1B - Analog inputs

Refer to [OP5342 pin assignment](https://www.opal-rt.com/docs/op53xx/analog-input-modules/op5342-description/db37f-pin-assignment) for hardware connections.

Electric circuit **sources blocks** are directly mapped to the module's **analog inputs** in the Schematic Editor by selecting the block and assigning the desired module channel as the source.

Electric circuit **machine blocks** can also have their **resolver excitation source** mapped to the module's **analog inputs** in the Schematic Editor by enabling the resolver for the machine block and assigning the desired module channel as the excitation source.

Mapping **HYPERSIM model signals** to the module's **analog inputs** follows the standard OPAL‑RT board workflow.

### Groups 2A, 2B and 4B- Digital inputs/outputs

Refer to [OP5369 pin assignment](https://www.opal-rt.com/docs/op53xx/digital-bidirectional-modules/op5369-description/db37f-pin-assignment) for hardware connections.

Each **OP48H10** includes a **32‑channel digital I/O** module divided into four **8‑channel subsections**, each of which can be independently configured as either a digital input or a digital output.

Electric circuit **switch blocks** are directly mapped to the module’s **digital inputs** in Schematic Editor by selecting the block and assigning the desired module channel(s) as gate signal source(s).

Electric circuit **machine blocks** can have their **encoder outputs** mapped to the module's **digital outputs** in the Schematic Editor. However, the user does not select specific module channels; instead, encoder must be enabled for the machine, after which the encoder signals are automatically mapped to either **Group 1A**. Open the **eHS Build Report** to determine the I/O group used.

Mapping **HYPERSIM model signals** to the module's **digital inputs/outputs** follows the standard OPAL‑RT board workflow.

### SFP module

Electric circuit **sources blocks** can be mapped to the module's **SFP CH00** **input** in the Schematic Editor by selecting the block and assigning the desired **SFP input signal** as the source. All SFP input signals are carried through a **single SFP channel (CH00)**, which provides **32 input signals**. All other SFP channels are disabled in this firmware.

Electric circuit **measurement blocks** can be mapped to the module's **SFP CH00** **output** in the Schematic Editor by selecting the block and assigning the desired **SFP output signal** as the destination. All SFP output signals are carried through a **single SFP channel (CH00)**, which provides **32 output signals**. All other SFP channels are disabled in this firmware.

Mapping **HYPERSIM model signals** to the **SFP module** follows the standard OPAL‑RT board workflow.

{% hint style="danger" %}
Mapping a single electric circuit measurement block to an SFP output signal in Schematic Editor reserves all SFP output signals for eHS, disabling SFP output mapping in the HYPERSIM model.
{% endhint %}


---

# 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://www.opal-rt.com/docs/ehs/3.7/first-steps/choose-the-ehs-firmware/introduction-to-standard-ehs-firmware/op5607-and-op5707/ehsx128-gen5-pmsm-pmsm-sh-ioconfig3.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.
