Hjälpindex
Bäddar in hjälpcentrets sidor på nytt så att assistenten i appen kan hitta dem.
Så fungerar det
Assistenten i appen använder vektorsökning över en uppstyckad, inbäddad kopia av hjälpcentret för att besvara frågor. Det här jobbet bygger om (eller uppdaterar stegvis) det indexet:
- Styckar upp sidorna per rubrik
- Beräknar inbäddningar för stycken vars innehåll har ändrats sedan den senaste körningen
- Skriver dem till den globala tabellen
help_chunks - Raderar föräldralösa stycken — stycken vars källsida inte längre finns i indata tas bort vid körning i “full”-läge
Jobbet har två lägen:
- Inkrementellt — drivs av CI/CD efter en publicering av hjälpcentret. Indata listar de ändrade sidorna och deras inbäddade markdown-innehåll
- Full omindexering — går igenom den lokala katalogen
content(standard är/help/content). Används vid uppstart av en ny driftsättning eller för att återhämta sig från ett korrupt index
Hjälpindexet är globalt, inte per arbetsyta. Jobbet är låst till systemarbetsytan och vägrar köra någon annanstans.
När jobbet körs
Jobbet är operatörsstyrt — det finns ingen schemalagd utlösare. CI/CD anropar det efter varje driftsättning av hjälpcentret; du kan också starta det manuellt.
Parametrar
| Parameter | Beskrivning |
|---|---|
| Content Dir | Sökväg till en lokal Hugo-innehållskatalog. Används i läget för full omindexering. Standard är /help/content |
| Pages | En lista med sidsökvägar och inbäddat markdown-innehåll. Används i det inkrementella läget |
| Deleted Paths | En lista med sidsökvägar som ska tas bort från indexet |
| Full | När den anges tillsammans med Pages aktiveras rensning av föräldralösa stycken — varje stycke vars källsökväg inte finns i den angivna siduppsättningen raderas. Använd bara när Pages innehåller hela innehållsuppsättningen |
Jobbet hoppas över med skipped: true, reason: "embedder not configured" när driftsättningen inte har någon inbäddningsleverantör konfigurerad.
Jobbresultat
| Mätvärde | Beskrivning |
|---|---|
files_processed | Antal genomgångna sidor |
chunks_created | Nya styckesrader som lades in |
chunks_updated | Befintliga styckesrader vars inbäddning uppdaterades |
chunks_deleted | Föräldralösa styckesrader som togs bort |
chunks_skipped | Stycken vars innehållshash matchade den befintliga raden (inget inbäddningsanrop behövdes) |
languages | Uppsättningen språk som påträffades |
Felsökning
| Problem | Lösning |
|---|---|
Hoppas över med embedder not configured | Driftsättningen har ingen inbäddningsleverantör. Konfigurera en, eller acceptera att assistentens sökning faller tillbaka på nyckelordssökning |
| Körningen misslyckas med behörighetsfel | Kontrollera att API-nyckeln för den konfigurerade inbäddningsleverantören fortfarande är giltig |
| Assistenten ger fortfarande inaktuella svar | Gör en hård uppdatering av assistentsessionen. Vektorlagret läses färskt vid varje fråga, men assistenten kan ha cachelagrat nyliga svar |