Migration de la version 3 vers la version 4

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Ce guide détaille la migration de DocSearch v3 vers DocSearch v4, en mettant en lumière les différences clés et les nouvelles options de configuration. Pour une vue d'ensemble complète, consultez la référence API et le Guide de démarrage.

Si vous utilisez uniquement la recherche par mots-clés Algolia

Si votre application utilise uniquement la fonctionnalité de recherche par mots-clés d'Algolia, aucune étape de migration n'est nécessaire. DocSearch v4 préserve une compatibilité ascendante totale pour les opérations de recherche par mots-clés.

Traductions

Nous avons actualisé certaines clés de traduction pour clarifier leur objectif :

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

Retrouvez la liste complète des traductions dans la documentation API

Intégration d'Ask AI avec DocSearch v4

Intégration basique

DocSearch v4 introduit un support natif pour la fonctionnalité Ask AI d'Algolia. Pour activer la recherche pilotée par l'IA, ajoutez le paramètre askAi avec votre ID d'assistant Algolia à votre configuration DocSearch existante :

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

Remplacez YOUR_ALGOLIA_ASSISTANT_ID par l'ID fourni dans votre tableau de bord Algolia, section Ask AI.

Intégration avancée (avec un index séparé)

Si vous préférez utiliser Ask AI avec une configuration distincte de votre installation DocSearch principale (par exemple avec des identifiants API ou un index différent), fournissez un objet au paramètre 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',
  },
});

Vérifiez que chaque champ (indexName, apiKey, appId et assistantId) au sein de l'objet askAi est correctement configuré pour l'index et l'assistant Algolia que vous souhaitez utiliser.

Fonctionnalités de la v4 avec Ask AI

• Support BYO-LLM (Apportez votre propre LLM) : Intégrez des modèles d'IA personnalisés en fournissant vos propres clés et configurations LLM.

• Sécurité renforcée : Jetons à durée de vie limitée et vérification de domaine réduisent les accès non autorisés.

• Analytiques et traitement des retours améliorés : Métriques robustes pour surveiller l'utilisation et les performances de vos assistants.

Stylisation

Nous avons actualisé la plupart des classes CSS. Cette nouvelle version ne devrait pas perturber votre style existant, mais davantage de styles et classes ont été introduits, nécessitant probablement une nouvelle personnalisation.

Chemin de migration et compatibilité

DocSearch v4 offre un chemin de migration clair :

• Mettez à jour votre configuration DocSearch avec les nouveaux paramètres askAi selon vos besoins.

• Vérifiez la liste blanche des domaines et les paramètres d'assistant via votre tableau de bord Algolia.

• Examinez périodiquement votre contenu indexé et vos analytiques pour optimiser les réponses et performances d'Ask AI.

Pour les détails complets sur la sécurité des endpoints, les stratégies de cache et l'infrastructure, consultez la documentation dédiée Sécurité et Infrastructure.

Support et ressources

• Documentation Ask AI : Maîtrisez Ask AI d'Algolia (Documentation).

• DocSearch Playground : Environnement interactif pour tester les configurations DocSearch (Docsearch Playground).

• Communauté & Support : Contactez-nous via le Discord Algolia.

Suivre ce guide garantit une transition fluide vers DocSearch v4, débloquant toutes les capacités des fonctionnalités de recherche IA d'Algolia.