REST API のバージョン (Azure AI Search)
この記事では、Azure AI Search 用の検索 REST API の現在と過去のバージョンを示します。
バージョン管理された API ドキュメント
REST API ドキュメントのバージョン管理が行われます。 API リファレンス ページを開くと、目次の上にバージョン セレクターが表示されます。 API 参照が Reference>Data Plane フォルダーにあることを確認します。
安定したバージョン
| API バージョン | 仕様 | API の更新 |
|---|---|---|
2024-07-01 (最新) |
Swagger 仕様の | リリース ノート の |
2023-11-01 |
Swagger 仕様の | リリース ノート の |
2020-06-30 |
Swagger 仕様の | リリース ノート の |
2019-05-06 |
Swagger 仕様の | 複合型を追加します。 |
プレビュー バージョン
プレビュー バージョンは、新機能のテスト、フィードバックの収集、問題の検出と修正を行うためにリリースされています。 プレビュー API は、Microsoft Azure プレビューの
| API バージョン | 仕様 | API の更新 |
|---|---|---|
2024-11-01-preview (最新) |
Swagger 仕様の | リリース ノート の |
2024-09-01-preview |
Swagger 仕様の | リリース ノート の |
2024-05-01-preview |
Swagger 仕様の | リリース ノート の |
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 仕様の | リリース ノート の |
リリース ノート
2024-11-01-preview
このプレビューは、2024-09-01-preview から 2024-11-01-preview にアップグレードできます。 詳細については、「REST APIのアップグレード」を参照してください。
| 更新 | 該当する REST API |
|---|---|
| セマンティック リランカーでクエリの書き換えを行います。これは、L2 ランカーに送信されるクエリを調整するために使用されます。 | ドキュメントの検索、要求の新しい QueryRewritesType プロパティです。 |
| ドキュメント レイアウト スキル、構造のドキュメントの分析に使用されます。 | |
| Azure AI マルチサービス リソースをアタッチする |
スキルセットの作成または更新、新しい AIServicesAccountIdentity プロパティ。 |
| Markdown 解析モード。Azure Storage の Markdown ファイルのインデックス作成に使用されます。 | インデクサーの作成または更新 |
| 圧縮ベクターの代わりに元のベクトルを使用して再スコア付けするために使用される、圧縮されたベクターのの再スコアリング オプションです。 バイナリおよびスカラー圧縮を使用して、HNSW および完全な KNN ベクター アルゴリズムに適用されます。 |
インデックスの作成または更新、新しい rescoringOptions プロパティ。 新しい enableRescoring プロパティは、2024-03-01-preview で導入された rerankWithOriginalVectors にマップされます。 |
2024-09-01-preview
このプレビューは、2024-05-01-preview から 2024-09-01-preview にアップグレードできます。 詳細については、「REST APIのアップグレード」を参照してください。
| 更新 | 該当する REST API |
|---|---|
| 切り捨てられたディメンションは、Matryoshka Representation Learning (MRL) 量子化で再トレーニングされた text-embedding-3-small および text-embedding-3-large モデルに されます。 | インデックスの作成または更新、新しい truncationDimension パラメーター |
| 逆ランク 融合 (RRF) によってスコア付けされたハイブリッド検索結果をアンパックするためのサブスコアまたはスコアリングの詳細。 | ドキュメントの検索、新しい デバッグ パラメーター、および応答のサブスコア定義のクエリを実行します。 |
| ハイブリッド検索クエリのベクター部分へのターゲット フィルター処理。 | |
| 文字だけでなく、テキスト分割スキルのトークン チャンク。 | スキルセット、新しい ユニット パラメーター、およびその他のトークン関連のプロパティを作成または更新します。 |
2024-07-01
このバージョンでは、統合ベクター化 (スキルとベクター化)、スカラー量子化、バイナリ量子化の一般提供の更新プログラムが提供されます。 詳細については、「Azure AI Search の新機能」を参照してください。
| 更新 | 該当する REST API |
|---|---|
| 一般提供 - ベクター データ型 |
インデックス の作成または更新の |
| 一般提供 - 検索インデックスの組み込みのスカラー量子化またはバイナリ量子化に ベクター量子化プロパティを |
インデックス の作成または更新の |
| 一般提供 - フィールドの追加コピーが格納されるかどうかを決定する ベクター フィールド に格納されたプロパティ。 追加のコピーは、そのフィールドの取得可能なコンテンツです。 保存しない場合、フィールドはクエリで引き続き使用されますが、検索結果で返すことはできません。 このプロパティを設定すると、検索インデックス内の検索サービスまたはベクター クォータの領域を節約できます。 | インデックス の作成または更新の |
| 一般提供 - VectorizableTextQuery 関連性チューニングのためのパラメーター。 ハイブリッド クエリ パラメーター (MaxTextSizeRecall) はまだプレビュー段階です。 | ドキュメントの検索 |
| 一般提供 - インデックス作成中の統合ベクター化のためにテキスト埋め込み ada-002 よりも多くのモデルをサポートする AzureOpenAIEmbedding スキル。 特定のモデルを対象とするようにモデル名とディメンションのプロパティを設定します。 | スキルセット の作成または更新を |
| 一般公開 - クエリ中の統合ベクター化のための Azure OpenAI 埋め込みベクターライザー。 Vectorizer プロパティは、より多くのモデルをサポートします。 | インデックス の作成または更新の |
| 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの |
すべてのバージョン |
2024-05-01-preview
このプレビューでは、インデックス作成とクエリ中に、OneLake のインデックス作成、関連性の調整、より多くの埋め込みモデルとのより深い統合のサポートが追加されます。 これは
2024-03-01-preview または 2023-10-01-previewからアップグレードするには、AzureOpenAIEmbedding スキルまたはベクターライザーを更新して、モデル名とディメンションを含めます。
2023-07-01-preview (非推奨) からアップグレードする場合、または詳細な手順については、「アップグレード REST API」を参照してください。
このプレビューの更新プログラムを次に示します。 Azure AI Searchの新機能
| 更新 | 該当する REST API |
|---|---|
| OneLake ファイルとショートカットのインデクサー データ ソース。 | データソース の作成または更新 |
Collection(Edm.Byte)は、それらをサポートするモデルを埋め込むためのバイナリ データ型です。 ベクター フィールド定義では、このデータ型がサポートされています。 |
インデックス の作成または更新の |
| 関連性チューニングのための複数のベクター およびハイブリッド クエリ パラメーター。 しきい値を設定して、スコアの低い結果を除外します。 重みベクトル クエリ。 ハイブリッド クエリの場合は、ハイブリッド クエリのテキスト部分で取得する最大ドキュメント数を設定します。 | ドキュメントの検索 |
| インデックス作成中のマルチモーダル統合ベクター化のための新しい Azure AI Vision スキル。 このスキルは、Azure AI Vision のマルチモーダル API を呼び出します。 | スキルセット の作成または更新を |
| マルチモーダル クエリ用の新しい Azure AI Vision ベクターライザー。 ベクター化はインデックス定義で指定されますが、クエリの実行中に使用されます。 | インデックス の作成または更新の |
| インデックス作成中の統合ベクター化のために、テキスト埋め込み ada-002 よりも多くのモデルをサポートするように AzureOpenAIEmbedding スキルを更新しました。 特定のモデルを対象とするようにモデル名とディメンションのプロパティを設定します。 | スキルセット の作成または更新を |
| クエリ中の統合ベクター化用の Azure OpenAI 埋め込みベクターライザーを更新しました。 Vectorizer プロパティは、より多くのモデルをサポートします。 | インデックス の作成または更新の |
| 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの |
すべてのバージョン |
2024-03-01-preview
このプレビュー バージョンは、ベクター ストレージを向上させるプレビュー API を追加することで、2023-10-01-preview に基づいています。 詳細については、「Azure AI Search の新機能」を参照してください。
| 更新 | 該当する REST API |
|---|---|
| 新しい 、それらをサポートするモデルを埋め込む場合や、より小さなベクトルを出力する量子化ロジックがある場合に ベクター フィールドの狭いデータ型です。 | インデックス の作成または更新の |
| 新しい ベクター量子化プロパティ、検索インデックス内の組み込みのベクター圧縮に使用されます。 | インデックス の作成または更新の |
| 新しいブール値 、フィールドの追加コピーが格納されるかどうかを決定する ベクター フィールド に格納されたプロパティ。 追加のコピーは、そのフィールドの取得可能なコンテンツです。 保存しない場合、フィールドはクエリで引き続き使用されますが、検索結果で返すことはできません。 このプロパティを設定すると、検索インデックス内の検索サービスまたはベクター クォータの領域を節約できます。 | インデックス の作成または更新の |
| 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの |
すべてのバージョン |
2023-11-01
このバージョンでは、一般公開されている機能が提供されます。 詳細については、「Azure AI Search の新機能」を参照してください。
| 更新 | 該当する REST API |
|---|---|
| 検索ポスト要求のセマンティック ランク付け。 | ドキュメントの検索 |
| ベクター フィールドのインデックス作成のためのベクター検索の構成 | インデックス の作成または更新の |
| Post 要求の検索でのベクター クエリ。 | ドキュメントの検索 |
| 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの |
すべてのバージョン |
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 バージョンのは使用しないでください。 このプレビュー バージョンの廃止は 2024 年 4 月 15 日に発表され、2024 年 7 月 8 日以降はサポートされなくなりました。 移行に関するヘルプについては、「Azure AI Searchでの REST API のアップグレード
このバージョンではベクターのサポートが導入され、新しい 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 での論理的な削除のためのインデクサー データ ソース
- 関連性スコアに関する詳細情報を返す featuresMode パラメーター
- Azure Machine Learning (AML) コグニティブ スキル
- 個人識別検出コグニティブ スキル
- エンリッチメントされたドキュメントをキャッシュして、画像処理 (およびその他の AI エンリッチメント) を保持および再利用する
- 2024 年 3 月 29 日より:GET 応答は接続文字列またはキーを返さなくなりました。 詳細については、接続情報 を読み取るクライアント コードの
破壊的変更に関するページを参照してください。
関連項目
- 検索サービス を作成する
- クイック スタート: REST API を使用して Azure AI Search インデックスを作成する