Azure AI Search REST API 支援一組常見的 HTTP 請求/回應標頭，以下為參考摘要：
| 請求標頭 |
類型 |
Description |
| 接受 |
內容類型 |
回應所需的內容類型。 預設是 application/json;odata.metadata=minimal。 其他允許的值有 application/json、application/json;odata.metadata=full， application/json;odata.metadata=none，以及 text/plain（僅限 $count）。 |
| API金鑰 |
繩子 |
根據 API 設定查詢 或管理金鑰。 |
| 授權 |
繩子 |
請求的 OAuth 2.0 存取權杖。 需要設定你的搜尋服務以進行 角色基礎存取。 此請求標頭用於使用 Microsoft Entra ID 認證及角色指派的用戶端應用程式。 你的客戶端代碼必須提供該令牌。 只要搜尋服務設定為 資料平面認證，任何支援的 REST API 版本都可以使用此請求標頭。 |
| 內容-類型 |
內容-類型 |
請求實體的內容類型（PUT/POST）。 必須設定為 application/json。 |
| 客戶請求識別碼 |
GUID |
可選的呼叫者指定請求 ID，以無大括號等裝飾的 GUID 形式呈現（例如 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 |
真或假 |
若在 client-request-id 指定時指定，則指示伺服器在回應中包含 client-request-id 標頭。 預設值為 False。 |
| If-Match |
Etag 或 * |
僅當當前版本符合指定的 ETag 時，才用於更改資源。 使用此標頭搭配資源（如索引器、索引器和資料來源，但不包括文件）的 POST、PUT 或 DELETE 方法，以實現 樂觀的並行控制。 |
| 如果-None-Match |
Etag 或 * |
只有當當前版本與指定的 ETag 不符時，才會用來更改資源。 使用此標頭搭配資源（如索引器、索引器和資料來源，但不包括文件）的 POST、PUT 或 DELETE 方法，以實現 樂觀的並行控制。 |
| 回應標頭 |
類型 |
Description |
| 客戶請求識別碼 |
GUID |
若有，則由呼叫者在原始請求中指定的識別碼。 |
| 內容-類型 |
內容-類型 |
回應內容的類型。 |
| 地點 |
URL |
新建立的 POST 與 PUT /indexes 請求索引定義的網址。 |
| OData-Version |
"4.0" |
回應的OData協議版本。 |
| 請求識別碼 |
GUID |
目前操作的唯一識別碼。 若指定，則等於 client-request-id;否則，該值會在伺服器上產生。 |
| 經過時間 |
Number |
服務處理請求的時間，以毫秒計。 此值僅包含處理請求所花費的時間，不包含網路傳輸時間。 |
| Etag |
繩子 |
一個不透明字串，代表當前版本的資源（索引器、索引器和資料來源會回傳，但文件不會回傳）。 在 If-Match 或 If-None-Match 標頭中使用此字串，以實現 樂觀並發控制。 |
另請參閱
Azure AI 搜尋服務 REST API