Documents - Get

Služba:
Search Service
Verze rozhraní API:
2024-05-01-preview

Načte dokument z indexu.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-05-01-preview
S volitelnými parametry: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-05-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í pro načtení dokumentu; V vrácených dokumentech nebude chybět žádné pole, které se nenačte.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

ID sledování odeslané s požadavkem, které vám pomůže s laděním.

Odpovědi

Name Typ Description
200 OK

LookupDocument

Odpověď obsahující požadovaný dokument.
Other Status Codes

ErrorResponse

Chybová odpověď.

Příklady

SearchIndexGetDocument

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Definice

Name Description
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Chybová odpověď

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.