Documents - Get

  • Reference
Service:
Search Service
API Version:
2023-11-01

Načte dokument z indexu.

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

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 nenačtené pole 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

Odpověď na chybu.

Příklady

SearchIndexGetDocument

Sample Request

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

Definice

SearchError

Popisuje chybový stav rozhraní API.

Name Typ Description
code

string

Jeden ze serverem definované sady kódů chyb.
details

SearchError[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message

string

Lidsky čitelná reprezentace chyby.