Opzoekdocument (Azure AI Search REST API)
Met de bewerking Opzoekdocument wordt een document opgehaald uit Azure AI Search. Dit is handig wanneer een gebruiker op een specifiek zoekresultaat klikt en u specifieke details over dat document wilt opzoeken. U kunt slechts één document tegelijk krijgen. Gebruik Documenten doorzoeken om meerdere documenten in één aanvraag op te halen.
GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]
Content-Type: application/json
api-key: [admin or query key]
U kunt ook de traditionele OData-syntaxis gebruiken voor het opzoeken van sleutels:
GET /indexes/[index name]/docs('[key]')?[query parameters]
URI-parameters
| Parameter | Beschrijving |
|---|---|
| servicenaam | Vereist. Stel deze in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice. |
| indexnaam | Vereist. De aanvraag-URI geeft de naam op van de index die moet worden opgevraagd. Queryparameters worden opgegeven in de queryreeks voor GET-aanvragen en in de aanvraagbody voor POST-aanvragen. |
| sleutel | Vereist. Een Edm.String waarde die elk document in de index uniek identificeert. De sleutel wordt ook wel een document-id genoemd. De waarde van de sleutel is hoofdlettergevoelig. Een document met de sleutel 'abc' is bijvoorbeeld anders dan een document met de sleutel 'ABC'. |
| queryparameters | Een meerdelige constructie met een $select (optioneel) en api-version=2020-06-30 (vereist). Voor deze bewerking wordt de API-versie opgegeven als een queryparameter. $select=[string] is een lijst met door komma's gescheiden velden die moeten worden opgehaald. Alleen velden die zijn gemarkeerd als ophaalbaar, kunnen in deze component worden opgenomen. Als dit niet is opgegeven of is ingesteld op *, worden alle velden die zijn gemarkeerd als ophaalbaar in het schema opgenomen in de projectie. |
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
| Velden | Description |
|---|---|
| Content-Type | Vereist. Stel dit in op application/json |
| api-key | Optioneel als u Azure-rollen gebruikt en er een Bearer-token is opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Aanvragen voor een objectdefinitie moeten een api-sleutelveld bevatten dat is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie. |
Aanvraagbody
Geen.
Antwoord
Statuscode: '200 OK' wordt geretourneerd voor een geslaagd antwoord.
{
field_name: field_value (fields matching the default or specified projection)
}
Voorbeelden
Zoek het document met de sleutel '2' op:
GET /indexes/hotels/docs/2?api-version=2020-06-30
Zoek het document met de sleutel '3' op met behulp van de OData-syntaxis:
GET /indexes/hotels/docs('3')?api-version=2020-06-30