Azure AI 搜尋服務 (常見的 HTTP 要求和回應標頭)
Azure AI 搜尋服務 REST API 支援一組常見的 HTTP 要求/響應標頭，摘要說明在這裡以供參考：
| 要求標頭 |
類型 |
Description |
| 接受 |
內容類型 |
回應要求的內容類型。 預設值為 application/json;odata.metadata=minimal。 其他允許的值是 application/json、application/json;odata.metadata=full， application/json;odata.metadata=none，且僅) $count的 text/plain (。 |
| api-key |
字串 |
視 API 而定，設定為 您的查詢或管理員金鑰。 |
| 授權 |
字串 |
要求的 OAuth 2.0 存取令牌。 需要對搜尋服務進行設定，才能進行 角色型存取。 此要求標頭適用於使用 Microsoft Entra ID 驗證和角色指派的用戶端應用程式。 您的用戶端程式代碼必須提供令牌。 只要搜尋服務已設定 數據平面驗證，您就可以將此要求標頭與任何支援的 REST API 版本搭配使用。 |
| Content-Type |
Content-Type |
要求主體的內容類型 (PUT/POST)。 預設為 application/json。 |
| client-request-id |
GUID |
選擇性呼叫端指定的要求標識符，格式為不含大括弧的 GUID，例如大括號 (，例如 client-request-id：9C4D50EE-2D56-4CD3-8152-34347DC9F2B0) 。 呼叫端定義的值，識別指定的要求。 如果指定，此值會包含在響應資訊中，以對應要求的方式。 |
| OData-MaxVersion |
"4.0" |
指定用戶端支援的 OData 通訊協定最大版本。 預設值為 "4.0"。 |
| 偏好 |
"return=representation" 或 "return=minimal" |
用來控制來自 PUT 和 POST/索引要求的回應裝載。 透過 POST 或 PUT 建立新索引時，預設值為 “return=representation”，而 “return=minimal” 用於透過 PUT 更新現有索引。 |
| return-client-request-id 設為 |
True 或 False |
若已指定 client-request-id，則會指示伺服器在回應中包含 client-request-id 標頭。 預設值是 False。 |
| If-Match |
ETag 或 * |
只有在目前的版本符合指定的 ETag 時，才能變更資源。 在 (索引器、索引器和數據源等資源上使用這個標頭搭配 POST、PUT 或 DELETE 方法，但不會) 檔來啟用 開放式並行存取控制。 |
| If-None-Match |
ETag 或 * |
只有在目前的版本不符合指定的 ETag 時，才能變更資源。 在 (索引器、索引器和數據源等資源上使用這個標頭搭配 POST、PUT 或 DELETE 方法，但不會) 檔來啟用 開放式並行存取控制。 |
| 回應標頭 |
類型 |
Description |
| client-request-id |
GUID |
在原始要求中，呼叫者所指定的識別碼 (如果有的話)。 |
| Content-Type |
Content-Type |
回應主體的內容類型。 |
| Location |
URL |
POST 和 PUT /indexes 要求新建立之索引定義的 URL。 |
| OData-Version |
"4.0" |
回應的 OData 通訊協定版本。 |
| request-id |
GUID |
目前作業的唯一識別碼。 若已指定，則等於 client-request-id；否則會在伺服器上產生此值。 |
| elapsed-time |
數字 |
服務用於處理要求的時間 (以毫秒為單位)。 此值只包含處理要求所花費的時間，而且不包含網路傳輸時間。 |
| ETag |
字串 |
不透明字串，表示索引器、索引和數據源所傳回之資源 (的目前版本，但不會傳回檔) 。 在 If-Match 或 If-None-Match 標頭中使用此字串進行 開放式並行控制。 |
另請參閱
Azure AI 搜尋 REST API