メインコンテンツへスキップ
バージョン: 安定版 (v4.x)

v3からv4への移行

非公式ベータ版翻訳

このページは PageTurner AI で翻訳されました(ベータ版)。プロジェクト公式の承認はありません。 エラーを見つけましたか? 問題を報告 →

このガイドでは、DocSearch v3からDocSearch v4への移行に関する詳細情報を提供し、主な相違点や新たな設定オプションを解説します。包括的な概要については、APIリファレンススタートガイドを参照してください。

Algoliaキーワード検索のみを利用する場合

アプリケーションがAlgoliaのキーワード検索機能のみを利用している場合、移行作業は不要です。DocSearch v4はキーワード検索操作に対して完全な下位互換性を維持しています。

翻訳キー

翻訳キーを一部刷新し、目的をより明確にしました:

InterfaceOld keyNew key
SearchBoxTranslationsresetButtonTitleclearButtonTitle
SearchBoxTranslationsresetButtonAriaLabelclearButtonAriaLabel
SearchBoxTranslationscancelButtonTextcloseButtonText
SearchBoxTranslationscancelButtonAriaLabelcloseButtonAriaLabel
FooterTranslationssearchByTextpoweredByText

完全な翻訳キーリストはAPIドキュメントでご確認いただけます

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オブジェクト内の各フィールド(indexNameapiKeyappIdassistantId)が、使用するAlgoliaインデックスとアシスタント向けに正しく設定されていることを確認してください。

v4の機能(Ask AI対応)

  • BYO-LLM(独自LLMの持ち込み)サポート:独自のLLMキーと設定を提供することでカスタムAIモデルを統合可能

  • セキュリティの強化:短期トークンとドメイン検証により不正アクセスを低減

  • 分析機能とフィードバック処理の強化:アシスタントの利用状況とパフォーマンスを監視する堅牢な分析機能

スタイリング

CSSクラスの大半を刷新しました。既存のスタイルが破壊されることはありませんが、このバージョンで新たなスタイルやクラスが追加されたため、再度カスタマイズが必要になる可能性があります。

移行パスと互換性

DocSearch v4では明確な移行パスを提供します:

  • 必要に応じて新しいaskAi設定でDocSearch構成を更新

  • Algoliaダッシュボードでドメイン許可リストとアシスタント設定を適切に構成

  • Ask AIの応答とパフォーマンスを最適化するため、インデックスされたコンテンツと分析を定期的に確認してください。

エンドポイントセキュリティ、キャッシュ戦略、インフラストラクチャの詳細については、専用のセキュリティとインフラドキュメントを参照してください。

サポートとリソース

  • Ask AIドキュメント: Algolia Ask AIに関する詳細情報(Documentation

  • DocSearchプレイグラウンド:DocSearch構成をテストする対話型環境(Docsearch Playground

  • コミュニティ&サポートAlgolia Discordでお問い合わせ

このガイドに従うことで、DocSearch v4へのスムーズな移行が実現し、Algoliaの強力なAI駆動検索機能を最大限に活用できます。