Documents - Get

인덱스에서 문서를 검색합니다.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-10-01-Preview

선택적 매개 변수:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-10-01-Preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
indexName	path	True	string	인덱스의 이름입니다.
key	path	True	string	검색할 문서의 키입니다.
api-version	query	True	string	클라이언트 API 버전.
$select	query		string[]	문서에 대해 검색할 필드 이름 목록입니다. 검색되지 않은 모든 필드가 반환된 문서에서 누락됩니다.

Name	필수	형식	Description
x-ms-client-request-id		string uuid	디버깅에 도움이 되는 요청과 함께 전송된 추적 ID입니다.

Name	형식	Description
200 OK	LookupDocument	요청된 문서를 포함하는 응답입니다.
Other Status Codes	SearchError	오류 응답입니다.

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-10-01-Preview

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

API의 오류 조건에 대해 설명합니다.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	SearchError[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.