Uppslagsdokument (REST API för Azure AI Search)

  • Artikel

Åtgärden Uppslagsdokument hämtar ett dokument från Azure AI Search. Detta är användbart när en användare klickar på ett specifikt sökresultat och du vill söka efter specifik information om dokumentet. Du kan bara hämta ett dokument i taget. Använd Sök dokument för att hämta flera dokument i en enda begäran.

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

Du kan också använda den traditionella OData-syntaxen för nyckelsökning:

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

URI-parametrar

Parameter Beskrivning
tjänstnamn Krävs. Ange det unika, användardefinierade namnet på söktjänsten.
indexnamn Krävs. Begärande-URI anger namnet på indexet som ska frågas. Frågeparametrar anges i frågesträngen för GET-begäranden och i begärandetexten för POST-begäranden.
key Krävs. Ett Edm.String värde som unikt identifierar varje dokument i indexet. Nyckeln kallas ibland för ett dokument-ID. Värdet för nyckeln är skiftlägeskänsligt. Ett dokument med nyckeln "abc" skiljer sig till exempel från ett dokument med nyckeln "ABC".
frågeparametrar En flerdelad konstruktion som innehåller en $select (valfritt) och api-version=2020-06-30 (obligatoriskt). För den här åtgärden anges API-versionen som en frågeparameter.
$select=[string] är en lista över kommaavgränsade fält som ska hämtas. Endast fält som har markerats som hämtningsbara kan tas med i den här satsen. Om det är ospecificerat eller inställt på *inkluderas alla fält som markerats som hämtningsbara i schemat i projektionen.

Rubriker för begäran

I följande tabell beskrivs de obligatoriska och valfria begärandehuvudena.

Fält Description
Content-Type Krävs. Ange detta till application/json
api-key Valfritt om du använder Azure-roller och en ägartoken anges i begäran, annars krävs en nyckel. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till söktjänsten. Hämta begäranden om en objektdefinition måste innehålla ett api-nyckelfält som är inställt på din administratörsnyckel (till skillnad från en frågenyckel). Mer information finns i Ansluta till Azure AI Search med nyckelautentisering .

Begärandetext

Inga.

Svarsåtgärder

Statuskod: "200 OK" returneras för ett lyckat svar.

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

Exempel

Leta upp dokumentet med nyckeln "2":

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

Leta upp dokumentet med nyckeln "3" med OData-syntax:

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

Se även