Azure AI Search REST API는 참조를 위해 여기에 요약된 일반적인 HTTP 요청/응답 헤더 집합을 지원합니다.
| 요청 헤더 |
형식 |
설명 |
| 동의함 |
내용 유형 |
응답에 대해 요청된 콘텐츠 형식입니다. 기본값은 application/json;odata.metadata=minimal입니다. 기타 허용 가능한 값은 application/json, application/json입니다. odata.metadata=full, application/json; odata.metadata=none 및 text/plain($count 전용). |
| api-key |
문자열 |
API에 따라 쿼리 또는 관리자 키로 설정합니다. |
| 권한 부여 |
문자열 |
요청에 대한 OAuth 2.0 액세스 토큰입니다.
역할 기반 액세스를 위해 검색 서비스에 대한 구성이 필요합니다. 이 요청 헤더는 Microsoft Entra ID 인증 및 역할 할당을 사용하는 클라이언트 앱용입니다. 클라이언트 코드는 토큰을 제공해야 합니다.
검색 서비스가 데이터 평면 인증을 위해 구성된 경우 지원되는 REST API 버전에서 이 요청 헤더를 사용할 수 있습니다. |
| 콘텐츠 형식 |
콘텐츠 형식 |
요청 본문(PUT/POST)의 콘텐츠 형식입니다. 기본값은 application/json입니다. |
| client-request-id |
GUID |
선택적 호출자가 지정한 요청 ID는 중괄호와 같은 장식이 없는 GUID 형식입니다(예: client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). 지정된 요청을 식별하는 호출자 정의 값입니다. 지정된 경우 이 값은 요청을 매핑하는 방법으로 응답 정보에 포함됩니다. |
| OData-MaxVersion |
"4.0" |
클라이언트에서 지원하는 OData 프로토콜의 최대 버전을 지정합니다. 기본값은 "4.0"입니다. |
| Prefer |
"return=representation" 또는 "return=minimal" |
PUT 및 POST /indexes 요청에서 응답 페이로드를 제어하는 데 사용됩니다. 기본값은 POST 또는 PUT을 통해 새 인덱스 생성 시 "return=representation"이고 PUT를 통해 기존 인덱스 업데이트를 위한 "return=minimal"입니다. |
| 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 |
호출자가 원래 요청을 통해 지정한 식별자입니다(있는 경우). |
| 콘텐츠 형식 |
콘텐츠 형식 |
응답 본문의 콘텐츠 형식입니다. |
| 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 Search REST API