Documents - Get

Služba:: Search Service

Verze rozhraní API:: 2025-05-01-preview

Načte dokument z indexu.

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

S volitelnými parametry:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-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.
x-ms-query-source-authorization		string	Token identifikující uživatele, pro kterého je dotaz prováděn. Tento token se používá k vynucení bezpečnostních omezení dokumentů.

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

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

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.