Azure AI Search REST APIは、参照のためにまとめた一般的なHTTPリクエスト/レスポンスヘッダーのセットをサポートしています。
| リクエストヘッダー |
タイプ |
Description |
| 同意する |
コンテンツの種類 |
回答のリクエストされたコンテンツタイプ。 デフォルトはapplication/jsonです。odata.metadata=minimal. その他の許容値としてはapplication/json、application/json、odata.metadata=full, application/json;odata.metadata=none、テキスト/プレーン($countのみ)です。 |
| APIキー |
糸 |
APIによってクエリ または管理者キーに設定してください。 |
| 承認 |
糸 |
リクエスト用のOAuth 2.0アクセストークン。
ロールベースアクセスのために検索サービスの設定が必要です。 このリクエストヘッダーは、Microsoft Entra ID認証およびロール割り当てを使用するクライアントアプリ向けです。 クライアントコードがトークンを提供しなければなりません。 検索サービスが データプレーン認証に設定されていれば、サポートされているどのREST APIバージョンでもこのリクエストヘッダーを使用できます。 |
| コンテンツタイプ |
コンテンツタイプ |
リクエストボディのコンテンツタイプ(PUT/POST)。 application/jsonに設定する必要があります。 |
| クライアントリクエストID |
GUID |
オプションで、カーリーブレースなどの装飾のないGUID形式の発信者指定リクエストID(例:client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)も備えています。 与えられたリクエストを識別する呼び出し元が定義した値。 もし指定されれば、この値は応答情報に含まれ、リクエストをマッピングする方法として使われます。 |
| OData-MaxVersion |
"4.0" |
クライアントがサポートするODataプロトコルの最大バージョンを指定します。 デフォルトは「4.0」です |
| 好む |
「return=表現」または「return=最小」 |
PUTおよびPOST /indexesリクエストからのレスポンスペイロードを制御するために使用されます。 POSTやPUTで新しいインデックスを作成する場合は「return=representation」、PUTで既存インデックスを更新する場合は「return=minimal」がデフォルトです。 |
| Return-client-request-id |
True または False |
クライアント-request-idが指定されている場合、サーバーに応答にclient-request-idヘッダーを含めるよう指示します。 既定値は False です。 |
| If-Match |
ETag または * |
現在のバージョンが指定されたETagと一致する場合のみリソースを変更するために使われます。 このヘッダーをリソース(インデクサー、インデックス、データソースなど、ドキュメントは除く)に対してPOST、PUT、またはDELETEメソッドと組み合わせて使用することで 、楽観的な並行処理が可能になります。 |
| If-None-Match |
ETag または * |
現在のバージョンが指定されたETagと一致しない場合のみリソースを変更するために使われます。 このヘッダーをリソース(インデクサー、インデックス、データソースなど、ドキュメントは除く)に対してPOST、PUT、またはDELETEメソッドと組み合わせて使用することで 、楽観的な並行処理が可能になります。 |
| 応答ヘッダー |
タイプ |
Description |
| クライアントリクエストID |
GUID |
元のリクエストで呼び出し元が指定した識別子(存在する場合)。 |
| コンテンツタイプ |
コンテンツタイプ |
レスポンス本文の内容タイプ。 |
| ロケーション |
URL |
POSTおよびPUT /indexesリクエスト用に新たに作成されたインデックス定義のURLです。 |
| OData-Version |
"4.0" |
ODataプロトコルの応答バージョン。 |
| リクエストID |
GUID |
現在の操作に対する一意識別子。 指定されている場合はクライアント-リクエスト-idと等しい;そうでなければ、その値はサーバー上で生成されます。 |
| 経過時間 |
Number |
サービスがリクエストを処理する時間(ミリ秒単位)です。 この値はリクエスト処理にかかる時間のみを含み、ネットワーク転送時間は含まれていません。 |
| ETag |
糸 |
現在のリソースのバージョンを表す不透明な文字列(インデクサー、インデックス、データソースには返されるが、ドキュメントには戻らない)。 この文字列を If-Match またはIf-None-Match ヘッダーで使って 楽的並行処理を行ってください。 |
こちらも参照ください
Azure AI Search REST API