Saltar al contenido

Índice de ayuda

Vuelve a indexar las páginas del Centro de ayuda para que el asistente de la app pueda encontrarlas.

Cómo funciona

El asistente de la app responde a las preguntas buscando en un índice del Centro de ayuda, en el que cada página se divide en secciones y se guarda de forma que se pueda buscar por significado. Esta tarea reconstruye (o actualiza) ese índice:

  1. Divide las páginas en secciones según los encabezados
  2. Indexa las secciones cuyo contenido ha cambiado desde la última ejecución
  3. Las guarda en el índice de ayuda compartido
  4. Quita los restos: las secciones cuya página ya no existe se eliminan cuando se ejecuta en modo «completo»

La tarea tiene dos modos:

  • Incremental: se ejecuta automáticamente tras publicar el Centro de ayuda. Recibe las páginas modificadas y su contenido
  • Reindexación completa: lee todas las páginas de la carpeta de contenido del Centro de ayuda (por defecto /help/content). Se usa en una instalación nueva o para recuperar un índice dañado

El índice de ayuda abarca todo mTime, no un solo espacio de trabajo. La tarea solo se puede ejecutar desde el espacio de trabajo del sistema y no aparece en ningún otro espacio de trabajo.

Cuándo se ejecuta

La tarea la lanza un operador: no hay programación. Se ejecuta automáticamente tras cada publicación del Centro de ayuda; también se puede lanzar manualmente.

Parámetros

El formulario de lanzamiento no muestra campos para esta tarea; las opciones se pasan a través de la API:

OpciónDescripción
content_dirRuta a la carpeta de contenido del Centro de ayuda. La usa la reindexación completa. Por defecto, /help/content
pagesUna lista de rutas de páginas con su contenido. La usa el modo incremental
deleted_pathsUna lista de rutas de páginas que se deben quitar del índice
fullJunto con pages, quita todas las secciones cuya página no está en la lista. Úsalo solo cuando pages contiene todas las páginas

La tarea se omite con skipped: true, reason: "embedder not configured" cuando la instalación no tiene configurado ningún servicio de indexación de búsqueda.

Resultados de la tarea

MétricaDescripción
files_processedNúmero de páginas leídas
chunks_createdSecciones nuevas añadidas
chunks_updatedSecciones existentes que se volvieron a indexar
chunks_deletedSecciones sobrantes eliminadas
chunks_skippedSecciones que no habían cambiado (nada que indexar)
languagesConjunto de idiomas encontrados

Solución de problemas

ProblemaSolución
Omisión por embedder not configuredLa instalación no tiene servicio de indexación de búsqueda. Configura uno o acepta que el asistente recurra a la búsqueda por palabras clave
La ejecución falla con un error de permisosComprueba que la clave de API del servicio de indexación de búsqueda sigue siendo válida
El asistente sigue dando respuestas desfasadasInicia una nueva sesión del asistente. El índice se lee de nuevo en cada pregunta, pero el asistente puede recordar respuestas anteriores