Běžné hlavičky požadavků HTTP a odpovědí (Azure AI Search)
Článek
Rozhraní REST API služby Azure AI Search podporují sadu běžných hlaviček požadavků a odpovědí HTTP, které jsou shrnuté tady pro referenci:
Hlavička požadavku
Typ
Description
Přijmout
Typ obsahu
Požadovaný typ obsahu pro odpověď. Výchozí hodnota je application/json; odata.metadata=minimal. Další povolené hodnoty jsou application/json, application/json; odata.metadata=full, application/json; odata.metadata=none a text/plain (pouze pro $count).
Přístupový token OAuth 2.0 pro požadavek. Vyžaduje konfiguraci vyhledávací služby pro přístup na základě role. Tato hlavička požadavku je určená pro klientské aplikace, které používají ověřování Microsoft Entra ID a přiřazení rolí. Kód klienta musí poskytnout token. Tuto hlavičku požadavku můžete použít s libovolnou podporovanou verzí rozhraní REST API, pokud je vyhledávací služba nakonfigurovaná pro ověřování roviny dat.
Typ obsahu
Typ obsahu
Typ obsahu textu požadavku (PUT/POST). Výchozí je application/json.
client-request-id
Identifikátor GUID
Volitelné ID požadavku zadaného volajícím ve formě identifikátoru GUID bez dekorací, jako jsou složené závorky (například client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Hodnota definovaná volajícím, která identifikuje daný požadavek. Pokud je tato hodnota zadaná, zahrne se do informací o odpovědi jako způsob mapování požadavku.
OData-MaxVersion
"4.0"
Určuje maximální verzi protokolu OData podporovanou klientem. Výchozí hodnota je 4.0.
Dávají přednost
"return=representation" nebo "return=minimal"
Slouží k řízení datové části odpovědi z požadavků PUT a POST /indexes. Výchozí hodnota je return=representation při vytváření nového indexu přes POST nebo PUT a "return=minimal" pro aktualizaci existujícího indexu prostřednictvím PUT.
return-client-request-id
Pravda nebo Nepravda
Pokud je zadáno při zadání client-request-id, dá serveru pokyn, aby do odpovědi zahrnul hlavičku client-request-id. Výchozí hodnota je False.
If-Match
Značka ETag nebo *
Používá se ke změně prostředku pouze v případě, že aktuální verze odpovídá zadané eTag. Tuto hlavičku použijte u metod POST, PUT nebo DELETE u prostředků (jako jsou indexery, indexy a zdroje dat, ale ne dokumenty) k povolení optimistického řízení souběžnosti.
If-None-Match
Značka ETag nebo *
Používá se ke změně prostředku pouze v případě, že aktuální verze neodpovídá zadané eTag. Tuto hlavičku použijte u metod POST, PUT nebo DELETE u prostředků (jako jsou indexery, indexy a zdroje dat, ale ne dokumenty) k povolení optimistického řízení souběžnosti.
Hlavička odpovědi
Typ
Description
client-request-id
Identifikátor GUID
Identifikátor určený volajícím v původním požadavku, pokud existuje.
Typ obsahu
Typ obsahu
Typ obsahu textu odpovědi.
Umístění
URL
Adresa URL nově vytvořené definice indexu pro požadavky POST a PUT /indexes.
OData-Version
"4.0"
Verze protokolu OData odpovědi.
id požadavku
Identifikátor GUID
Jedinečný identifikátor aktuální operace. Je rovno client-request-id, pokud je zadáno. v opačném případě se hodnota vygeneruje na serveru.
uplynulý čas
Číslo
Čas v milisekundách, který služba strávila zpracováním požadavku. Tato hodnota zahrnuje pouze čas strávený zpracováním požadavku a nezahrnuje čas přenosu ze sítě.
Etag
Řetězec
Neprůžný řetězec představující aktuální verzi prostředku (vrácený pro indexery, indexy a zdroje dat, ale ne pro dokumenty). Tento řetězec použijte v hlavičce If-Match nebo If-None-Match pro řízení optimistické souběžnosti.