Azure AI 検索の API バージョン

Note

Azure AI 検索は、Azure ポータルREST APIおよびAzure SDKから使用できます。 また、Foundry IQ は、エンタープライズ コンテンツを、Microsoft Foundry ポータルのエージェントの再利用可能なアクセス許可に対応したナレッジ ベースに変換するマネージド ナレッジ レイヤーです。

Azure AI 検索機能更新プログラムを定期的にロールアウトします。 このような更新が発生すると、下位互換性を維持するために、API の新しいバージョンが必要になる場合があります (毎回とは限りません)。 新しいバージョンが発行されると、お客様は検索サービスの更新内容をコードに統合するタイミングと方法を管理することができます。

原則として、REST API と Azure SDK クライアント ライブラリは、必要な場合にのみバージョン管理されます。これは、新しい API バージョンを使用するようにコードをアップグレードする作業が必要な場合があるためです。 下位互換性が保たれなくなる形で API の一部の要素が変更された場合に限り、新しいバージョンが必要です。 このような変更は、既存の機能に修正を加えたことや、新機能において既存の API のセキュリティ構成を変更したことが原因で発生することがあります。

非推奨のパスの詳細については、Azure SDK ライフサイクルとサポート ポリシーを参照してください。

非推奨のバージョン

2023-07-01-preview は 2024 年 4 月 8 日に非推奨となり、2024 年 7 月 8 日の時点ではサポートされなくなりました。 このバージョンは、ベクター検索のサポートを提供した最初の REST API でした。 新しい API バージョンでは、ベクトル構成が異なります。 できるだけ早く、新しい API バージョンまたは新しい SDK バージョンに移行します。

中止バージョン

2020 年 10 月 15 日の時点で、次の API バージョンは廃止され、文書化もサポートも終了しています。

  • 2015-02-28
  • 2015-02-28-プレビュー
  • 2014-07-31-プレビュー
  • 2014-10-20-プレビュー

すべての SDK は、REST API のバージョンに基づいています。 REST API バージョンが廃止された場合、それに基づく SDK パッケージも廃止されます。 3.0.0-rc より古いAzure AI 検索 .NET SDK はすべて廃止されました。

廃止されたバージョンを使用するコードがある場合は、 新しい API バージョンまたは新 しい SDK バージョンに移行します。

REST API

REST API Link
検索サービス (データ プレーン) REST API リファレンスの API バージョン を参照してください。
検索管理(コントロールプレーン) REST API リファレンスの API バージョン を参照してください。

.NETのAzure SDK

SDK バージョン Status 変更履歴 説明
Azure。Search.Documents 12 アクティブ Changelog コンテンツやオブジェクトに対する読み取り/書き込み操作など、サービスに対するデータ プレーン操作の API。
Azure。ResourceManager.Search アクティブ Changelog 検索サービスでのコントロール プレーン操作の API。

JavaのAzure SDK

SDK バージョン Status 変更履歴 説明
azure-search-documents 12 アクティブ Changelog データ プレーン操作には azure-search-documents クライアント ライブラリを使用します。
azure-resourcemanager-search 2 アクティブ Changelog コントロール プレーン操作には azure-resourcemanager-search クライアント ライブラリを使用します。

JavaScript のAzure SDK

SDK バージョン Status 変更履歴 説明
@azure/search-documents 13 アクティブ Changelog データ プレーン操作には @azure/search-documents クライアント ライブラリを使用します。
@azure/arm-search 4 アクティブ Changelog コントロール プレーン操作には、@azure/arm-search パッケージを使用します。

PythonのAzure SDK

SDK バージョン Status 変更履歴 説明
azure-search-documents 12 アクティブ Changelog データ プレーン操作には azure-search-documents クライアント ライブラリを使用します。
azure-mgmt-search 9 アクティブ Changelog コントロール プレーン操作には azure-mgmt-search クライアント ライブラリを使用します。

すべてのAzureソフトウェア開発キット

ベータ版のクライアント ライブラリとドキュメントをお探しの場合は、このページには、Azure SDKライブラリ のすべてのパッケージ、コード、ドキュメントへのリンクが含まれています。