Documents - Get

서비스:

Search Service

API 버전:

2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-07-01

선택적 매개 변수:

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

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	ErrorResponse	오류 응답입니다.

예제

SearchIndexGetDocument

샘플 요청

HTTP

GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

샘플 응답

상태 코드:

200

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

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.