跳至主内容
版本：稳定版 (v4.x)

从 v3 迁移到 v4

非官方测试版翻译

本页面由 PageTurner AI 翻译（测试版）。未经项目官方认可。 发现错误？ 报告问题 →

本指南详细介绍了如何从 DocSearch v3 迁移至 DocSearch v4，重点说明关键差异和新增配置选项。完整功能概览请参阅 API 参考文档 和 入门指南。

仅使用 Algolia 关键词搜索的场景​

若您的应用仅使用 Algolia 关键词搜索功能，则无需任何迁移操作。DocSearch v4 完全兼容关键词搜索的现有功能。

多语言翻译​

我们优化了部分翻译键名使其功能更明确：

InterfaceOld keyNew key
SearchBoxTranslationsresetButtonTitleclearButtonTitle
SearchBoxTranslationsresetButtonAriaLabelclearButtonAriaLabel
SearchBoxTranslationscancelButtonTextcloseButtonText
SearchBoxTranslationscancelButtonAriaLabelcloseButtonAriaLabel
FooterTranslationssearchByTextpoweredByText

完整翻译列表请查看 API 文档

在 DocSearch v4 中集成 Ask AI​

基础集成​

DocSearch v4 无缝支持 Algolia 的 Ask AI 功能。要启用 AI 驱动的搜索，请在现有 DocSearch 配置中添加 askAi 参数并填入您的 Algolia 助手 ID：

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

将 YOUR_ALGOLIA_ASSISTANT_ID 替换为 Algolia 控制台 Ask AI 板块提供的实际 ID。

高级集成（使用独立索引）​

若需为 Ask AI 配置独立于主 DocSearch 的设置（例如使用不同的 API 凭证或索引），可通过向 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',
  },
});

请确保 askAi 对象内的每个字段（indexName、apiKey、appId 和 assistantId）均针对目标 Algolia 索引和助手正确配置。

v4 中结合 Ask AI 的功能特性​

  • BYO-LLM（自带大语言模型）支持：可通过提供自有 LLM 密钥和配置集成定制 AI 模型

  • 安全性增强：短期令牌和域名验证机制有效提升安全性，减少未授权访问

  • 强化分析与反馈处理：强大的分析功能助您监控助手使用情况和性能表现

样式调整​

我们更新了大部分 CSS 类名。新版不会破坏现有样式，但由于引入更多样式和类，可能需要重新定制样式。

迁移路径与兼容性​

DocSearch v4 提供清晰的迁移路径：

  • 按需更新 DocSearch 配置中的 askAi 设置

  • 通过 Algolia 控制台正确配置域名白名单和助手设置

  • 定期检查索引内容和分析数据，持续优化 Ask AI 的响应质量与性能表现

关于端点安全、缓存策略和基础设施的完整说明，请参阅专项 安全与基础设施文档。

支持与资源​

  • Ask AI 文档：全面掌握 Algolia Ask AI 功能（文档链接）

  • DocSearch 演练场：测试配置的交互式环境（演练场）

  • 社区与支持：通过 Algolia Discord 联系我们

遵循本指南可确保平稳升级至 DocSearch v4，充分释放 Algolia 强大 AI 搜索能力的全部潜能。