OData のサポート (Azure AI Search)
Azure AI Search Service API では、インデックス クエリに Open Data Protocol (OData) が使用されます。 Azure AI Search では、OData バージョン 4 がサポートされています。
HTTP 要求ヘッダーでの OData の構文
OData では、必要に応じて設定できるいくつかの HTTP 要求ヘッダーが定義されています。 Accept ヘッダーに対して application/json;odata.metadata=none のような OData 固有の値を使用して、応答に含まれるメタデータの量を制御できます。 既定値は、odata.metadata=minimal です。 簡潔にするため、このドキュメントのすべての例では odata.metadata=none と仮定します。
設定できるもう 1 つのヘッダーは OData-MaxVersion です。 Azure AI Search Service API では OData V4 がサポートされているため、"4.0" に設定 OData-MaxVersion する必要があります。 これにより、API に対して、要求本文は OData V4 形式であることを想定し、応答を OData V4 形式で送信するように通知します。 今後、新しいバージョンの OData プロトコルのサポートが追加されたら、このヘッダーに異なる値を設定できます。 Azure AI Search Service API では、V4 より前のバージョンの OData はサポートされていません。
フィルターと並べ替え式での OData の使用の詳細については、「 Azure AI Search の OData 式構文 」を参照してください。 代替構文については、「 Azure AI Search の単純なクエリ 構文」を参照してください。
代替 OData 構文での Search Service API
Search Service API は、エンティティ参照に対する OData 構文をサポートします。 これは、インデックス内のドキュメントとインデックス自体 (インデックス名がエンティティ キー) の両方に適用されます。 代替 OData 構文のあるすべての API を次にまとめます。
インデックスの更新
PUT /indexes('[index name]')?api-version=2015-02-28
インデックスの取得
GET /indexes('[index name]')?api-version=2015-02-28
インデックスの統計情報の取得
GET /indexes('[index name]')/stats?api-version=2015-02-28
インデックスの削除
DELETE /indexes('[index name]')?api-version=2015-02-28
インデックス内のデータの追加および削除
POST /indexes('[index name]')/docs/index?api-version=2015-02-28
Search
GET /indexes('[index name]')/docs?[query parameters]
Lookup
GET /indexes('[index name]')/docs('[key]')?[query parameters]
Count
GET /indexes('[index name]')/docs/$count?api-version=2015-02-28
推奨事項
GET /indexes('[index name]')/docs/suggest?[query parameters]