> For the complete documentation index, see [llms.txt](https://docs.cerrix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cerrix.com/cerrix-documentation-nl/cerrix-functionaliteiten/admin-settings/api-documentation/api-endpoint-relationships.md).

# Relaties tussen API-endpoints

## Twee API-families - verschillende sleuteltypen

CERRIX biedt endpoints aan in twee parallelle "families":

| Familie                            | Padvoorvoegsel                                                                               | Identifiertype                                              | Doel                                                                                 |
| ---------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| Directe gegevens                   | `/directdata/v1/*`                                                                           | `GUID` (uuid)                                               | Genormaliseerd, één entiteit per endpoint, ontworpen voor correcte relationele joins |
| Geaggregeerd / vooraf samengevoegd | `/riskdata/*`, `/eventdata/*`, `/moidata/*`, `/findingreportdata/*`, `/taskdata/*`, `/kri/*` | tekenreeks `*Identifier` (bijv. `R-001`, `EV-014`, `M-022`) | Vooraf samengevoegde/gedenormaliseerde payloads                                      |

Brug tussen families: entiteiten tonen zowel hun `GUID` en hun `Identifier`. Om een rij te koppelen die afkomstig is van `/eventdata/events` (sleutel: `identifier`) met één uit `/directdata/v1/eventmoi` (sleutel: `EventGuid`), gebruik de `Identifier` ↔ `GUID` mapping die beschikbaar is op de bijbehorende direct-data-entiteit.

## Primaire sleutels per endpoint (Direct Data)

| Domein                         | Eindpunt                                                 | PK                                          | Bedrijfssleutel       |
| ------------------------------ | -------------------------------------------------------- | ------------------------------------------- | --------------------- |
| Gebruiker                      | `/directdata/v1/gebruiker`                               | `GUID`                                      | —                     |
| Organisatie                    | `/directdata/v1/Organisatie`                             | `GUID`                                      | `Pad`                 |
| Bedrijfsdimensie               | `/directdata/v1/businessdimension`                       | `GUID`                                      | `Pad`                 |
| Raamwerkdimensie               | `/directdata/v1/frameworkdimension`                      | `GUID`                                      | `Pad`                 |
| Risico                         | `/directdata/v1/risico`                                  | `GUID`                                      | `Identifier`          |
| Beheersmaatregel               | `/directdata/v1/control`                                 | `GUID`                                      | `Identifier`          |
| Incident                       | `/directdata/v1/incidents`                               | `ID` (uuid)                                 | `Identifier` (nummer) |
| Derde partij                   | `/directdata/v1/thirdparty`                              | `GUID`                                      | `Identifier`          |
| Contract van Derde partij      | `/directdata/v1/thirdpartycontract`                      | `ContractGUID`                              | `Contractnummer`      |
| Bevindingenrapport             | `/directdata/v1/findingreport`                           | `GUID`                                      | `Rapportnummer`       |
| Assessment                     | `/directdata/v1/assessment`                              | `GUID`                                      | —                     |
| KRI                            | `/directdata/v1/kri`                                     | `GUID`                                      | `Identifier`          |
| Taakreeks                      | `/directdata/v1/taskseries`                              | `GUID`                                      | —                     |
| MoI (Risico)                   | `/directdata/v1/riskmoi`                                 | `GUID`                                      | `Identifier`          |
| MoI (Beheersmaatregel)         | `/directdata/v1/controlmoi`                              | `GUID`                                      | `Identifier`          |
| MoI (Gebeurtenis)              | `/directdata/v1/eventmoi`                                | `GUID`                                      | `Identifier`          |
| MoI (Derde partij)             | `/directdata/v1/thirdpartymoi`                           | `GUID`                                      | `Identifier`          |
| MoI (BIM / Bevindingenrapport) | `/directdata/v1/bimmoi`                                  | `GUID`                                      | `Identifier`          |
| MoI (Gegevensbeheer)           | `/directdata/v1/datamanagementmoi`                       | `GUID`                                      | `Identifier`          |
| MoI-opmerking                  | `/directdata/v1/moicomment`                              | `GUID`                                      | —                     |
| Adv. Effectiviteit             | `/directdata/v1/advancedeffectiveness`                   | `GUID`                                      | —                     |
| Geav. Eff. Periode             | `/directdata/v1/advancedeffectivenessperiod`             | `GUID`                                      | —                     |
| Geav. Eff. Monster             | `/directdata/v1/advancedeffectivenesssample`             | `GUID`                                      | —                     |
| Geav. Eff. Teststapdefinitie   | `/directdata/v1/advancedeffectivenessteststepdefinition` | `GUID`                                      | —                     |
| Geav. Eff. Teststapinvoer      | `/directdata/v1/advancedeffectivenessteststepinput`      | `GUID`                                      | —                     |
| Ontwerp/Implementatie          | `/directdata/v1/designimplementation`                    | `GUID`                                      | —                     |
| Eenvoudige effectiviteit       | `/directdata/v1/simpleeffectiveness`                     | `GUID`                                      | —                     |
| Aangepaste veldwaarden         | `/directdata/v1/{entity}customfieldvalues`               | samengesteld (`{Entiteit}Guid`, `Veldnaam`) | —                     |

Voor geaggregeerde eindpunten is de PK de `*Identifier` string binnen elke array (bijv. `Risico Identifier`, `Beheersmaatregel Identifier`, `Gebeurtenis Identifier`, `moI Identifier`, `rapportnr.`).

## Vreemde-sleutelkaart (hoe te koppelen over eindpunten heen)

### **Hiërarchie / Basisgegevens (overal gebruikt)**

* `Organisatie.ParentGuid` → `Organisatie.Guid` (zelfverwijzende boom; `Pad` toont het volledige broodkruimelpad).
* `Bedrijfsdimensie.ParentGuid` → `Bedrijfsdimensie.Guid` (boom).
* `Kaderdimensie.ParentGuid` → `Kaderdimensie.Guid` (boom).
* `Gebruiker.OrganisatieGuid` → `Organisatie.Guid`.

### **Risico**

* `Risico.OrganisatieGuid` → `Organisatie.Guid`
* `Risico.Bedrijfsdimensies[]` → `Bedrijfsdimensie.Guid`
* `Risico.Kaderdimensies[]` → `Kaderdimensie.Guid`
* `Risico.GekoppeldeBeheersmaatregelen[]` → `Beheersmaatregel.Guid` (veel-op-veel; gespiegeld door `Beheersmaatregel.GekoppeldeRisico's[]`)
* `Risico.GekoppeldeRisicoMois[]` → `RisicoMoi.Guid` (ook bereikbaar via `RisicoMoi.RisicoGuid`)
* `Risico.GekoppeldeBimMois[]` → `BimMoi.Guid`
* `Risico.GekoppeldeDerdePartijen[]` → `DerdePartij.Guid`
* `Risico.GoedkeurderGebruikerGuid` / `BeoordelaarGebruikerGuid` → `Gebruiker.Guid`

### **Beheersmaatregel**

* `Beheersmaatregel.OrganisatieGuid` → `Organisatie.Guid`; `Beheersmaatregel.ToepasselijkeOrganisaties[]` → `Organisatie.Guid`
* `Beheersmaatregel.Bedrijfsdimensies[]` / `Kaderdimensies[]` → overeenkomstige dimensie `GUID`
* `Beheersmaatregel.GekoppeldeRisico's[]` → `Risico.Guid`
* `Beheersmaatregel.LinkedBeheersmaatregelMois[]` → `BeheersmaatregelMoi.Guid` (ook `BeheersmaatregelMoi.BeheersmaatregelGuid`)
* `Beheersmaatregel.LinkedBimMois[]` → `BimMoi.Guid`
* `Beheersmaatregel.LinkedThirdParties[]` → `DerdePartij.Guid`
* `DesignImplementation.BeheersmaatregelGuid` → `Beheersmaatregel.Guid`
* `SimpleEffectiveness.BeheersmaatregelGuid` → `Beheersmaatregel.Guid`
* `AdvancedEffectiveness.BeheersmaatregelGuid` → `Beheersmaatregel.Guid`
* `AdvancedEffectivenessPeriod.BeheersmaatregelGuid` → `Beheersmaatregel.Guid`; `.PeriodGuid` verwezen vanuit `AdvancedEffectiveness.PeriodGuid`
* `AdvancedEffectivenessSample.EffectivenessGuid` → `AdvancedEffectiveness.Guid`
* `AdvancedEffectivenessTestStepDefinition.EffectivenessGuid` → `AdvancedEffectiveness.Guid`
* `AdvancedEffectivenessTestStep(invoer).SampleGuid` → `AdvancedEffectivenessSample.Guid`; `.TestStepDefinitionGuid` → stapdefinitie
* `BeheersmaatregelScoreOverview.BeheersmaatregelGuid` → `Beheersmaatregel.Guid`

### **MoI's (één MoI-tabel per bovenliggend type)**

Elke MoI-variant bevat één bovenliggende FK plus de universele MoI-velden:

| MoI-eindpunt                       | Bovenliggende FK                               | Bovenliggend eindpunt                                                                                  |
| ---------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `/directdata/v1/riskmoi`           | `RisicoGuid`                                   | `/directdata/v1/risico`                                                                                |
| `/directdata/v1/controlmoi`        | `BeheersmaatregelGuid`                         | `/directdata/v1/control`                                                                               |
| `/directdata/v1/eventmoi`          | `EventGuid`                                    | Gebeurtenis (verouderd `/Gebeurtenisdata/Gebeurtenissen.identifier`; hetzelfde record, zie brug in §1) |
| `/directdata/v1/thirdpartymoi`     | `DerdePartijGuid`                              | `/directdata/v1/thirdparty`                                                                            |
| `/directdata/v1/bimmoi`            | `BevindingenrapportGuid` (+ `BeoordelingGuid`) | `/directdata/v1/findingreport`, `/directdata/v1/assessment`                                            |
| `/directdata/v1/datamanagementmoi` | `VerwerkingsdoelGuid`                          | gegevensbeheer (Verwerkingsdoel)                                                                       |

Gemeenschappelijke MoI-FK's over alle varianten: `OrganisatieVerantwoordelijkeGuid`, `OrganisatieBeoordelaarGuid` → `Organisatie.Guid`; `Verantwoordelijken[]`, `Gedelegeerden[]`, `Beoordelaars[]` → `Gebruiker.Guid`; `Bedrijfsdimensies[]` → `Bedrijfsdimensie.Guid`.`MoiOpmerking.MoiGuid` → elke MoI `GUID` (werkt ongeacht de bron — opmerkingen zijn universeel).Het geaggregeerde eindpunt `/moigegevens/moi` combineert alle MoI-bronnen in één payload; `moi_Bron` geeft aan van welk bovenliggend type het afkomstig is.

### **Gebeurtenissen (legacy) en Incidenten (vervangende module)**

De Gebeurtenissenmodule is legacy en wordt vervangen door Incidenten. Legacy-gebeurteniskoppelingen (string identifiers):

* `/eventdata/eventmois` — `eventMoIs.gebeurtenis Identifier` → `gebeurtenissen.Identifier`.
* `/eventdata/databreachmois` — `Datalek.gebeurtenis Identifier` → `gebeurtenissen.Identifier`; `moIs.gebeurtenis Identifier` → hetzelfde.
* `/riskdata/riskcontrolmois` gebeurtenissenblok: `gebeurtenissen.gebeurtenisIdentifier` koppelt aan `gebeurtenissen.Identifier`.

Nieuwe Incidenten (`/directdata/v1/incidents`):

* `ID` (uuid) PK, `Identifier` (nummer) zakelijke sleutel.
* `RapporterendeOrganisatie`, `GetroffenOrganisaties[]`, `VeroorzaaktDoorOrganisaties[]` → `Organisatie.Guid`.
* `GetroffenDerdePartijen[]`, `VeroorzaaktDoorDerdePartijen[]` → `DerdePartij.Guid`.
* `Classificatie` → `IncidentClassificatie.Id`; `Incidenttypen[]` → `Incidenttype.Id`.
* `RootCauseCategorie[]` → basisgegevens van de root-cause-categorie.
* `BedrijfsdimensieGuids[]` / `FrameworkdimensieGuids[]` → respectieve dimensies.
* `MeldendeOrganisatieGuid`, `VerantwoordelijkeGuids[]`, `BeoordelaarGuids[]`, `GeïnformeerdeGuids[]` → `Gebruiker.Guid`.

### **Derde partij**

* `ThirdParty.OrganisatieVerantwoordelijkeGuid` / `OrganisatieUiteindelijkeGerechtigdeGuid` → `Organisatie.Guid`
* `ThirdParty.OrganisatiesInGebruik[]` → `Organisatie.Guid`
* `ThirdParty.Verantwoordelijken[]` → `Gebruiker.Guid`
* `ThirdParty.GekoppeldeRisico's[]` → `Risico.Guid`; `.GekoppeldeControls[]` → `Beheersmaatregel.Guid`
* `ThirdParty.GekoppeldeThirdPartyMois[]` → `ThirdPartyMoi.Guid` (ook `ThirdPartyMoi.ThirdPartyGuid`)
* `ThirdPartyContact.ThirdPartyGuid` → `DerdePartij.Guid`
* `ThirdPartyContract.ThirdPartyGuid` → `DerdePartij.Guid`
* `ThirdPartyContract.ContractOwnerGuid` → `Gebruiker.Guid`
* `ThirdPartyContract.Diensten[]` → `ThirdPartyServices.Id`
* Basisgegevens-FK's: `RelatieId` → `ThirdPartyRelationship.Id`; `KritikaliteitId` → `ThirdPartyCriticality.Id`; `StatusVanBetrokkenheidId` → `ThirdPartyStatusVanBetrokkenheid.Id`; `Diensten[]` → `ThirdPartyServices.Id`.

### **Bevindingenrapport / Assessment / BIM**

* `Assessment.BevindingenrapportGuid` → `Bevindingenrapport.Guid`
* `Assessment.GekoppeldeBimMois[]` → `BimMoi.Guid`
* `BimMoi.BevindingenrapportGuid` → `Bevindingenrapport.Guid`; `BimMoi.AssessmentGuid` → `Assessment.Guid`
* `Bevindingenrapport.OrganisatieVerantwoordelijkeGuid` / `OrganisatieBeoordelaarGuid` → `Organisatie.Guid`; `VerantwoordelijkeGuid` / `BeoordelaarGuid` → `Gebruiker.Guid`
* `Bevindingenrapport.RapporttypeId` → `BevindingenrapportRapporttype.Id`; `TotaalscoreId` → `BevindingenrapportRapporttypeScore.Id`; `ValidatietypeId` → `BevindingenrapportValidatietype.Id`
* Legacy `/findingreportdata/findingreportassessments` koppelt via `rapportnaam` + `rapportnr.`.

### **KRI**

* `Kri.Organisaties[]` → `Organisatie.Guid`
* `Kri.Bedrijfsdimensies[]` / `Kaderdimensies[]` → respectieve dimensies
* `Kri.Risicocatalogi[]` → `Risicocatalogus.Id`
* `KriDataValues.KriGuid` → `Kri.Guid`; `.Organisatie` → `Organisatie.Guid`
* Legacy `/kri/data/list` geeft Identifier terug; `POST /kri/data/store/{identifier}` schrijft terug via Identifier.

### **Taak**

* `Taak.gekoppeldeControls[].guid` (legacy) / `gekoppeldeControl` (POST) → `Beheersmaatregel.Guid`
* `Taak.gekoppeldeOrganisaties[]` → `Organisatie.Guid`
* `Taak.gekoppeldeBedrijfsdimensies[]` / `gekoppeldeFrameworkdimensies[]` → respectieve dimensies
* `Taak.verantwoordelijken[]` / `beoordelaars[]` → `Gebruiker.Guid`
* `TaskSeries.Responsibles[]` / `Beoordelaars[]` → `Gebruiker.Guid`

### **Aangepaste velden (patroon gedeeld door Beheersmaatregel, Derde partij, Derde partij-contract, Incident)**

* `{entity}customfields` geeft de velddefinities terug (`GUID`, naam, type, opties).
* `{entity}customfieldvalues` geeft rijen terug van `{Entiteit}Guid` + dynamisch `Veldnaam: waarde` paren.
* Koppel op `{Entiteit}Guid` (bijv. `BeheersmaatregelGuid`, `ThirdpartyGuid`, `ContractGUID`,`IncidentId`).

## Entiteit-relatiediagram

{% code expandable="true" collapsedlinecount="10" %}

```mermaid

erDiagram
    Organisatie ||--o{ Organisatie : "ParentGuid (boom)"
    Bedrijfsdimensie ||--o{ Bedrijfsdimensie : "ParentGuid (boom)"
    Kaderdimensie ||--o{ Kaderdimensie : "ParentGuid (boom)"

    Organisatie ||--o{ Gebruiker : "OrganizationGuid"

    %% Risico-zijde
    Organisatie ||--o{ Risico : "OrganizationGuid"
    Risico }o--o{ Beheersmaatregel : "Gekoppelde risico's / gekoppelde beheersmaatregelen"
    Risico }o--o{ Derde partij : "Gekoppelde derde partijen"
    Risico ||--o{ RiskMoi : "RiskGuid"
    Risico }o--o{ Bedrijfsdimensie : "Bedrijfsdimensies[]"
    Risico }o--o{ Kaderdimensie : "Kaderdimensies[]"
    RiskCatalogue ||--o{ Risico : "RiskCatalogueId"

    %% Beheersmaatregel-zijde
    Organisatie ||--o{ Beheersmaatregel : "OrganizationGuid"
    Beheersmaatregel ||--o{ ControlMoi : "ControlGuid"
    Beheersmaatregel ||--o{ DesignImplementation : "ControlGuid"
    Beheersmaatregel ||--o{ SimpleEffectiveness : "ControlGuid"
    Beheersmaatregel ||--o{ AdvancedEffectiveness : "ControlGuid"
    Beheersmaatregel ||--o{ ControlScoreOverview : "ControlGuid"
    AdvancedEffectiveness ||--o{ AdvancedEffectivenessPeriod : "PeriodGuid"
    AdvancedEffectiveness ||--o{ AdvancedEffectivenessSample : "EffectivenessGuid"
    AdvancedEffectiveness ||--o{ AdvEffTestStepDef : "EffectivenessGuid"
    AdvancedEffectivenessSample ||--o{ AdvEffTestStepInput : "SampleGuid"
    AdvEffTestStepDef ||--o{ AdvEffTestStepInput : "TestStepDefinitionGuid"

    %% Taken
    Beheersmaatregel ||--o{ Taak : "linkedControl"
    TaskSeries ||--o{ Taak : "(serie → taken)"

    %% Gebeurtenis / Incident
    Gebeurtenis ||--o{ EventMoi : "EventGuid / gebeurtenis Identifier"
    Gebeurtenis ||--o| DataBreach : "gebeurtenis Identifier"
    Gebeurtenis ||--o{ DataBreachMoi : "gebeurtenis Identifier"
    Organisatie ||--o{ Incident : "Rapporterende Organisatie / getroffen / veroorzaakt door"
    Derde partij }o--o{ Incident : "getroffen / veroorzaakt door derde partijen"
    IncidentClassification ||--o{ Incident : "Classificatie"
    IncidentType }o--o{ Incident : "IncidentTypes[]"

    %% Derde partij
    Organisatie ||--o{ Derde partij : "OrganizationResponsibleGuid"
    Derde partij ||--o{ ThirdPartyContact : "ThirdPartyGuid"
    Derde partij ||--o{ ThirdPartyContract : "ThirdPartyGuid"
    Derde partij ||--o{ ThirdPartyMoi : "ThirdPartyGuid"
    Derde partij ||--o{ ThirdPartyReview : "(beoordelingen)"
    ThirdPartyContract }o--o{ ThirdPartyServices : "Diensten[]"

    %% Bevindingenrapport / Assessment / BIM
    FindingReport ||--o{ Assessment : "FindingReportGuid"
    FindingReport ||--o{ BimMoi : "FindingReportGuid"
    Assessment ||--o{ BimMoi : "AssessmentGuid / LinkedBimMois"

    %% Gegevensbeheer MoI
    ProcessingPurpose ||--o{ DataManagementMoi : "ProcessingPurposeGuid"

    %% MoI-opmerkingen zijn universeel
    RiskMoi ||--o{ MoiComment : "MoiGuid"
    ControlMoi ||--o{ MoiComment : "MoiGuid"
    EventMoi ||--o{ MoiComment : "MoiGuid"
    ThirdPartyMoi ||--o{ MoiComment : "MoiGuid"
    BimMoi ||--o{ MoiComment : "MoiGuid"
    DataManagementMoi ||--o{ MoiComment : "MoiGuid"

    %% KRI
    KRI ||--o{ KRIDataValue : "KriGuid"
    Organisatie ||--o{ KRI : "Organizations[]"
    RiskCatalogue }o--o{ KRI : "RiskCatalogues[]"

    %% Overkoepelende basisgegevens op de meeste entiteiten (BD/FD/User-koppelingen hierboven weggelaten voor de leesbaarheid)
    Bedrijfsdimensie }o--o{ Beheersmaatregel : "Bedrijfsdimensies[]"
    Kaderdimensie }o--o{ Beheersmaatregel : "Kaderdimensies[]"
    Bedrijfsdimensie }o--o{ Derde partij : "Bedrijfsdimensies[]"
    Kaderdimensie }o--o{ Derde partij : "Kaderdimensies[]"
    Bedrijfsdimensie }o--o{ Incident : "BusinessDimensionGuids[]"
    Kaderdimensie }o--o{ Incident : "FrameworkDimensionGuids[]"
```

{% endcode %}

## Identifiers in de praktijk oplossen

De API is het integratievlak voor het bouwen van je eigen datamodel op CERRIX, dus werk bij het ontwerpen van je joins vanuit de endpoint-responses. In bijna elke integratie komen een paar praktische recepten terug.

### Gebruikers-GUID's naar namen oplossen

Velden die naar gebruikers verwijzen — zoals de uploader van bewijsmateriaal op een Testplan, of de lijst met reviewers op een taak in `/directdata/v1/tasks` — geven lijsten met gebruikers-GUID's terug. Los deze op naar namen door ze te koppelen aan `/directdata/v1/gebruiker` op `GUID`. Een lege lijst is een geldig resultaat: een lijst met reviewers die leeg terugkomt, betekent simpelweg dat er geen reviewer aan die taak is toegewezen.

### Laad Identifier-kolommen als tekst

Configureer je extractie om te lezen `GUID`, `ID`, en `Identifier` kolommen als **tekst** velden. Deze waarden kunnen letters bevatten, dus een pipeline die een numeriek type verwacht, slaat uiteindelijk lege (`NULL`) waarden op, ook al retourneert de API de identifiers correct. Als ID-kolommen leeg lijken in je dataplatform, controleer dan eerst het geconfigureerde gegevenstype van de extractie.

### Aanbevolen modelleringspatroon

Wanneer je de API landt in een datawarehouse- of Power BI-model:

* Laad elk Direct Data-endpoint als een eigen dimensie- of facttabel **gesleuteld op `GUID`**, terwijl `Identifier` het als een bedrijfsvriendelijke weergavekolom behoudt.
* Materialiseer many-to-many-arrays zoals `LinkedControls[]` en `LinkedRisks[]` als **brugtabellen**.
* Modelleer MoI's als één geconformeerde dimensie door (`UNION ALL`) de zes `*moi` eindpunten te combineren en een kolom voor oudertype af te leiden uit het broneindpunt.
* Gebruik de geaggregeerde eindpunten (`/riskdata/riskcontrol`, `/moigegevens/moi`, enzovoort) om je joins te controleren, of voor directe rapportage.


---

# 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.cerrix.com/cerrix-documentation-nl/cerrix-functionaliteiten/admin-settings/api-documentation/api-endpoint-relationships.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.