Documents - Get

Hiermee haalt u een document op uit de index.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
key	path	True	string	De sleutel van het document dat moet worden opgehaald.
api-version	query	True	string	Client-API-versie.
$select	query		string[]	Lijst met veldnamen die moeten worden opgehaald voor het document; Een veld dat niet wordt opgehaald, ontbreekt in het geretourneerde document.

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Name	Type	Description
200 OK	LookupDocument	Antwoord met het aangevraagde document.
Other Status Codes	SearchError	Foutreactie.

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"
}

Object

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
message	string	Een leesbare weergave van de fout.