Documents - Get

Service:

Search Service

API Version:

2023-11-01

Hiermee haalt u een document op uit de index.

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

With optional parameters:

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

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.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag wordt verzonden om te helpen bij foutopsporing.

Antwoorden

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

Voorbeelden

SearchIndexGetDocument

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definities

SearchError

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 tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.