> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/latex/fi/tietopankki/066-how-to-find-and-fix-errors-reported-in-generated-files.md).

# Kuinka löytää ja korjata luoduissa tiedostoissa raportoidut virheet

## Johdanto

Joskus Overleaf raportoi virheitä, jotka johtuvat tiedostoista, joiden nimet ovat esimerkiksi `output.toc`, `output.bbl`, jne., mutta nuo tiedostot *eivät edes ole olemassa projektissasi*. Joten mistä sellaiset tiedostot *tulevat* ja vielä tärkeämpää, miten *etsi* ja *korjata* virheet?

> ![Gen-toc-error.png](/files/9b4c9525dccba6e6ea98295cbdada118f2723b5d) “Mutta minä en edes **käyttäjät ovat** tätä `output.toc` tiedostoa projektissani!”

Nämä “salaperäiset tiedostot” ovat sivutiedostoja: LaTeX-käännösprosessissa luotuja aputiedostoja, mutta ne voivat myös laukaista virheitä, jotka yleensä johtuvat projektisi lähdetiedostojen koodausvirheistä. Tämä ohjeartikkeli käyttää [oikeaa virheitä täynnä olevaa esimerkkiä](#playing-detective-locating-errors-in-generated-files) näyttääkseen, miten tällaiset virheet jäljitetään niiden alkuperäkohtaan projektisi lähdetiedostoissa.

## LaTeX-käännösprosessissa luodut tiedostot

Tulostiedoston lisäksi `.pdf` tiedosto, LaTeX-käännösprosessi luo useita tiedostotyyppejä, jotka sisältävät tietoja tunnisteista, viittauksista, sivunumeroista jne. Jotkin aputiedostotyypit eivät synny suoraan LaTeX-kääntäjän toimesta, vaan muilla ladonnassa käytetyillä käsittelytyökaluilla: esimerkiksi muotoillut lähdeluettelot ja hakemistot. Kääntäjän on luettava nämä luodut tiedostot seuraavilla ajokerroilla, jotta lopullinen `.pdf` tiedosto täyttyy oikeilla listoilla, viitteillä ja ristiviittauksilla.

Se, että LaTeXin ja siihen liittyvien käsittelytyökalujen on kirjoitettava ja luettava aputietoja sisältäviä tiedostoja, tarkoittaa, että useita käännös-/käsittelyvaiheita voidaan tarvita ennen kuin koko tiedostoaineisto konvergoi (vakiintuu) tuottaakseen lopullisen ladotun (vakaan) `.pdf` tiedoston. Tyypillinen ladontakierto voisi olla:

`pdflatex`$$\mapsto$$`bibtex`$$\mapsto$$`pdflatex`$$\mapsto$$`pdflatex`

Paikallisessa LaTeX-asennuksessa saatat joutua suorittamaan jokaisen välivaiheen itse, tai voit käyttää esimerkiksi rakennustyökalua kuten [make](https://www.gnu.org/software/make/manual/), [latexmk](https://ctan.org/pkg/latexmk) tai [arara](https://ctan.org/pkg/arara), automatisoidaksesi tämän prosessiketjun. [Overleaf käyttää latexmk:tä](/latex/fi/tietopankki/064-how-does-overleaf-compile-my-project.md), ja tämä video näyttää, mitä tapahtuu aina, kun napsautat Overleaf-projektissasi “Käännä uudelleen” -painiketta.

{% embed url="<https://videos.ctfassets.net/nrgyaltdicpt/Uo3I2FXEI8H6aFPBZq171/e2139f9575a4db6955dc2278dc08283c/latexmk-ol.mp4>" %}

Yleensä luoduilla tiedostoilla on sama tiedostonimi kuin `.tex` käännettävällä tiedostolla; esimerkiksi, jos käännät `**main**.tex`, luodut tiedostot nimettäisiin `**main**.aux`, `**main**.toc`, `**main**.lof` jne. Kuitenkin, *Overleafissa* käännös `\jobname` on aina asetettu arvoon `**output**`, joten [luodut tiedostot](/latex/fi/tietopankki/150-view-generated-files.md) Overleaf-projektistasi nimetään aina `**output**.aux`, `**output**.toc`, `**output**.lof` jne. Nämä luodut tiedostot voidaan ladata Overleaf-projektistasi, mutta niitä ei voi tarkastella tai muokata Overleafissa.

## Luoduista tiedostoista raportoidut käännösvirheet

Koodausvirheet pääprojektissa `.tex` tiedostossa oleva virhe voi siirtyä luotuihin tiedostoihin. Esimerkiksi escapeaamaton `&` tiedostoihin `\section{Johdanto & tausta}` päätyisi luotuun `.toc` tiedostoon. Kun luotu `.toc` tiedosto luetaan myöhemmin seuraavalla `pdflatex` käännöskierroksella, virheilmoitus nousee esiin muodossa “peräisin .toc-tiedostosta”. Nykyiset LaTeX-lokit ja virheraportointi eivät kuitenkaan yhdistä `.toc` tiedoston (ja muiden luotujen tiedostojen) rivejä niiden alkuperäiseen sijaintiin lähde `.tex` tiedostossa: ei ehkä ole heti selvää, missä alkuperäinen virhe pitäisi korjata.

Tässä on esimerkki siitä, miten virheet esitetään toisessa LaTeX-editorissa: voit kyllä napsauttaa virheilmoitusta avataksesi siihen liittyvän rivin luodusta `.toc` tai `.aux` tiedostosta, mutta virheestä ei ole polkua alkuperäiseen sijaintiin `.tex` tiedostossa. Ja vaikka korjaisit virheen korvaamalla `&` verrattuna `\&` kansioon `.toc` tiedostossa, se ei oikeasti ratkaise ongelmaa: seuraavan kerran kun käännät `.tex` tiedoston, `.toc` tiedosto luodaan uudelleen, ja sama virhe kirjoitetaan uudelleen `.toc` tiedostossa.

![Texstudio-errors-generated-files.gif](/files/6b7beb8dcd4e9960531b1e49da7fe021cee0cb50)

Kun virhe raportoidaan luoduista tiedostoista tulevaksi, oikea tapa ratkaista ne on paikantaa todellinen alkuperäinen virhe lähdetiedostoista ja korjata ne. Virheilmoitukset sisältävät yleensä kontekstitietoa, jonkin virhettä ympäröivän tekstin tai koodin, joten tekstihaku lähdetiedostoista auttaa paikantamaan ne. Itse virheet ovat usein tavallisia: voit etsiä joitakin yleisiä virheitä [tätä ohjesivua](/latex/fi/latexin-perusteet/05-errors.md), tai [TeX FAQ -luettelosta](https://texfaq.org/#errors).

## Ensimmäiseksi yritä tyhjentää luodut tiedostot

Joskus luoduissa tiedostoissa olevat virheet ovat jäänteitä edellisestä käännöksestä. Vaikka olisit korjannut virheet `.tex` tiedostossa ja kääntäisit uudelleen, kääntäjä saattaa silti lukea luotuja tiedostoja, joissa virheet yhä ovat, ja tuottaa samat virheet kuin ennenkin. Voit yrittää poistaa luodut tiedostot ennen uudelleenkäännöstä. Ohjeet siihen Overleafissa löytyvät [täällä](/latex/fi/tietopankki/028-clearing-the-cache.md).

Jos näet yhä samat virheet senkin jälkeen, kun olet poistanut kaikki luodut tiedostot ja kääntänyt uudelleen, projektisi lähdetiedostoissa on todennäköisesti oikeita virheitä.

## Etsiväntyötä: virheiden paikantaminen luoduista tiedostoista

Seuraavat osiot tarjoavat vinkkejä siitä, mistä tällaisia virheitä kannattaa etsiä. Käytämme seuraavaa *tahallisesti virheitä sisältävää* esimerkkiprojektia salapoliisiharjoitukseemme. Valmis? Mennään!

[Avaa *virheitä sisältävä* Overleaf-projekti!](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Demo+of+LaTeX+compile+errors+reported+from+generated+files\&main_document=main.tex\&snip_uri=https%3A%2F%2Fassets.ctfassets.net%2Fnrgyaltdicpt%2F5qdEqgUidaYDHjOlBoKM7K%2F55395921a114edb36ed3d51d7b1c6edb%2Fdemoerrors.zip) Projektin pitäisi näyttää jotakuinkin tältä 😲:

![Kuva, joka näyttää LaTeX-projektin virheitä](/files/01e9d067b9dc7ca5b92c9c17151305e58e0b4cab)

### .aux-tiedostoista tulevat virheet

Se `.aux` tiedosto sisältää tietoja käytöstä `\label{...}` määrittelyistä ja `\cite{...}` kansioon `.tex` tiedostosta, joten nämä ovat hyödyllisiä tarkistettavia asioita.

Tarkastellaan tätä ensimmäistä virhettä esimerkin virheitä sisältävässä projektissamme.

![esimerkkivirhe .aux-tiedostossa huonon \label-määrittelyn vuoksi](/files/3035b12974244db3470ad13f5f338e1c3bde2f24)

Virhe `Missing \endcsname inserted.` kohdassa `\alpha` saattaa ensi silmäyksellä vaikuttaa varsin kryptiseltä eikä tunnu kovin hyödylliseltä vianetsinnässämme. Mutta virheilmoituksen tekstistä (kontekstista) näemme, että sitä esiintyy jossakin lähellä koodia, jossa on `sec:\alpha`, joka liittyy johonkin tunnisteeseen tai laskuriin numero 1.1. Siksi kannattaa tarkistaa huolellisesti kaikki `\label{...}` meidän `.tex` tiedostot, jotka sisältävät katkelman `sec:\alpha`.

Päädyt pian esimerkkiprojektimme riville 37:

```latex
\label{sec:\alpha}
```

Parametri, joka välitetään komennolle `\label{...}` ei saa sisältää mitään LaTeX-komentoja tai ohjaussekvenssejä, kuten `\alpha`. Siksi tunnisteen korjaaminen esimerkiksi muotoon `\label{sec:alpha}`, samoin kuin kaikki vastaavat `\ref{...}`, poistaa tämän virheen.

Tässä on toinen virhe, joka raportoidaan `.aux` tiedostosta esimerkkiprojektissamme:

![esimerkkivirhe .aux-tiedostossa välilyönnin vuoksi \cite{...}-avaimessa](/files/a8f44937609af63989aedd719a5f6647f0c69fbd)

Tällä kertaa kääntäjä valittaa välilyönnistä `\citation`; jossa avain alkaa sanalla “That”. Joten haluaisimme etsiä `\cite{That ...}` meidän `.tex` tiedostosta... ja löydämme sen riviltä 23:

```latex
... justo \cite{That mandatory talk} eget magna ...
```

Viiteavaimet eivät saa sisältää välilyöntejä, joten välilyönnit tässä `\cite{...}`, samoin kuin vastaava BIBTeX-avain `.bib` tiedostossa, pitäisi poistaa.

### .toc-tiedostoista tulevat virheet

Se `.toc` tiedosto sisältää merkintöjä `\tableofcontents`. Nämä täytetään LaTeX-asiakirjan osio-otsikoista, esim. `\chapter{...}`, `\section{...}`, jne. Siksi, jos näet virheitä, jotka raportoidaan `.toc` tiedostoista, kannattaa tarkistaa osio-otsikkosi, jotka sisältävät virheilmoituksessa mainitun tekstin.

![esimerkkivirhe .toc-tiedostossa escapeaamattoman &-merkin vuoksi \section{...}-kohdassa](/files/7ac59ab7dc5a4baee9f49300bd23eea44eb7ad90)

Tämä näyttää osio-otsikolta, jonka numero olisi “1”, ja joka sisältää tekstin `Johdanto & tervetuloa`. Pikahaku `.tex` tiedostosta vie meidät riville 12:

```latex
\section{Johdanto & tervetuloa}
```

Se `&` ei ole escapeattu tässä, joten meidän täytyy muuttaa se muotoon `\&` kansioon `.tex` tiedostossa.

Toinen samanlainen esimerkki:

![esimerkkivirhe .toc-tiedostossa matemaattisen komennon ollessa matemaattisen tilan ulkopuolella \section{...}-kohdassa](/files/9783edd28d9836ff7c94b2af091d80522d978c4e)

Samoin arvaisimme etsiä osio-otsikkoa, jonka numero olisi “1.1”, ja joka todennäköisesti sisältää `Asetus \alpha`. Arvaus osoittautuu oikeaksi, rivillä 36 `.tex` tiedosto:

```latex
\subsection{Asetus \alpha}
```

`\alpha` on matemaattinen komento, mutta unohdimme laittaa sen tähän matemaattiseen tilaan, joten tämä täytyy korjata muotoon

```latex
\subsection{Asetus $\alpha$}
```

tai

```latex
\subsection{Asetus \(\alpha\)}
```

Joskus virheet syntyvät `.toc` tiedostossa virheistä, jotka ovat koodissa, jota käytetään sisällysluettelon merkintöjen tyylittelyyn:

![esimerkkivirhe .toc-tiedostossa virheellisen koodin vuoksi sisällysluettelon merkintää tyyliteltäessä](/files/83c638f2b6f19378ab2575a4497d11c3a75cd6f9)

Tässä haku sanalla `\itshae` vie meidät kirjoitusvirheeseen esimerkkimme rivillä 5 `.tex`": sen pitäisi olla `\itshape` sen sijaan. Tässä tapauksessa virhe löytyy `.tex` tiedoston alusta, joten voimme korjata sen heti. Mutta jos käytät `.cls` tai `.sty` oppilaitoksesi tarjoamaa tiedostoa ja epäilet virheiden johtuvan toimitettujen tiedostojen virheellisestä määrityksestä, sinun kannattaa ottaa yhteyttä mallipohjan tai paketin tekijään tai ylläpitäjään, jotta he voivat päivittää mallipohjan.

### .lof- ja .lot-tiedostoista tulevat virheet

Se `.lof` tiedosto sisältää merkintöjä `\listoffigures`, ja ne täytetään `\caption{...}` kohteelle `figure` ympäristöistä.

Samoin `.lot` tiedosto käyttää `\caption{...}` tietoa `table` ympäristöistä, luodakseen merkintöjä `\listoftables`.

Siksi, jos LaTeX-virheitä tulee `.lof` tai `.lot` tiedostoista, sinun kannattaa tarkistaa `\caption{...}` joka sisältää asiaankuuluvat tekstikatkelmat.

Tämän virheilmoituksen perusteella etsimme `\alpha:n ja var_coeffin vaikutukset` meidän `\caption{...}`s, erityisesti `figure`s:

![esimerkkivirhe .lof-tiedostossa matemaattisen komennon ollessa matemaattisen tilan ulkopuolella kuvan \caption{...}-kohdassa](/files/886c0d765c229100cf7a8378d0353eff1ff16b44)

ja päädymme riville 19 `.tex` tiedosto:

```latex
\caption{\alpha:n ja var_coeffin vaikutukset}
```

Se `\alpha` pitäisi sijoittaa matemaattiseen tilaan; ja jos `var_coeff` on tarkoitettu muuttujan nimeksi, alaviiva täytyy escapeata. Älä käytä `\verb|var_coeff|` koska tämä voi olla varsin tuhoisaa myös `\caption{...}`, myös!

```latex
\caption{$\alpha$:n ja \texttt{var\_coeff}in vaikutukset}
```

Vastaavasti tämän virheen kohdalla etsimme `joitakin esimerkkitietoja, joissa on n^i` tiedostoihin `table` `\caption{...}`, epäillen, että unohdimme laittaa `n^i` myös matemaattiseen tilaan.

![esimerkkivirhe .lot-tiedostossa yläindeksin ollessa matemaattisen tilan ulkopuolella taulukon \caption{...}-kohdassa](/files/bb715f68bbf3080f3f1062d55260e62de6a9dc64)

Ja niin korjaamme rivin 31

```latex
\caption{Joitakin esimerkkitietoja, joissa on n^i}
```

kohteeseen

```latex
\caption{Joitakin esimerkkitietoja, joissa on $n^i$}
```

### .bbl-tiedostoista tulevat virheet

Se `.bbl` tiedosto sisältää lähdeluettelon (bibliografian) merkintöjä, ja sen luo BIBTeX käsiteltyään `.bib` tiedoston käyttäen tyylitietoja `.bst` tiedostosta. Raportoidut virheet `.bbl` ovat yleensä peräisin `.bib` tiedostossa.

Tässä on yleinen virhe, jota näemme usein Overleaf-tuesta:

![esimerkkivirhe .bbl-tiedostossa escapeaamattoman &-merkin vuoksi .bib-tiedostossa](/files/8aa3d607bb20a7b9fd520a8c8a5de8192525c238)

Etsimällä `Tämä & tuo` kansioon `.bib` tiedostosta esimerkkiprojektissa päädymme riville 13, jossa huomaamme, että `&` täytyy escapeata muotoon `\&` tai korvata sanalla `ja`.

```bibtex
    title   = {This & That},
```

Tekijät kohtaavat usein virheitä, jotka liittyvät Unicode-merkkeihin `.bbl` (ja siten `.bib`) -tiedostoissa — erityisesti, jos tietolähteet oli kopioitu ja liitetty jostakin muualta:

![esimerkkivirhe .bbl-tiedostossa tuetun Unicode-merkin puuttumisen vuoksi .bib-tiedostossa](/files/93a66b38ba0d056b387d52ec65f824bc1b96baa6)

Kopioimalla ♣-merkin virheilmoituksesta ja etsimällä sitä `.bib` tiedostosta päädyt riville 3:

```bibtex
    title   = {Research ♣ Development},
```

Jotkin Unicode-merkit eivät ole tuettuja `latex` ja `pdflatex` kääntäjissä. Virheen välttämiseksi voit yrittää [vaihtaa projektisi kääntäjän](/latex/fi/tietopankki/026-changing-compiler.md) kohteeseen `XeLaTeX` tai `LuaLaTeX`. Mutta silloinkin sinun pitäisi varmistaa, että projektisi on yhteensopiva niiden kääntäjien kanssa, ja että olet käyttänyt fonttia, joka sisältää glyfin ♣-merkin esittämiseen, jotta se renderöityy oikein tulostettuun PDF:ään. Siksi olisi parempi käyttää asianmukaisia LaTeX-komentoja:

```bibtex
    title   = {Research $\clubsuit$ Development},
```

Joskus merkki voi kuitenkin olla paljon vaikeampi havaita:

![esimerkkivirhe .bbl-tiedostossa tuetun, tulostumattoman Unicode-merkin vuoksi .bib-tiedostossa](/files/cf3f55c2657f6748e0289bd0ac0b11e1277bcf7c)

Tässä U+3000 on [Unicode-merkki `IDEOGRAPHIC SPACE`](https://www.fileformat.info/info/unicode/char/3000/index.htm), ja se on tosiaan välilyönti. Tämän tarkan merkin kopioiminen virheilmoituksesta voi olla vaikeaa, jotta voit etsiä sitä `.bib` tiedostosta. Joten meidän täytyy yrittää toista tapaa paikantaa se käyttämällä `\DeclareUnicodeCharacter` korvaamaan `U+3000` jollakin näkyvämmällä! Lisää seuraavat rivit projektisi aloitukseen, ennen `\begin{document}`:

```latex
\usepackage{xcolor}
\DeclareUnicodeCharacter{3000}{\textcolor{red}{BAD!!}}
```

Projektin kääntäminen saa virheen sitten katoamaan; mutta sinun kannattaa etsiä tulostetusta PDF:stä tarkasti BAD!!-tekstiä:

![tulostettu PDF, jossa U+3000 on korvattu punaisella BAD!!-tekstillä](/files/b100c62a15fcb8b236225817a2749b267059880a)

Nyt tiedämme, että huono merkki on välillä `kohteelle` ja `Wondrous`, kyseisessä “An Authorin” lähdemerkinnässä. Se näyttää varsin harmittomalta rivillä 5 `.bib` tiedostossa, koska se on näkymätön: mutta jos kirjoitat sen uudelleen `...of Wondrous...` manuaalisesti tavallisella välilyönnillä, virhe häviää uudelleenkäännöksen jälkeen.

```bibtex
    journal = {Journal of　Wondrous Musings},
```

#### Huomautus biblatexista

Jos käytät `biblatex` pakettia, niin vastaavat virheet `.bib` tiedostoissa raportoitaisiin todennäköisesti kaikki tulevan `\printbibliography` riviltä sinun `.tex` tiedostossasi. Vianetsintäprosessi on samanlainen: käytä virheilmoitusten lyhyitä tekstikatkelmia etsiäksesi `.bib` tiedostostasi ongelmalliset rivit ja korjaa ne.

### .bst-tiedostoista tulevat virheet

`.bst` tiedostot ovat bibliografiatyylejä, joita BIBTeX käyttää lähdeluettelon käsittelyyn ja muotoiluun. Jos näet virheitä `.bst` tiedostoista, syy voi olla virheissä `.bst` itsessään, varsinkin jos se on hyvin, hyvin vanha tyylitiedosto, joka ei ehkä enää ole yhteensopiva uusien LaTeX-pakettien kanssa. Mutta syynä voivat olla myös virheet `.bib` tiedostossa. Tämän kategorian yleisin virhe näyttää tältä:

![Bst-error-example-01.png](/files/c45aa9012ea8ba7ebd6bf82f76811204f362c69b)

Merkintä BIBTeX-avaimella `Someone:etal:2008` sisältää `tekijä` kentän rivillä 12 `.bib` tiedosto:

```bibtex
    author  = {Strange Someone, Night Stranger, and Random Person},
```

Tiedosto `.bib` , [usean nimen luettelo](/latex/fi/viitteet-ja-sitaatit/01-bibliography-management-with-bibtex.md#multiple-authors) pitäisi erottaa `ja`, ei pilkuilla eikä `&`. Siksi tämä `tekijä` kenttä pitäisi korjata muotoon

```bibtex
    author  = {Strange Someone and Night Stranger and Random Person},
```

### .ttt- ja .fff-tiedostoista tulevat virheet

Nämä tiedostotyypit luodaan vain, jos lataat [`endfloat` paketti](https://www.ctan.org/pkg/endfloat)paketin, jota käytetään pakottamaan kaikki taulukko- ja kuva-ympäristöt siirrettäviksi asiakirjan loppuun joidenkin tieteellisten lehtien vaatimusten mukaisesti artikkelin lähetyksen yhteydessä.

Jos haluat nähdä esimerkkivirheitä näistä luoduista tiedostoista, poista rivin 3 kommentointi `\usepackage{endfloat}` sisällä `.tex` esimerkkiprojektimme tiedostosta.

![Ttt-error-example-01.png](/files/52dc195fe9ef549a091b23c549a768953606da41)

Se `.ttt` tiedosto sisältää sisältöä kaikista `table` asiakirjan ympäristöistä, joten etsimme `dummy & data` kansioon `.tex` tiedostosta kiinnittäen huomiota taulukoihin. Päätyisimme riville 29 `.tex` tiedostossa, jossa näemme ongelman: meillä on kolme saraketta, yksi enemmän kuin ilmoitettu kaksi. Joten yksi ylimääräinen sarake saattaa olla poistettava; tai meidän pitäisi lisätä `\\` jälkeen `dummy` aloittaaksemme uuden rivin; tai ehkä olimme aikoneet määritellä kolme saraketta `c | c | c` lopulta!

![Fff-error-example-01.png](/files/6a4c9b8cc6c7658820496a1539cd598edbb6993b)

Samoin `.fff` tiedosto sisältää sisältöä kaikista `figure` ympäristöistä, ja etsimällä tuon kirjoitusvirheellisen `\includegraphcs` pääsemme riville 18 `.tex` tiedostossa, jossa voimme korjata sen muotoon `\includegraphics`.

## Lisälukemista

* [Miten Overleaf kääntää projektini?](/latex/fi/tietopankki/064-how-does-overleaf-compile-my-project.md)
* [Yleiset LaTeX-virheet](/latex/fi/latexin-perusteet/05-errors.md)
* [TeX FAQ -luettelosta](https://texfaq.org/#errors)


---

# 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://overleaf-pro.ayaka.space/latex/fi/tietopankki/066-how-to-find-and-fix-errors-reported-in-generated-files.md?ask=<question>&goal=<endgoal>
```

`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.
