Migración de v3 a v4

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Esta guía proporciona información detallada para migrar de DocSearch v3 a DocSearch v4, destacando diferencias clave y nuevas opciones de configuración. Para una visión general completa, consulta la referencia de API y la Guía de inicio.

Si solo usas búsqueda por palabras clave de Algolia

Si tu aplicación utiliza únicamente la funcionalidad de búsqueda por palabras clave de Algolia, no se requieren pasos de migración. DocSearch v4 mantiene compatibilidad total con operaciones de búsqueda por palabras clave.

Traducciones

Actualizamos algunas claves de traducción para clarificar su propósito:

Interface	Old key	New key
SearchBoxTranslations	resetButtonTitle	clearButtonTitle
SearchBoxTranslations	resetButtonAriaLabel	clearButtonAriaLabel
SearchBoxTranslations	cancelButtonText	closeButtonText
SearchBoxTranslations	cancelButtonAriaLabel	closeButtonAriaLabel
FooterTranslations	searchByText	poweredByText

Encuentra la lista completa de traducciones en la documentación de API

Integración de Ask AI con DocSearch v4

Integración básica

DocSearch v4 introduce soporte nativo para la función Ask AI de Algolia. Para habilitar la búsqueda con IA, añade el parámetro askAi con tu ID de Asistente de Algolia a tu configuración existente de DocSearch:

docsearch({
  indexName: 'YOUR_INDEX_NAME',
  apiKey: 'YOUR_SEARCH_API_KEY',
  appId: 'YOUR_APP_ID',
  askAi: 'YOUR_ALGOLIA_ASSISTANT_ID',
});

Reemplaza YOUR_ALGOLIA_ASSISTANT_ID con el ID proporcionado en tu Panel de Algolia dentro de la sección Ask AI.

Integración avanzada (usando índice separado)

Si prefieres utilizar Ask AI con una configuración separada de tu instalación principal de DocSearch (por ejemplo, usando credenciales de API o índice diferentes), puedes hacerlo proporcionando un objeto al parámetro askAi:

docsearch({
  indexName: 'YOUR_INDEX_NAME',
  apiKey: 'YOUR_SEARCH_API_KEY',
  appId: 'YOUR_APP_ID',
  askAi: {
    indexName: 'ANOTHER_INDEX_NAME',
    apiKey: 'ANOTHER_SEARCH_API_KEY',
    appId: 'ANOTHER_APP_ID',
    assistantId: 'YOUR_ALGOLIA_ASSISTANT_ID',
  },
});

Asegúrate que cada campo (indexName, apiKey, appId, y assistantId) dentro del objeto askAi esté configurado correctamente para el índice y asistente de Algolia que deseas usar.

Características en v4 con Ask AI

• Soporte BYO-LLM (Bring Your Own LLM): Puedes integrar modelos de IA personalizados proporcionando tus propias claves y configuraciones de LLM.

• Seguridad mejorada: Tokens de corta duración y verificación de dominio mejoran la seguridad, reduciendo accesos no autorizados.

• Análisis y procesamiento de feedback mejorados: Estadísticas robustas para monitorear uso y rendimiento de tus asistentes.

Estilos

Actualizamos la mayoría de clases CSS. La nueva versión no debería afectar tus estilos actuales, pero se introdujeron más estilos y clases en esta versión, por lo que probablemente debas personalizarlos nuevamente.

Ruta de migración y compatibilidad

DocSearch v4 ofrece una ruta de migración clara:

• Actualiza tu configuración de DocSearch con los nuevos ajustes askAi según sea necesario.

• Verifica que la lista blanca de dominios y configuraciones de asistente estén correctamente configuradas en tu Panel de Algolia.

• Revisa periódicamente tu contenido indexado y análisis para optimizar respuestas y rendimiento de Ask AI.

Para detalles completos sobre seguridad de endpoints, estrategias de caché e infraestructura, consulta la documentación dedicada de Seguridad e Infraestructura.

Soporte y recursos

• Documentación de Ask AI: Aprende todo sobre Algolia Ask AI (Documentación).

• DocSearch Playground: Entorno interactivo para probar configuraciones de DocSearch (Docsearch Playground).

• Comunidad y soporte: Contáctanos a través de Algolia Discord.

Seguir esta guía garantiza una transición fluida a DocSearch v4, desbloqueando todo el potencial de las funciones de búsqueda con IA de Algolia.