Documents - Get

Tjänst:

Search Service

API-version:

2024-07-01

Hämtar ett dokument från indexet.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
key	path	True	string	Nyckeln för dokumentet som ska hämtas.
api-version	query	True	string	Klient-API-version.
$select	query		string[]	Lista över fältnamn som ska hämtas för dokumentet. Alla fält som inte hämtas saknas i det returnerade dokumentet.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Svar

Name	Typ	Description
200 OK	LookupDocument	Svar som innehåller det begärda dokumentet.
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchIndexGetDocument

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.