Documents - Get

Služba:

Search Service

Verze rozhraní API:

2023-10-01-Preview

Načte dokument z indexu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
key	path	True	string	Klíč dokumentu, který se má načíst.
api-version	query	True	string	Verze rozhraní API klienta.
$select	query		string[]	Seznam názvů polí, které se mají načíst pro dokument; Všechna pole, která se nenačtou, budou ve vrácených dokumentech chybět.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Odpovědi

Name	Typ	Description
200 OK	LookupDocument	Odpověď obsahující požadovaný dokument.
Other Status Codes	SearchError	Chybová odpověď.

Příklady

SearchIndexGetDocument

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

SearchError

Popisuje chybovou podmínku rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.