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

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

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

REST API ドキュメントのバージョン管理が行われます。 API リファレンス ページを開くと、目次の上にバージョン セレクターが表示されます。 API 参照が Reference>Data Plane フォルダーにあることを確認します。

安定したバージョン

プレビュー バージョン

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

リリース ノート

2024-05-01-preview

このプレビューでは、インデックス作成とクエリ中に、OneLake のインデックス作成、関連性の調整、より多くの埋め込みモデルとのより深い統合のサポートが追加されます。 これは 2024-03-01-previewに基づいて構築されているため、スカラー量子化、狭いデータ型、そのバージョンで導入されたストレージ オプションも備えています。

2024-03-01-preview または 2023-10-01-previewからアップグレードするには、AzureOpenAIEmbedding スキルまたはベクターライザーを更新して、モデル名とディメンションを含めます。 2023-07-01-preview (非推奨) からアップグレードする場合、または詳細な手順については、「アップグレード REST API」を参照してください。

このプレビューの更新プログラムを次に示します。 Azure AI Searchの新機能 もお勧めします。

2024-03-01-preview

このプレビュー バージョンは、ベクター ストレージを向上させるプレビュー API を追加することで、2023-10-01-preview に基づいています。 詳細については、「Azure AI Search の新機能」を参照してください。

2023-11-01

このバージョンでは、一般公開されている機能が提供されます。 詳細については、「Azure AI Search の新機能」を参照してください。

2023-10-01-preview

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

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

インデックスを作成または更新します。

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

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

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

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

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

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

ドキュメント検索:

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

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

2023-07-01-preview

このバージョンではベクターのサポートが導入され、新しい API バージョンと互換性のないベクター構成が使用されます。

• 単精度浮動小数点数の配列を含むフィールドに Collection(Edm.Single) データ型を追加しました。 これはベクターのデータ型であり、ドキュメント フィールドごとに 1 つの生成された埋め込みを格納するために使用されます。 検索インデックスでは、ベクター構成プロパティも指定されます。 これらの API の インデックスの作成または更新 を参照してください。
• ベクター データを受け入れるようにインデックス作成ワークロードを更新しました。 ドキュメントの追加、更新、または削除 を参照してください。
• ベクター検索のクエリ パラメーターを追加しました。 これらのパラメーターについては、「ドキュメントの検索」 を参照してください。
• サービス統計の取得: サービスのベクター インデックス クォータと使用状況を返します。
• インデックス統計の取得: ベクター インデックスのクォータと検索インデックスの使用状況を返します。
• 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの 破壊的変更に関するページを参照してください。

2021-04-30-preview

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

• Index エイリアス は、クエリおよびインデックス作成要求でインデックスを参照するために使用されるセカンダリ名を追加します。 エイリアス操作には、作成、更新、削除、取得、および一覧表示が含まれます。
• 送信接続のマネージド ID を します。 データ ソースの作成または更新 の接続文字列の新しい値は、ハードコーディングされたデータベース資格情報またはキーではなく、Microsoft Entra ID 認証とロールを使用した接続をサポートします。
• マネージド ID のサポートは、カスタマー マネージド暗号化を使用して既定の暗号化を補完する検索ソリューション 、キー コンテナー接続でもサポートされます。
• テキスト翻訳コグニティブ スキルのその他の言語。
• 検索ドキュメント (プレビュー) のセマンティック検索とスペル チェック用のその他の queryLanguages。
• 必要に応じて、ドキュメントの検索 (プレビュー)でセマンティック検索からキャプションを要求する captions パラメーター。
• セマンティック構成 は、インデックスの作成または更新で指定します。 セマンティック構成では、セマンティック ランク付け、キャプション、強調表示、回答に使用するフィールドを決定します。
• Search Documents (プレビュー)のセマンティック クエリに必要な semanticConfiguration パラメーター。
• 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの 破壊的変更に関するページを参照してください。

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 のインデクサー データ ソース
• テキスト正規化のノーマライザー プロパティ(大文字と小文字を区別しないフィルター処理、ファセット、並べ替え用)
• インデクサーベースのインデックス作成用にドキュメントをリセットして、特定のドキュメントを 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 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの 破壊的変更に関するページを参照してください。

関連項目

• 検索サービス を作成する
• クイック スタート: REST API を使用して Azure AI Search インデックスを作成する