Typemark Documentation

Búsqueda con IA

Permite que los lectores hagan preguntas en lenguaje natural y reciban respuestas extraídas de tu documentación, con enlaces a las páginas en las que se basan.

Actualizado el 19 nov 20263 min de lectura

La búsqueda con IA añade Ask AI a tu sitio: un chat junto a tu documentación. Los lectores hacen una pregunta, Typemark responde a partir de tu documentación publicada y enumera las páginas que ha usado, y pueden seguir haciendo preguntas de seguimiento. Está disponible en los planes Pro y Enterprise.

Activarla

Ve a Settings > Reader features y activa AI search. La búsqueda también tiene que estar activada: si no lo está, los lectores no ven Ask AI.

En typemark.json:

"features": {
  "search": true,
  "ai_search": true
}

Cuenta el plan del propietario del proyecto, así que todo el equipo obtiene el mismo sitio. En el plan Free, el interruptor muestra una insignia Pro y los lectores no ven Ask AI.

Lo que ven los lectores

Ask AI en el encabezado del sitio abre un panel de chat acoplado a la derecha de la página. En los teléfonos ocupa toda la pantalla.

  • La respuesta aparece en tiempo real, con una lista Sources debajo con las páginas en las que se basó. Cada fuente enlaza a su página, al igual que los títulos de página citados en la respuesta.
  • Los lectores pueden hacer preguntas de seguimiento, como "¿y en Windows?". Typemark recuerda las últimas preguntas y respuestas.
  • Stop detiene una respuesta que todavía se está generando. New chat empieza de nuevo.
  • Abrir una página citada conserva la conversación, así que los lectores pueden leer la página y seguir preguntando.
  • Esc o el botón de cerrar cierra el panel.

Los lectores también pueden empezar desde la búsqueda. En el cuadro de búsqueda, la fila Ask AI de la parte inferior pasa a the panel lo que hayan escrito. Cmd+Enter (Ctrl+Enter en Windows) hace lo mismo desde cualquier parte del cuadro. En los teléfonos, así es como los lectores abren Ask AI.

Las preguntas pueden tener entre dos y 500 caracteres. En un sitio en varios idiomas, Ask AI responde en el idioma predeterminado. Las vistas previas de despliegue no tienen Ask AI.

Cómo se generan las respuestas

  1. Encontrar las páginas

    Typemark procesa la pregunta con la búsqueda de texto completo de tu sitio y toma las cinco páginas con mejor coincidencia. En el caso de un seguimiento, las complementa con páginas que coincidieron con las preguntas anteriores.

  2. Responder solo a partir de esas páginas

    El modelo recibe el texto de esas páginas y se le indica que responda únicamente con ellas, que cite las páginas por su título y que lo indique cuando la respuesta no esté ahí.

  3. Mostrar las fuentes

    Las páginas coincidentes se muestran como fuentes antes de que empiece la respuesta, para que los lectores tengan a dónde ir aunque la respuesta no sea completa.

Las respuestas usan tu contenido publicado. En el modo de despliegue manual, las ediciones no publicadas no se usan.

Si ninguna página coincide, se pide a los lectores que reformulen la pregunta en lugar de dar una respuesta.

Privacidad

Las preguntas y el texto de las páginas se envían al modelo de IA a través de OpenRouter. Typemark solo las encamina a proveedores de modelos que no almacenan los prompts ni los usan para entrenar.

Límites

LímiteQué ocurre
10 preguntas por minuto por lectorLas preguntas adicionales reciben un mensaje de "inténtalo de nuevo en un minuto".
300 respuestas de IA por sitio al díaLos lectores siguen recibiendo las páginas coincidentes, con una nota de que las respuestas de IA están pausadas por hoy. Las respuestas se reanudan al día siguiente.
500 respuestas de IA al día en todos los sitios de un propietarioLo mismo, en cada uno de los sitios de ese propietario. Las respuestas se reanudan al día siguiente.
30 segundos por respuestaSe pide a los lectores que prueben con una pregunta más sencilla.

Consejos para mejorar las respuestas

  • Da a cada página un title y una description claros. Ambos se buscan y ayudan a que las páginas correctas aparezcan primero.
  • Usa las palabras que usan tus lectores. La búsqueda busca coincidencias de palabras, así que una página sobre "claves de API" no aparecerá para "tokens de acceso" a menos que lo diga.
  • Mantén las páginas centradas. Cada página fuente aporta una cantidad limitada de texto, así que un tema por página funciona mejor que una página larga.