조회 문서(Azure AI Search REST API)

  • 아티클

문서 조회 작업은 Azure AI Search에서 문서를 검색합니다. 사용자가 특정 검색 결과를 클릭할 때 해당 문서에 대한 특정 세부 정보를 조회하려는 경우 이 작업을 사용하면 유용합니다. 한 번에 하나의 문서만 가져올 수 있습니다. 문서 검색을 사용하여 단일 요청에서 여러 문서를 가져옵니다.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

기존 OData 구문을 키 조회에 사용할 수도 있습니다.

GET /indexes/[index name]/docs('[key]')?[query parameters]

URI 매개 변수

매개 변수 Description
서비스 이름 필수 사항입니다. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다.
인덱스 이름 필수 사항입니다. 요청 URI는 쿼리할 인덱스의 이름을 지정합니다. 쿼리 매개 변수는 GET 요청에 대한 쿼리 문자열 및 POST 요청에 대한 요청 본문에 지정됩니다.
key 필수 사항입니다. Edm.String 인덱스의 각 문서를 고유하게 식별하는 값입니다. 키는 문서 ID라고도 합니다. 키 값은 대/소문자를 구분합니다. 예를 들어 키 "abc"가 있는 문서는 "ABC" 키가 있는 문서와 다릅니다.
쿼리 매개 변수(query parameter) (선택 사항) 및 api-version=2020-06-30 (필수)를 포함하는 $select 다중 파트 생성입니다. 이 작업에서 api-version은 쿼리 매개 변수로 지정됩니다.
$select=[string] 는 검색할 쉼표로 구분된 필드 목록입니다. 검색 가능으로 표시된 필드만 이 절에 포함할 수 있습니다. 지정하지 않거나 *로 지정하면 스키마에서 검색 가능으로 표시된 모든 필드가 프로젝션에 포함됩니다.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

필드 Description
콘텐츠 형식 필수 사항입니다. application/json
api-key Azure 역할을 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항이며, 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 개체 정의에 대한 가져오기 요청에는 쿼리 키가 아닌 관리자 키로 설정된 api-key 필드가 포함되어야 합니다. 자세한 내용은 키 인증을 사용하여 Azure AI Search에 연결을 참조하세요.

요청 본문

없음

응답

상태 코드: 성공적인 응답을 위해 "200 OK"가 반환됩니다.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

예제

'2' 키를 포함하는 문서 조회

GET /indexes/hotels/docs/2?api-version=2020-06-30

OData 구문을 사용하여 '3' 키가 있는 문서 조회

GET /indexes/hotels/docs('3')?api-version=2020-06-30

추가 정보