Gyakori HTTP kérés- és válaszfejlécek (Azure AI Search)

Az Azure AI Search REST API-k támogatnak egy halmazt gyakori HTTP kérés/válasz fejléceket, amelyeket itt összefoglalnak referenciaként:

Kérelem fejléce Típus Description
Elfogadás Tartalomtípus A válaszhoz kért tartalomtípus. Az alapértelmezett az application/json; odata.metadata=minimal. További engedélyezett értékek: application/json, application/json; odata.metadata=full, application/json; odata.metadata=none, és text/plain (csak $count esetén).
API kulcs Lánc Állítsd be a lekérdezésedet vagy admin kulcsodat, az API-tól függően.
engedélyezés Lánc Az OAuth 2.0 hozzáférési tokent a kéréshez. Konfigurációt igényel a keresőszolgáltatásban a szerep-alapú hozzáféréshez. Ez a kérésfejléc olyan kliens alkalmazásokhoz való, amelyek Microsoft Entra ID hitelesítést és szerepleosztást használnak. Az ügyfél kódjának meg kell adnia a tokent. Ezt a kérés fejlécét bármelyik támogatott REST API verzióval használhatod, amennyiben a keresőszolgáltatás adatsík hitelesítésre van konfigurálva.
Tartalom típusa Tartalom típusa A kérelmező tartalomtípusa (PUT/POST). Be kell állítani application/json-ra.
ügyfél-kérés-azonosító GUID Opcionálisan hívó által meghatározott kérésazonosító, GUID formájában, díszítés nélkül, például göndör fogszabályzókkal (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 ez az érték megadja a válaszinformációt, hogy leképezze a kérést.
OData-MaxVersion "4.0" Megadja az ügyfél által támogatott OData protokoll maximális változatát. Az alapértelmezett "4.0"
Előnyben részesít "return=reprezentáció" vagy "return=minimum" A válaszraher vezérlésére szolgál a PUT és POST /indexes kérések esetén. Az alapértelmezett "return=representation" új indexek létrehozásához POST vagy PUT segítségével, míg a meglévő index frissítése esetén a "return=minimum" a PUT segítségével.
return-client-request-id Igaz vagy Hamis Ha megadja a client-request-id megadását, utasítja a szervert, hogy a client-request-id fejlécét foglalja be a válaszba. Az alapértelmezett érték hamis.
If-Match ETag vagy * Csak akkor vált egy erőforrást, ha a jelenlegi verzió megegyezik a megadott ETag-nal. Ezt a fejlécet használd POST, PUT vagy DELETE módszerekkel az erőforrásokon (például indexelők, indexek és adatforrások, de nem dokumentumok), hogy optimista egyidejű vezérlést biztosíts.
Ha-None-Match ETag vagy * Csak akkor váltottam egy erőforrást, ha a jelenlegi verzió nem egyezik meg a megadott ETag-tal. Ezt a fejlécet használd POST, PUT vagy DELETE módszerekkel az erőforrásokon (például indexelők, indexek és adatforrások, de nem dokumentumok), hogy optimista egyidejű vezérlést biztosíts.
Válaszfejléc Típus Description
ügyfél-kérés-azonosító GUID Egy azonosító, amelyet a hívó az eredeti kérésben megad, ha jelen van.
Tartalom típusa Tartalom típusa A választest tartalmának típusa.
Elhelyezkedés URL Az újonnan létrehozott POST és PUT index-definíció URL-je /indexes kérésekhez.
OData-Version "4.0" Az OData protokoll válasz verziója.
request-ID GUID Egy egyedi azonosító a jelenlegi művelethez. Megegyezik a client-request-id-vel, ha van megadva; egyébként az értéket a szerveren generálják.
Lejárt idő Szám Milliszekundumokban meghatározott idő, amit a szolgáltatás a kérés feldolgozásával töltött. Ez az érték csak a kérés feldolgozására fordított időt tartalmazza, és nem tartalmazza a hálózati átviteli időt.
ETag Lánc Egy átlátszatlan string, amely az erőforrás aktuális verzióját képviseli (indexelők, indexek és adatforrások esetén visszaadva, de nem dokumentumoknál). Használd ezt a sorozatot a If-Match vagy az If-None-Match fejlécben optimista párhuzamos vezérléshez.

Lásd még

Azure AI Search REST API-k

  • Utolsó frissítés időpontja: