Documents - Get

Service:

Search Service

API-versie:

2024-07-01

Hiermee haalt u een document op uit de index.

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

Met optionele parameters:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-07-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 is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

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

Voorbeelden

SearchIndexGetDocument

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.