> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Tekoälyintegraatio

> Määritä tekoälychat, LaTeX-virheehdotukset, käyttäjien käyttöoikeudet, kiintiöt ja valinnaiset hakupalvelut.

<Info>
  Tämän ominaisuuden tarjoaa [ayaka-notes/ayakaleaf-pro](https://github.com/ayaka-notes/ayakaleaf-pro), ja se on saatavilla versiosta v6.3.0 alkaen. Otamme mielellämme vastaan palautetta, jos kohtaat ongelmia.
</Info>

## Tekoälyavustaja ja LaTeX-virheavustaja

Ayakaleaf Pro tuo tekoälyominaisuudet editoriin kahdella tavalla.

* Tekoälyavustaja voi käyttää projektisi dokumentteja ja nykyistä valintaa kontekstina vastatessaan kysymyksiin ja ehdottaessaan muokkauksia, jotka voit tarkistaa.
* Virheavustaja ehdottaa kohdennettua korjausta, kun valitset LaTeX-käännösvirheen.

<Frame>
  <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-48.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=107b27f8843a326269b5e3711ccf2616" alt="" width="2844" height="1710" data-path="images/on-premises/image-48.png" />
</Frame>

### Toolkit-määritys

Lisää seuraavat rivit Toolkit-käyttöönottosi `config/variables.env`-tiedostoon ja korvaa esimerkin URL, avain ja malli palveluntarjoajasi arvoilla:

```dotenv theme={null}
AI_ENABLED=true
AI_BASE_URL=https://ai-gateway.example.com/v1
AI_API_KEY=REPLACE_WITH_YOUR_GATEWAY_API_KEY
AI_MODEL=YOUR_TEXT_MODEL_ID
```

Säilytä oikeat API-avaimet käyttöönoton ympäristötiedostossa äläkä vie niitä versionhallintaan. Yllä olevat arvot ovat paikkamerkkejä, eivät toimivia tunnuksia.

<Info>
  Tekoälyehdotusten laatu riippuu valitsemastasi mallista. Jos sinulla on jo Codex- tai ChatGPT-tilaus, voit yhdistää sen [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI):n OpenAI-yhteensopivan päätepisteen kautta.
</Info>

`AI_BASE_URL` on OpenAI-yhteensopivan API:n perus-URL, joka sisältää tarvittaessa palveluntarjoajan versioetuliitteen. Älä lisää loppuun `/chat/completions`, koska lisäämme sen sisäisesti. Yhdyskäytävän ja mallin on tuettava suoratoistettavia chat completion -vastauksia ja funktiotyökaluja. Molemmat ominaisuudet lähettävät dokumenttikontekstia tälle yhdyskäytävälle; chat voi lähettää myös ladattuja kuvia, kun käytetään kuvia tukevaa mallia.

Toolkit välittää `config/variables.env`-tiedoston sovelluskonttiin. Käytä tässä esitettyjä muuttujien nimiä; älä lisää `OVERLEAF_`-etuliitettä. Luo sovelluskontti uudelleen Toolkit-hakemistosta näiden muuttujien muuttamisen jälkeen:

```sh theme={null}
bin/up -d
```

### Yhdyskäytävän asetukset

| Muuttuja | Oletus | Tarkoitus |
| - | - | - |
| `AI_ENABLED` | `false` | Aseta täsmälleen arvoon `true` ottaaksesi chatin ja virheehdotukset käyttöön instanssissa. Jos arvoa ei ole asetettu tai se on jokin muu, ne pysyvät pois käytöstä. Lisäksi tarvitaan toimiva yhdyskäytävämääritys. |
| `AI_BASE_URL` | Ei mitään; pakollinen | OpenAI-yhteensopivan API:n perus-URL. |
| `AI_API_KEY` | Ei mitään; pakollinen | Kyseisen yhdyskäytävän API-avain, jota palvelin käyttää. |
| `AI_MODEL` | Ei mitään; pakollinen | Tekstimalli, jota oletusarvoinen chat-määritys ja LaTeX-virheehdotukset käyttävät. |
| `AI_IMAGE_MODEL` | Ei asetettu | Valinnainen kuvia tukeva malli samassa yhdyskäytävässä samalla API-avaimella. |
| `AI_MAX_STEPS` | `20` | Työkalukutsujen enimmäismäärä käyttäjän viestiä kohden tekoälychatissa, automaattiset jatkot mukaan lukien. Käytä positiivista kokonaislukua. |
| `AI_PROXY_URL` | Ei asetettu | Valinnainen HTTP-välityspalvelimen URL tekoälyyhdyskäytävän kutsuille. Se ei määritä verkko- tai dokumentaatiohaun asiakkaita. |
| `AI_TOKEN_QUOTA` | `0` | Käyttäjäkohtainen token-raja jaksoa kohden, yhteinen chatille ja virheehdotuksille. Asettamaton tai `0` tarkoittaa rajatonta; käytä rajalle positiivista kokonaislukua. |
| `AI_TOKEN_QUOTA_PERIOD` | `month` | `month` nollautuu kuukauden ensimmäisenä päivänä klo 00:00 UTC; `week` nollautuu maanantaina klo 00:00 UTC. Muut arvot käyttävät `month`-asetusta. |

Kuvien lataamista varten aseta `AI_IMAGE_MODEL` malliin, joka hyväksyy kuvasyötteen ja tukee chatin käyttämiä työkaluja. Jokainen chat-pyyntö, jonka historiassa on kuvaliite, käyttää tätä mallia, myös saman keskustelun myöhemmät viestit. Ilman tätä asetusta kuvapyynnöt käyttävät tavallista chat-mallia, jonka on itse tuettava kuvia. LaTeX-virheehdotukset käyttävät edelleen `AI_MODEL`-mallia.

Esimerkiksi kuvamallin ja viikoittaisen tekoälykiintiön käyttöönotto:

```dotenv theme={null}
AI_IMAGE_MODEL=YOUR_IMAGE_CAPABLE_MODEL_ID
AI_TOKEN_QUOTA=100000
AI_TOKEN_QUOTA_PERIOD=week
```

### Käyttäjien käyttöoikeudet ja suostumus

Instanssin saatavuus ja käyttäjän käyttöoikeus ovat erillisiä asioita. `AI_ENABLED` ja yhdyskäytävämääritys ohjaavat instanssin saatavuutta. Kirjautuneen käyttäjän on lisäksi läpäistävä olemassa olevat tilitarkistukset:

* `aiFeatures.enabled` ei saa olla `false`. Tämä olemassa oleva tietokantakenttä ohjaa sekä chattia että LaTeX-virheehdotuksia.
* Käyttäjän voimassa olevan `features.aiUsageQuota`-arvon on vastattava määritettyä rajatonta tasoa (oletuksena `unlimited`), tai olemassa olevan vanhan `features.aiErrorAssistant`-oikeuden on oltava käytössä. Voimassa oleviin ominaisuuksiin sisältyvät sovellettavat tilikohtaiset ominaisuusohitukset.

Pelkkä valintaruudun valitseminen ei muuta käyttäjän tilausta. `aiUsageQuota`-kenttä on oikeustaso, ei numeerinen token-kiintiö. `AI_TOKEN_QUOTA` on erillinen raja, jota sovelletaan tasapuolisesti jokaiseen oikeutettuun käyttäjään; nykyinen moduuli ei tarjoa tilikohtaista numeerista rajaa.

Valitse ylläpidon käyttäjäluettelosta käyttäjä ja avaa **Update account info → AI features**. **Enable AI features** päivittää `aiFeatures.enabled`-kentän, kun tilimuutokset tallennetaan. Palvelin tarkistaa nykyiset oikeudet uusien tekoälypyyntöjen yhteydessä, myös jo avoinna olevasta editorista tulevissa pyynnöissä. Päivitä editori, jotta sen näkyvät säätimet päivittyvät oikeuksien muutoksen jälkeen.

### Käyttö ja nollaus

Ylläpidon AI features -välilehti näyttää nykyisen jakson **Usage**-, **Limit**- ja **Reset**-painikkeen yhdellä rivillä. Käyttö luetaan, kun välilehti avataan; sitä ei päivitetä jatkuvasti. Avaa välilehti uudelleen chatin tai virheehdotuksen valmistuttua nähdäksesi viimeisimmän määrän. Nollaus tulee voimaan välittömästi ja tyhjentää vain kyseisen käyttäjän nykyisen jakson laskurin, minkä jälkeen näytetty käyttö ladataan uudelleen. Se ei edellytä muun tililomakkeen tallentamista.

<Frame>
  <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/img-2f5a5399.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=3c52c12aa1551cda22f218ec2dfda63b" alt="" width="563" data-path="images/on-premises/img-2f5a5399.png" />
</Frame>

Chat ja virheehdotukset jakavat yhden Redis-laskurin, joka päivitetään mallin tarjoajan ilmoittamalla tokenien kokonaismäärällä pyynnön valmistuttua. Tähän sisältyvät syöte- ja tulostetokenit kaikista mallin vaiheista. Syöte voi sisältää keskusteluhistorian, dokumenttikontekstin ja työkalujen tulokset, joten jatkokysymys voi kuluttaa enemmän tokeneita kuin pelkkä uusi viesti. Käyttö kirjataan, vaikka raja olisi **Unlimited**. Pyynnöt, joille ei ilmoiteta tokenien kokonaismäärää, eivät kasvata laskuria; moduuli ei pysty jälkikäteen rekonstruoimaan kirjaamatonta historiallista käyttöä.

Kiintiötarkistukset tehdään ennen suoratoistoa. Yksi pyyntö tai useampi samanaikainen pyyntö voi ylittää jäljellä olevan kiintiön ennen kuin myöhemmät pyynnöt estetään. Kyseessä on käyttökiintiö eikä palveluntarjoajan tiukka kulukatto. Jos kiintiön haku epäonnistuu, pyyntö sallitaan ja virhe kirjataan lokiin.

Molemmat ominaisuudet käyttävät `AI_TOKEN_QUOTA`-arvoa; virheehdotuksilla ei ole erillistä pyyntömäärärajaa. Laskurin nollaaminen ei muuta käyttöoikeutta, suostumusta, määritettyä rajaa tai palveluntarjoajan omia laskutustietoja. Laskurit käyttävät UTC-jaksoavaimia ja vanhenevat 40 päivän kuluttua; Redis-datan säilyttäminen säilyttää nykyisen käytön sovelluksen uudelleenkäynnistysten yli.

### Valinnaiset hakupalvelut

Verkkohaku käyttää Tavily-yhteensopivaa API:a. Se on käytettävissä, kun haun API-avain on määritetty. Nämä asetukset ovat riippumattomia tekoälyyhdyskäytävästä:

| Muuttuja | Oletus | Tarkoitus |
| - | - | - |
| `TAVILY_API_KEY` | Ei asetettu | Haun API-avain. Menee `WEB_SEARCH_API_KEY`-arvon edelle. |
| `WEB_SEARCH_API_KEY` | Ei asetettu | Vaihtoehtoinen nimi haun API-avaimelle. |
| `WEB_SEARCH_URL` | `https://api.tavily.com/search` | Haun päätepiste; mukautettujen päätepisteiden on hyväksyttävä Tavilyn pyyntö- ja vastausmuoto. |
| `WEB_SEARCH_MAX_RESULTS` | `5` | Hakua kohden pyydettyjen tulosten määrä; käytä palvelun tukemaa positiivista kokonaislukua. |
| `WEB_SEARCH_DEPTH` | `basic` | Haun syvyys, tavallisesti `basic` tai `advanced`. |
| `WEB_SEARCH_PROVIDER` | `tavily` | Nykyinen toteutus tukee vain Tavily-yhteensopivaa protokollaa; tämän arvon muuttaminen ei valitse toista sovitinta. |
| `DOCS_MCP_URL` | `https://docs.overleaf.com/~gitbook/mcp` | Dokumentaatiohaun päätepiste. Aseta tyhjäksi merkkijonoksi poistaaksesi dokumentaatiohaun käytöstä. |

Esimerkiksi:

```dotenv theme={null}
TAVILY_API_KEY=REPLACE_WITH_YOUR_SEARCH_API_KEY
WEB_SEARCH_MAX_RESULTS=5
WEB_SEARCH_DEPTH=basic
DOCS_MCP_URL=https://docs.overleaf.com/~gitbook/mcp
```

Dokumentaatiohaku kutsuu määritetyn GitBook MCP -päätepisteen `searchDocumentation`-työkalua ja hyväksyy JSON- tai SSE-vastaukset. Kyseessä on MCP-asiakas dokumentaatiohakua varten; nämä moduulit eivät tarjoa projektitiedostoja MCP-palvelimena eivätkä tarjoa yleiskäyttöistä MCP-palvelinrekisteriä.

Hakukyselyt lähetetään määritettyyn hakupalveluun. Hakutuloksia voidaan sitten sisällyttää tekoälyyhdyskäytävälle lähetettäviin pyyntöihin. Chatin **Tools**-valikosta käyttäjät voivat ottaa **Web**- ja **Documentation**-työkalut käyttöön tai poistaa ne käytöstä pyynnöissään; työkalu on myös määritettävä palvelimella, jotta se on mallin käytettävissä.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.