Vanliga HTTP-begärande- och svarshuvuden (Azure AI Search)
Artikel
REST-API:erna för Azure AI Search stöder en uppsättning vanliga HTTP-begärande-/svarshuvuden som sammanfattas här som referens:
Begärandehuvud
Typ
Description
Acceptera
Innehållstyp
Den begärda innehållstypen för svaret. Standard är application/json; odata.metadata=minimal. Andra tillåtna värden är application/json, application/json; odata.metadata=full, application/json; odata.metadata=none och text/plain (endast för $count).
OAuth 2.0-åtkomsttoken för begäran. Kräver konfiguration av söktjänsten för rollbaserad åtkomst. Det här begärandehuvudet är för klientappar som använder Microsoft Entra ID autentiserings- och rolltilldelningar. Klientkoden måste ange token. Du kan använda det här begärandehuvudet med valfri REST API-version som stöds så länge söktjänsten har konfigurerats för autentisering med dataplanet.
Content-Type
Content-Type
Innehållstyp för begärandetext (PUT/POST). Standardvärdet är application/json.
client-request-id
GUID
Valfritt uppringarens angivna begärande-ID, i form av ett GUID utan dekoration, till exempel klammerparenteser (till exempel client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Ett anroparde värde som identifierar den angivna begäran. Om det här värdet anges inkluderas det i svarsinformationen som ett sätt att mappa begäran.
OData-MaxVersion
"4.0"
Anger den maximala versionen av OData-protokollet som stöds av klienten. Standardvärdet är "4.0"
Föredrar
"return=representation" eller "return=minimal"
Används för att styra svarsnyttolasten från PUT- och POST/index-begäranden. Standardvärdet är "return=representation" när du skapar ett nytt index via POST eller PUT och "return=minimal" för uppdatering av ett befintligt index via PUT.
return-client-request-id
Sant eller falskt
Om det anges när client-request-id anges instruerar du servern att inkludera huvudet client-request-id i svaret. Standardvärdet är Falskt.
If-Match
ETag eller *
Används endast för att ändra en resurs om den aktuella versionen matchar angiven ETag. Använd det här huvudet med POST-, PUT- eller DELETE-metoder för resurser (till exempel indexerare, index och datakällor, men inte dokument) för att aktivera optimistisk samtidighetskontroll.
If-None-Match
ETag eller *
Används endast för att ändra en resurs om den aktuella versionen inte matchar angiven ETag. Använd det här huvudet med POST-, PUT- eller DELETE-metoder för resurser (till exempel indexerare, index och datakällor, men inte dokument) för att aktivera optimistisk samtidighetskontroll.
Svarshuvud
Typ
Description
client-request-id
GUID
En identifierare som anges av anroparen i den ursprungliga begäran, om den finns.
Content-Type
Content-Type
Svarstextens innehållstyp.
Location
URL
URL:en för den nyligen skapade indexdefinitionen för POST- och PUT/index-begäranden.
OData-Version
"4.0"
OData-protokollversion av svaret.
request-id
GUID
En unik identifierare för den aktuella åtgärden. Lika med client-request-id om det anges. annars genereras värdet på servern.
förfluten tid
Tal
Tid, i millisekunder, som tjänsten spenderade på att bearbeta begäran. Det här värdet inkluderar bara den tid som ägnas åt att bearbeta begäran och inkluderar inte tiden för nätverksöverföring.
Etag
Sträng
En täckande sträng som representerar den aktuella versionen av en resurs (returneras för indexerare, index och datakällor, men inte dokument). Använd den här strängen i If-Match- eller If-None-Match-huvudet för optimistisk samtidighetskontroll.