Keresési dokumentum (Azure AI Search REST API)

  • Cikk

A Dokumentum keresése művelet lekéri a dokumentumot az Azure AI Search szolgáltatásból. Ez akkor hasznos, ha egy felhasználó egy adott keresési eredményre kattint, és meg szeretné keresni a dokumentum részleteit. Egyszerre csak egy dokumentumot kérhet le. A Dokumentumok keresése funkcióval több dokumentumot is lekérhet egyetlen kérelemben.

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

Másik lehetőségként használhatja a hagyományos OData szintaxist a kulcskereséshez:

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

URI-paraméterek

Paraméter Leírás
szolgáltatásnév Kötelező. Állítsa be ezt a keresési szolgáltatás egyedi, felhasználó által megadott nevére.
index neve Kötelező. A kérelem URI-ja határozza meg a lekérdezendő index nevét. A lekérdezési paraméterek a GET-kérések lekérdezési sztringjében és a POST-kérések kérelemtörzsében vannak megadva.
kulcs Kötelező. Egy Edm.String érték, amely egyedileg azonosítja az indexben lévő összes dokumentumot. A kulcsot néha dokumentumazonosítónak is nevezik. A kulcs értéke megkülönbözteti a kis- és nagybetűk értékét. Az "abc" kulccsal rendelkező dokumentumok például különböznek az "ABC" kulccsal rendelkező dokumentumoktól.
lekérdezési paraméterek Többrészes konstrukció, amely tartalmaz egy $select (nem kötelező) és api-version=2020-06-30 (kötelező) konstrukciót. Ehhez a művelethez az API-verzió lekérdezési paraméterként van megadva.
$select=[string] A a beolvasandó vesszővel tagolt mezők listája. Ebben a záradékban csak lekérdezhetőként megjelölt mezők vehetők fel. Ha nincs meghatározva vagy értékre *van állítva, akkor a sémában lekérdezhetőként megjelölt összes mező szerepel a leképezésben.

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Mezők Description
Content-Type Kötelező. Állítsa ezt a következőre: application/json
api-key Nem kötelező , ha Azure-szerepköröket használ, és egy tulajdonosi jogkivonatot ad meg a kéréshez, ellenkező esetben kulcsra van szükség. Az API-kulcs egy egyedi, rendszer által létrehozott sztring, amely hitelesíti a keresési szolgáltatásnak küldött kérést. Az objektumdefiníciók kéréseinek tartalmazniuk kell a rendszergazdai kulcsra beállított API-kulcs mezőt (a lekérdezési kulcs helyett). A részletekért lásd: Csatlakozás az Azure AI Searchhöz kulcshitelesítés használatával .

Kérelem törzse

Nincsenek.

Reagálás

Állapotkód: Sikeres válasz esetén a rendszer "200 OK" értéket ad vissza.

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

Példák

Keresse meg a "2" kulcsot tartalmazó dokumentumot:

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

Keresse meg a "3" kulcsot tartalmazó dokumentumot az OData szintaxis használatával:

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

Lásd még