v3からv4への移行
このページは PageTurner AI で翻訳されました(ベータ版)。プロジェクト公式の承認はありません。 エラーを見つけましたか? 問題を報告 →
このガイドでは、DocSearch v3からDocSearch v4への移行に関する詳細情報を提供し、主な相違点や新たな設定オプションを解説します。包括的な概要については、APIリファレンスとスタートガイドを参照してください。
Docusaurusを利用する場合
現在のDocusaurusバージョンで最新のDocSearch統合を利用するには、@docsearch/docusaurus-adapterを使用してください。
これは、Docusaurusの組み込み検索統合の変更を待たずに、新しいDocSearch機能(例:Ask AIサイドパネルのサポート)が必要な場合に推奨される方法です。
Algoliaキーワード検索のみを利用する場合
アプリケーションがAlgoliaのキーワード検索機能のみを利用している場合、移行作業は不要です。DocSearch v4はキーワード検索操作に対して完全な下位互換性を維持しています。
翻訳キー
翻訳キーを一部刷新し、目的をより明確にしました:
| Interface | Old key | New key |
|---|---|---|
| SearchBoxTranslations | resetButtonTitle | clearButtonTitle |
| SearchBoxTranslations | resetButtonAriaLabel | clearButtonAriaLabel |
| SearchBoxTranslations | cancelButtonText | closeButtonText |
| SearchBoxTranslations | cancelButtonAriaLabel | closeButtonAriaLabel |
| FooterTranslations | searchByText | poweredByText |
Find the full list of translations in the API documentation.
Ask AIとDocSearch v4の統合
基本統合
DocSearch v4はAlgoliaのAsk AI機能をシームレスにサポートします。AIを活用した検索を有効化するには、既存のDocSearch設定にaskAiパラメータとAlgolia Assistant 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に置き換えてください。
高度な統合(別インデックスの利用)
メインのDocSearch設定とは別の構成でAsk AIを利用したい場合(例:異なる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の持ち込み)サポート:独自のLLMキーと設定を提供することでカスタムAIモデルを統合可能
-
セキュリティの強化:短期トークンとドメイン検証により不正アクセスを低減
-
分析機能とフィードバック処理の強化:アシスタントの利用状況とパフォーマンスを監視する堅牢な分析機能