Documents - Get

Lekéri a dokumentumot az indexből.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
indexName	path	True	string	Az index neve.
key	path	True	string	A lekérni kívánt dokumentum kulcsa.
api-version	query	True	string	Ügyfél API-verziója.
$select	query		string[]	A dokumentumhoz beolvasandó mezőnevek listája; A nem lekért mezők hiányoznak a visszaadott dokumentumból.

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Name	Típus	Description
200 OK	LookupDocument	A kért dokumentumot tartalmazó válasz.
Other Status Codes	SearchError	Hibaválasz.

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

Tárgy

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba ember által olvasható ábrázolása.