REST API バージョン (Azure AI Search)

  • [アーティクル]

この記事では、Azure AI Search用の Search REST API の現在と過去のバージョンの一覧を示します。

バージョン管理された API ドキュメント

REST API ドキュメントのバージョン管理が行われます。 API 参照ページを開くと、目次の上にバージョン セレクターが表示されます。 API 参照が [ 参照>データ プレーン ] フォルダーから取得されていることを確認します。

バージョン セレクターのスクリーンショット。

安定したバージョン

API バージョン 仕様 API の更新
2023-11-01 (最新) Swagger の仕様 リリース ノート
2020-06-30 Swagger の仕様 リリース ノート
2019-05-06 Swagger の仕様 複合型が追加されています。
2017-11-11 Swagger の仕様 スキルセットと AI エンリッチメントが追加されています。
2016-09-01 Swagger の仕様 インデクサーが追加されています。
2015-02-28 2020 年 10 月 10 日以降はサポートされません 最初に一般公開されたリリースです。

プレビュー バージョン

プレビュー バージョンは、新機能のテスト、フィードバックの収集、問題の検出と修正のためにリリースされます。 プレビュー API は、 Microsoft Azure プレビューの追加使用条件で利用できます。

API バージョン 仕様 API の更新
2024-03-01-Preview (最新) Swagger の仕様 リリース ノート
2023-10-01-Preview Swagger の仕様 リリース ノート
2023-07-01-Preview (非推奨) Swagger の仕様 リリース ノート
2021-04-30-Preview Swagger の仕様 リリース ノート
2020-06-30-Preview Swagger の仕様 リリース ノート
2019-05-06-Preview Swagger の仕様 リリース ノート
2017-11-11-Preview Swagger の仕様 安定バージョンに関連付けられているプレビュー バージョン。
2016-09-01-Preview Swagger の仕様 安定バージョンに関連付けられているプレビュー バージョン。
2015-02-28-Preview (廃止) 2020 年 10 月 10 日以降はサポートされません 安定バージョンに関連付けられているプレビュー バージョン。
2014-10-20-Preview (廃止) 2020 年 10 月 10 日以降はサポートされません 2 番目のパブリック プレビューです。
2014-07-31-Preview (廃止) 2020 年 10 月 10 日以降はサポートされません 1 番目のパブリック プレビューです。

リリース ノート

2024-03-01-Preview

このプレビュー バージョンは、 2023-10-01-preview 領域を節約するのに役立つ次のプレビュー API を追加することで構築されています。

  • ベクター フィールドをサポートする埋め込みモデルまたは小さいベクトルを出力する量子化ロジックがある場合は、ベクター フィールドの新しい 狭いデータ型 。
  • 検索インデックスの組み込みベクトル圧縮のための新しいベクトル 量子化プロパティ 。
  • フィールドの追加のコピーを格納するかどうかを決定するベクター フィールドの新しいブール型格納プロパティ。 追加のコピーは、そのフィールドの取得可能なコンテンツです。 保存しない場合、フィールドはクエリで引き続き使用されますが、検索結果には返されません。 このプロパティを設定すると、検索サービスまたは検索インデックス内のベクター クォータの領域を節約できます。
  • 2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

2023-11-01

このバージョンでは、次のような一般提供の機能が提供されます。

  • Search Post 要求のセマンティック ランク付け。
  • Create要求または Update Index 要求でのベクター検索インデックス作成、および post 要求Searchベクター クエリ。
  • 2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

2023-10-01-Preview

このバージョンには、以前のプレビューで導入されたすべての機能と、ベクター検索 API への追加と変更が含まれています。 ベクター検索 API へのUpdatesは、2023-07-01-Preview からの破壊的変更です。 移行のヘルプについては、「ベクター フィールドを追加し、ベクター クエリをCreateする」を参照してください。

新しい事前フィルター機能を使用する予定の場合は、2023-10-01 以降に作成されたインデックスを使用する必要があります。

Createまたはインデックスの更新:

  • vectorSearchには、および のalgorithmsprofiles定義がありますvectorizers。

    • algorithms は引き続きサポート hnsw され、階層ナビゲーション可能な Small World (HNSW) と完全な K 最も近い近隣 (eKNN) を参照して もサポート eknnされるようになりました。 アルゴリズム セクションでは、HNSW パラメーターと eKNN パラメーターの複数の名前付き組み合わせを定義できます。 これは、 algorithmConfigurations 2023-07-01-Preview の プロパティ内 vectorSearch で置き換えられます。

    • profiles は、アルゴリズム構成を指定する新しい定義です。 たとえば、HNSW-1、HSNW-2、eKNN-1 という名前のアルゴリズム構成があるとします。 プロファイルで HNSW-1 を指定する場合があります。

    • vectorizers はインデックスで定義されていますが、クエリ時にテキスト クエリ文字列を埋め込むために使用されます。 ベクター化は、埋め込みモデルを参照します。 検索サービスは、埋め込みモデルを呼び出してテキスト クエリ文字列をベクター化し、その結果をベクター クエリの検索エンジンに渡します。

  • ベクター フィールドでは、 vectorSearchProfile は を vectorSearchConfiguration置き換えます。 プロパティは vectorSearchProfile 、フィールドで使用するベクター検索プロファイルを指定します。

  • この API バージョンより前に作成されたインデックスでは、2023-10-01-Preview API を呼び出す際に、要求で フィールドを変更して を指定する必要があります。プロファイルで で指定したものとまったく同じアルゴリズムが指定されているvectorSearchConfiguration限り、 を指定vectorSearchProfileする必要があります。 たとえば、既存のフィールド定義で が指定されている "vectorSearchConfiguration": "myHnsw"場合は、 に "vectorSearchProfile": "your profile name"置き換え、同じ "algorithm": "myHnsw"を参照するようにプロファイルを定義する必要があります。

Search ドキュメント:

  • vectorQueriesvectorsは 2023-07-01-Preview で置き換えられます
  • vectorQueries.vectors は vectors.values 2023-07-01-Preview で 置き換えられます。
  • ベクター クエリがポリモーフィック構造になりました。 kind は、要求されるベクター クエリの種類を示すために指定する必要があります。 "kind": "vector" はクエリがベクターであることを意味するため、呼び出し元は検索クエリ文字列をベクター埋め込みに既にベクター化している必要があります。
  • "exhaustive": "true" は、ベクトル インデックス内のすべてのベクトルに対して、完全な (ブルート フォース) k ニアレスト ネイバー検索を実行するかどうかを指定する新しいプロパティです。
  • vectorFilterMode は、クエリで事前フィルター処理 (2023-10-01 以降に作成されたインデックスの既定値) またはポストフィルター処理 (以前のインデックスの既定値) を指定するための新しいパラメーターです。

2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

2023-07-01-Preview

重要

このプレビュー バージョンの廃止は 2024 年 4 月 15 日に発表され、2024 年 7 月 8 日に廃止されます。 移行のヘルプについては、「Azure AI Searchでの REST API のアップグレード」を参照してください。

このバージョンには、以前のプレビューの機能とベクター検索のサポートが含まれています。

2021-04-30-Preview

このプレビュー バージョンには、2020-06-30-Preview で導入されたすべての機能と、次の API への追加が含まれています。

2020-06-30

このバージョンでは、次のような一般提供の機能が提供されます。

  • データ プレーン操作のための Azure ロールベースのアクセス制御
  • 関連性スコアリング (BM25)
  • ナレッジ ストア
  • Azure Data Lake Storage (ADLS) Gen2 のインデクサー データ ソース
  • カスタム エンティティの参照スキル
  • Microsoft Entra IDを介してシステムまたはユーザーマネージド ID で実行されているインデクサー
  • 2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

2020-06-30-Preview

このプレビュー バージョンには、2019-05-06-Preview で導入されたすべての機能と、次の追加機能が含まれています。

  • セマンティック検索。Standard レベルのサービスで実行され、セマンティック ランク付けを呼び出す Premium 機能です。
  • Power Query コネクタのインデクサー データ ソース
  • MySQL のインデクサー データ ソース
  • Cosmos DB Gremlin API のインデクサー データ ソース
  • SharePoint Online のインデクサー データ ソース
  • テキスト正規化の Normalizer プロパティ(大文字と小文字を区別しないフィルター処理、ファセット、並べ替え用)
  • インデクサーベースのインデックス作成のためにドキュメントをリセットして、特定のドキュメントを ID で具体的に更新する
  • エンティティ リンクのコグニティブ スキル (v3)
  • エンティティ認識の認知スキル (v3)
  • 感情分析コグニティブ スキル (v3)
  • 2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

2019-05-06-Preview

  • Cosmos DB MongoDB API のインデクサー データ ソースのサポート
  • Blob Storage でのネイティブ BLOB の論理的な削除のインデクサー データ ソース
  • 関連性スコアに関する詳細情報を返す featuresMode パラメーター
  • Azure Machine Learning (AML) コグニティブ スキル
  • 個人識別検出の認知スキル
  • エンリッチされたドキュメントをキャッシュして画像処理 (およびその他の AI エンリッチメント) を保持および再利用する
  • 2024 年 3 月 29 日より:GET 応答で接続文字列またはキーが返されなくなりました。 詳細については、「 接続情報を読み取るクライアント コードの破壊的変更 」を参照してください。

こちらもご覧ください