Documents - Get

Szolgáltatás:: Search Service

API-verzió:: 2026-08-01-preview

Lekér egy dokumentumot az indexből.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-08-01-preview

Opcionális paraméterekkel:

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának 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 minLength: 1	A művelethez használni kívánt API-verzió.
$select	query		string[]	A dokumentumhoz beolvasandó mezőnevek listája; A nem lekért mezők hiányoznak a visszaadott dokumentumból.

Kérelem fejléce

Név	Típus	Description
x-ms-client-request-id	string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept	Accept	Az Elfogadás fejléce.
x-ms-query-source-authorization	string	A lekérdezés végrehajtásához használt felhasználót azonosító jogkivonat. Ez a jogkivonat a dokumentumokra vonatkozó biztonsági korlátozások érvényesítésére szolgál.
x-ms-enable-elevated-read	boolean	Olyan érték, amely lehetővé teszi az emelt szintű olvasást, amely megkerüli a dokumentumszintű engedélyellenőrzéseket a lekérdezési művelethez.

Válaszok

Név	Típus	Description
200 OK	LookupDocument	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchIndexGetDocument

Mintakérelem

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?api-version=2026-08-01-preview&$select=id,description,name,category,ownerId

Mintaválasz

Állapotkód:: 200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.