Gyakori HTTP-kérés- és válaszfejlécek (Azure AI Search)
Cikk
Az Azure AI Search REST API-k számos gyakori HTTP-kérés-/válaszfejlécet támogatnak, amelyek összefoglalását itt találja:
Kérelem fejléce
Típus
Description
Elfogadás
Tartalomtípus
A válasz kért tartalomtípusa. Az alapértelmezett érték az application/json; odata.metadata=minimal. Egyéb engedélyezett értékek: application/json, application/json; odata.metadata=full, application/json; odata.metadata=none és text/plain (csak $count esetén).
A kérés OAuth 2.0 hozzáférési jogkivonata. A szerepköralapú hozzáféréshez konfigurálni kell a keresési szolgáltatást. Ez a kérésfejléc olyan ügyfélalkalmazásokhoz készült, amelyek Microsoft Entra ID hitelesítést és szerepkör-hozzárendeléseket használnak. Az ügyfélkódnak meg kell adnia a jogkivonatot. Ezt a kérésfejlécet bármilyen támogatott REST API-verzióval használhatja, ha a keresési szolgáltatás konfigurálva van az adatsík-hitelesítéshez.
Content-Type
Content-Type
A kérelem törzsének tartalomtípusa (PUT/POST). Az alapértelmezett szint a application/json.
client-request-id
GUID
Nem kötelező hívó által megadott kérésazonosító, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel (például client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Egy hívó által definiált érték, amely azonosítja az adott kérést. Ha meg van adva, ez az érték szerepel a válaszinformációkban a kérés leképezésének módjaként.
OData-MaxVersion
"4.0"
Az ügyfél által támogatott OData protokoll maximális verzióját adja meg. Az alapértelmezett érték a "4.0"
Inkább
"return=representation" vagy "return=minimal"
A PUT és POST /indexes kérelmek válasz hasznos adatainak szabályozására szolgál. Az alapértelmezett érték a "return=representation", amikor új indexet hoz létre POST vagy PUT használatával, a "return=minimal" pedig egy meglévő index PUT-en keresztüli frissítéséhez.
return-client-request-id
Igaz vagy Hamis
Ha az ügyfél-kérelem-azonosító megadásakor van megadva, utasítja a kiszolgálót, hogy foglalja bele a client-request-id fejlécet a válaszba. Az alapértelmezett érték Hamis.
If-Match
ETag vagy *
Erőforrás csak akkor módosítható, ha az aktuális verzió megfelel a megadott ETagnek. Használja ezt a fejlécet POST, PUT vagy DELETE metódusokkal erőforrásokon (például indexelőken, indexeken és adatforrásokon, de dokumentumokon nem) az optimista egyidejűség-vezérlés engedélyezéséhez.
If-None-Match
ETag vagy *
Az erőforrás csak akkor módosítható, ha az aktuális verzió nem egyezik meg a megadott ETag-el. Használja ezt a fejlécet POST, PUT vagy DELETE metódusokkal erőforrásokon (például indexelőken, indexeken és adatforrásokon, de dokumentumokon nem) az optimista egyidejűség-vezérlés engedélyezéséhez.
Válaszfejléc
Típus
Description
client-request-id
GUID
A hívó által az eredeti kérelemben megadott azonosító, ha van ilyen.
Content-Type
Content-Type
A válasz törzsének tartalomtípusa.
Hely
URL-cím
A POST és PUT /indexes kérelmek újonnan létrehozott indexdefiníciójának URL-címe.
OData-Version
"4.0"
A válasz OData protokollverziója.
request-id
GUID
Az aktuális művelet egyedi azonosítója. Ha meg van adva az ügyfél-kérelem-azonosító; ellenkező esetben az érték a kiszolgálón jön létre.
eltelt idő
Szám
Ezredmásodpercben eltelt idő, amelyet a szolgáltatás a kérés feldolgozásával töltött. Ez az érték csak a kérelem feldolgozására fordított időt tartalmazza, és nem tartalmazza a hálózatátviteli időt.
Etag
Sztring
Egy erőforrás aktuális verzióját jelölő átlátszatlan sztring (indexelők, indexek és adatforrások esetén, dokumentumokhoz azonban nem). Használja ezt a sztringet a If-Match vagy az If-None-Match fejlécben az optimista egyidejűség-vezérléshez.