Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
REST API Azure AI Search podporují sadu běžných HTTP hlaviček požadavků/odpovědí, které jsou zde shrnuty pro referenci:
| Hlavička požadavku | Typ | Description |
|---|---|---|
| Přijmout | Typ obsahu | Požadovaný typ obsahu pro odpověď. Výchozí 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). |
| API klíč | String | Nastavte si dotazovací nebo administrátorský klíč, podle API. |
| autorizace | String | Přístupový token OAuth 2.0 pro požadavek. Vyžaduje konfiguraci pro vyhledávací službu pro přístup založený na rolích. Tato hlavička požadavku je určena pro klientské aplikace, které používají autentizaci a přiřazení rolí pomocí Microsoft Entra ID. Váš klientský kód musí poskytnout token. Tuto hlavičku požadavku můžete použít s jakoukoli podporovanou verzí REST API, pokud je vyhledávací služba nakonfigurována pro autentizaci v datové rovině. |
| Typ obsahu | Typ obsahu | Typ těla požadavku (PUT/POST). Musí být nastaveno na aplikaci/json. |
| ID požadavku klienta | GUID | Volitelný ID požadavku specifikovaný volajícím, ve formě GUID bez ozdob, jako jsou kudrnaté 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 specifikována, je zahrnuta v informacích o odpovědi jako způsob mapování požadavku. |
| OData-MaxVersion | "4.0" | Specifikuje maximální verzi protokolu OData podporovanou klientem. Výchozí nastavení je "4.0" |
| Upřednostňovat | "return=representation" nebo "return=minimal" | Používá se ke kontrole payloadu z PUT a POST /indexes požadavků. Výchozí je "return=representation" při vytváření nového indexu přes POST nebo PUT a "return=minimal" při aktualizaci stávajícího indexu přes PUT. |
| return-client-request-id | Pravda nebo Nepravda | Pokud je při specifikaci client-request-id specifikováno, instruuje server, aby do odpovědi zahrnul hlavičku client-request-id. Výchozí hodnota je False. |
| If-Match | ETag nebo * | Používá se ke změně zdroje pouze tehdy, pokud aktuální verze odpovídá specifikovanému ETag. Použijte tuto hlavičku s metodami POST, PUT nebo DELETE na zdrojích (jako jsou indexery, indexy a datové zdroje, ale ne dokumenty) pro umožnění optimistické kontroly souběžnosti. |
| If-None-Match | ETag nebo * | Používal se ke změně zdroje pouze tehdy, pokud aktuální verze neodpovídá specifikovanému ETag. Použijte tuto hlavičku s metodami POST, PUT nebo DELETE na zdrojích (jako jsou indexery, indexy a datové zdroje, ale ne dokumenty) pro umožnění optimistické kontroly souběžnosti. |
| Hlavička odezvy | Typ | Description |
|---|---|---|
| ID požadavku klienta | GUID | Identifikátor určený volajícím v původním požadavku, pokud je přítomen. |
| Typ obsahu | Typ obsahu | Typ obsahu těla odpovědi. |
| Umístění | URL | URL nově vytvořené definice indexu pro požadavky POST a PUT /indexes. |
| OData-Version | "4.0" | Verze odpovědi podle protokolu OData. |
| request-id | GUID | Jedinečný identifikátor aktuální operace. Rovná se client-request-id, pokud je specifikováno; jinak je hodnota generována na serveru. |
| uplynulý čas | Number | Č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 v síti. |
| ETag | String | Neprůhledný řetězec reprezentující aktuální verzi zdroje (vrácený pro indexery, indexy a datové zdroje, ale ne pro dokumenty). Použijte tento řetězec v hlavičce If-Match nebo If-None-Match pro optimickou kontrolu souběžnosti. |