Dokument k vyhledávání (rozhraní REST API služby Azure AI Search)

  • Článek

Operace Vyhledat dokument načte dokument ze služby Azure AI Search. To je užitečné, když uživatel klikne na konkrétní výsledek hledání a vy chcete vyhledat konkrétní podrobnosti o daném dokumentu. Najednou můžete získat jenom jeden dokument. Pomocí funkce Prohledat dokumenty můžete získat více dokumentů v rámci jednoho požadavku.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Alternativně můžete pro vyhledávání klíčů použít tradiční syntaxi OData:

GET /indexes/[index name]/docs('[key]')?[query parameters]

Parametry identifikátoru URI

Parametr Popis
název služby Povinná hodnota. Nastavte ho na jedinečný, uživatelem definovaný název vaší vyhledávací služby.
název indexu Povinná hodnota. Identifikátor URI požadavku určuje název indexu, který se má dotazovat. Parametry dotazu se zadají v řetězci dotazu pro požadavky GET a v textu požadavku pro požadavky POST.
key Povinná hodnota. Hodnota Edm.String , která jednoznačně identifikuje každý dokument v indexu. Klíč se někdy označuje jako ID dokumentu. V hodnotě klíče se rozlišují malá a velká písmena. Například dokument s klíčem "abc" se liší od dokumentu s klíčem "ABC".
parametry dotazu Vícedílná konstrukce, která zahrnuje $select (volitelné) a api-version=2020-06-30 (povinné). Pro tuto operaci je api-version určena jako parametr dotazu.
$select=[string] je seznam polí oddělených čárkami, která se mají načíst. Tato klauzule může obsahovat pouze pole označená jako zobrazitelná. Pokud není zadáno nebo je nastaveno na *hodnotu , všechna pole označená jako zobrazitelná ve schématu se zahrnou do projekce.

Hlavičky požadavku

Následující tabulka popisuje požadovanou a volitelnou hlavičku požadavku.

Pole Description
Typ obsahu Povinná hodnota. Nastavte tuto možnost na application/json
klíč rozhraní API Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný, systémem vygenerovaný řetězec, který ověřuje požadavek na vaši vyhledávací službu. Požadavky na získání pro definici objektu musí obsahovat pole api-key nastavené na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče .

Text požadavku

Žádné

Odpověď

Pro úspěšnou odpověď se vrátí stavový kód 200 OK.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Příklady

Vyhledání dokumentu s klíčem "2":

GET /indexes/hotels/docs/2?api-version=2020-06-30

Vyhledejte dokument s klíčem 3 pomocí syntaxe OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Viz také