Algemene HEADERs van HTTP-aanvragen en -antwoorden (Azure AI Search)
Artikel
De AZURE AI Search REST API's ondersteunen een set algemene HTTP-aanvraag-/antwoordheaders, die hier ter referentie worden samengevat:
Aanvraagkoptekst
Type
Description
Accepteren
Inhoudstype
Het gevraagde inhoudstype voor het antwoord. De standaardwaarde is application/json; odata.metadata=minimal. Andere toegestane waarden zijn application/json, application/json; odata.metadata=full, application/json; odata.metadata=none en text/plain (alleen voor $count).
Het OAuth 2.0-toegangstoken voor de aanvraag. Vereist configuratie van uw zoekservice voor toegang op basis van rollen. Deze aanvraagheader is voor client-apps die gebruikmaken van Microsoft Entra ID verificatie en roltoewijzingen. Uw clientcode moet het token opgeven. U kunt deze aanvraagheader gebruiken met elke ondersteunde REST API-versie zolang de zoekservice is geconfigureerd voor gegevensvlakverificatie.
Content-Type
Content-Type
Inhoudstype van aanvraagbody (PUT/POST). De standaardinstelling is application/json.
client-request-id
GUID
Optionele aanroeper-opgegeven aanvraag-id, in de vorm van een GUID zonder decoratie, zoals accolades (bijvoorbeeld client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Een door de aanroeper gedefinieerde waarde die de opgegeven aanvraag identificeert. Indien opgegeven, wordt deze waarde opgenomen in de antwoordinformatie als een manier om de aanvraag toe te wijzen.
OData-MaxVersion
"4.0"
Hiermee geeft u de maximale versie van het OData-protocol dat wordt ondersteund door de client. De standaardwaarde is '4.0'
Liever
"return=representation" of "return=minimal"
Wordt gebruikt voor het beheren van de nettolading van het antwoord van PUT- en POST/indexes-aanvragen. De standaardinstelling is 'return=representation' bij het maken van een nieuwe index via POST of PUT, en 'return=minimal' voor het bijwerken van een bestaande index via PUT.
return-client-request-id
Waar of Niet waar
Indien opgegeven wanneer client-request-id is opgegeven, geeft de server de instructie om de header client-request-id in het antwoord op te nemen. De standaardwaarde is False.
If-Match
ETag of *
Wordt alleen gebruikt om een resource te wijzigen als de huidige versie overeenkomt met de opgegeven ETag. Gebruik deze header met de methoden POST, PUT of DELETE voor resources (zoals indexeerfuncties, indexen en gegevensbronnen, maar geen documenten) om optimistisch gelijktijdigheidsbeheer in te schakelen.
If-None-Match
ETag of *
Wordt alleen gebruikt om een resource te wijzigen als de huidige versie niet overeenkomt met de opgegeven ETag. Gebruik deze header met de methoden POST, PUT of DELETE voor resources (zoals indexeerfuncties, indexen en gegevensbronnen, maar geen documenten) om optimistisch gelijktijdigheidsbeheer in te schakelen.
Reactieheader
Type
Description
client-request-id
GUID
Een id die is opgegeven door de beller in de oorspronkelijke aanvraag, indien aanwezig.
Content-Type
Content-Type
Het inhoudstype van de antwoordtekst.
Locatie
URL
De URL van de zojuist gemaakte indexdefinitie voor POST- en PUT/indexes-aanvragen.
OData-Version
"4.0"
OData-protocolversie van het antwoord.
request-id
GUID
Een unieke id voor de huidige bewerking. Gelijk aan client-request-id indien opgegeven; anders wordt de waarde gegenereerd op de server.
verstreken tijd
Aantal
Tijd, in milliseconden, die de service heeft besteed aan het verwerken van de aanvraag. Deze waarde bevat alleen de tijd die is besteed aan het verwerken van de aanvraag en bevat geen netwerkoverdrachtstijd.
ETag
Tekenreeks
Een ondoorzichtige tekenreeks die de huidige versie van een resource vertegenwoordigt (geretourneerd voor indexeerfuncties, indexen en gegevensbronnen, maar niet voor documenten). Gebruik deze tekenreeks in de header If-Match of If-None-Match voor optimistisch gelijktijdigheidsbeheer.