Import rozhraní API Azure OpenAI

PLATÍ PRO: Všechny úrovně správy API

Koncové body modelu AI nasazené v Azure OpenAI v modelech Foundry můžete importovat do instance služby API Management jako rozhraní REST API. Pomocí zásad brány AI a dalších funkcí ve službě API Management můžete zjednodušit integraci, zlepšit pozorovatelnost a zlepšit kontrolu nad koncovými body modelu.

Tento článek ukazuje dvě možnosti importu rozhraní API Azure OpenAI do instance služby Azure API Management jako rozhraní REST API:

Import rozhraní API Azure OpenAI přímo z Azure OpenAI (doporučeno)
Stáhněte a přidejte specifikaci OpenAPI pro Azure OpenAI a přidejte ji do služby API Management jako rozhraní Api OpenAPI.

Další informace o správě rozhraní API AI ve službě API Management:

Možnosti brány AI ve službě Azure API Management

Požadavky

Existující instance služby API Management. Vytvořte ho, pokud jste to ještě neudělali.
Azure OpenAI prostředek s nasazeným modelem. Další informace o nasazení modelu v Azure OpenAI najdete v průvodci nasazením prostředků.

Poznamenejte si ID (název) nasazení. Budete ho potřebovat při testování importovaného rozhraní API ve službě API Management.

Poznámka:

Zásady služby API Management, jako jsou azure-openai-token-limit a azure-openai-emit-token-metric, jsou podporovány pro určité koncové body rozhraní API zveřejněné prostřednictvím specifických modelů Azure OpenAI. Další informace najdete v tématu Podporované modely Azure OpenAI.
Oprávnění k udělení přístupu k prostředku Azure OpenAI z instance služby API Management

Možnost 1. Import rozhraní API z Azure OpenAI

Rozhraní API Azure OpenAI můžete importovat přímo z Azure OpenAI do služby API Management.

Poznámka:

V současné době tato funkce není dostupná v pracovních prostorech.

Při importu rozhraní API služba API Management automaticky nakonfiguruje:

Operace pro každý koncový bod rozhraní REST API Azure OpenAI
Identita přiřazená systémem s potřebnými oprávněními pro přístup k prostředku Azure OpenAI.
Back-endový zdroj a politika pro nastavení služby back-endu, které směruje požadavky rozhraní API na koncový bod Azure OpenAI.
Ověřování back-endu Azure OpenAI pomocí spravované identity přiřazené systémem instance
(volitelně) Zásady, které vám pomůžou monitorovat a spravovat rozhraní API Azure OpenAI.

Import rozhraní API Azure OpenAI do služby API Management:

Na webu Azure Portal přejděte k vaší instanci služby API Management.
V nabídce vlevo v části APIs vyberte APIs>+ Přidat API.
V části Vytvořit z prostředku Azure vyberte Azure OpenAI.
Na kartě Základy:
1. Vyberte prostředek Azure OpenAI, který chcete importovat.
2. Volitelně vyberte verzi rozhraní API Azure OpenAI. Pokud ho nevyberete, použije se ve výchozím nastavení nejnovější verze rozhraní REST API připravená pro produkční prostředí. Poznamenejte si vybranou verzi. Budete ho potřebovat k otestování rozhraní API.
3. Zadejte zobrazovaný název a volitelný popis pro rozhraní API.
4. V základní adrese URL připojte cestu, kterou vaše instance SLUŽBY API Management používá pro přístup ke koncovým bodům rozhraní API Azure OpenAI. Pokud povolíte kompatibilitu sady OpenAI SDK (doporučeno), /openai připojí se k základní adrese URL automaticky.
  
  Pokud je https://contoso.azure-api.netnapříklad koncový bod brány služby API Management, nastavte základní adresu URL podobnou https://contoso.azure-api.net/my-openai-api/openai.
5. Volitelně vyberte jeden nebo více produktů, které chcete přidružit k rozhraní API. Vyberte Další.
Na kartě Zásady můžete volitelně povolit zásady, které vám pomůžou monitorovat a spravovat rozhraní API. Zásady můžete také nastavit nebo upravit později.

Pokud je tato možnost vybraná, zadejte nastavení nebo přijměte výchozí hodnoty, které definují následující zásady (podrobnosti o požadavcích a konfiguraci najdete v odkazovaných článcích):
Vyberte Zkontrolovat a vytvořit.
Po ověření nastavení vyberte Vytvořit.

Možnost 2. Přidání specifikace OpenAPI do služby API Management

Alternativně si ručně stáhněte specifikaci OpenAPI pro rozhraní REST API Azure OpenAI a přidejte ji do služby API Management jako rozhraní OpenAPI API.

Stažení specifikace OpenAPI

Stáhněte si specifikaci OpenAPI pro rozhraní REST API Azure OpenAI, například verzi GA z verze 2024-10-21.

V textovém editoru otevřete stažený soubor specifikace.
V prvku servers ve specifikaci nahraďte název koncového bodu Azure OpenAI ve specifikaci na zástupná místa url a default. Pokud je contoso.openai.azure.comnapříklad koncový bod Azure OpenAI, aktualizujte servers prvek následujícími hodnotami:
- url: https://contoso.openai.azure.com/openai
- výchozí koncový bod: contoso.openai.azure.com
```
[...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
```
Poznamenejte si hodnotu rozhraní API version ve specifikaci. Budete ho potřebovat k otestování rozhraní API. Příklad: 2024-10-21.

Přidání specifikace OpenAPI do služby API Management

Na webu Azure Portal přejděte k vaší instanci služby API Management.
V nabídce vlevo vyberte rozhraní API> + Přidat rozhraní API.
V části Definovat nové rozhraní API vyberte OpenAPI. Zadejte zobrazovaný název a název rozhraní API.
Zadejte příponu API URL končící /openai, abyste měli přístup ke koncovým bodům rozhraní API Azure OpenAI ve vaší instanci služby API Management. Příklad: my-openai-api/openai.
Vyberte Vytvořit.

Rozhraní API je importováno a jsou zobrazeny operace ze specifikace OpenAPI.

Konfigurace ověřování pro rozhraní Azure OpenAI API

Pokud se chcete ověřit v rozhraní API Azure OpenAI, zadejte klíč rozhraní API nebo spravovanou identitu. Pokud jste naimportovali rozhraní API Azure OpenAI přímo do instance služby API Management, ověřování pomocí spravované identity instance SLUŽBY API Management se nakonfiguruje automaticky.

Pokud jste přidali rozhraní API Azure OpenAI ze specifikace OpenAPI, musíte nakonfigurovat ověřování. Další informace o konfiguraci ověřování pomocí zásad služby API Management najdete v tématu Ověřování a autorizace v rozhraní API Azure OpenAI.

Testování rozhraní API Azure OpenAI

Pokud chcete zajistit, aby vaše rozhraní API Azure OpenAI fungovalo podle očekávání, otestujte ho v testovací konzole služby API Management. K otestování rozhraní API musíte zadat ID (název) nasazení modelu nakonfigurované v prostředku Azure OpenAI a verzi rozhraní API.

Vyberte rozhraní API, které jste vytvořili v předchozím kroku.
Vyberte kartu Test.
Vyberte operaci, která je kompatibilní s modelem, který jste nasadili v prostředku Azure OpenAI. Na stránce se zobrazí pole pro parametry a záhlaví.
V parametrech šablony zadejte následující hodnoty:
- deployment-id – ID nasazení v Azure OpenAI
- api-version – platná verze rozhraní API Azure OpenAI, například verze rozhraní API, kterou jste vybrali při importu rozhraní API.
Podle potřeby zadejte další parametry a hlavičky. V závislosti na operaci možná budete muset nakonfigurovat nebo aktualizovat text požadavku.

Poznámka:

V testovací konzoli systém Správa rozhraní API automaticky vyplňuje hlavičku Ocp-Apim-Subscription-Key a konfiguruje klíč předplatného pro vestavěné předplatné s úplným přístupem all-access subscription. Tento klíč umožňuje přístup ke každému rozhraní API v instanci služby API Management. Volitelně můžete zobrazit hlavičku Ocp-Apim-Subscription-Key výběrem ikony oka vedle požadavku HTTP.
Vyberte Odeslat.

Když je test úspěšný, back-end odpoví úspěšným kódem odpovědi HTTP a některými daty. Připojeno k odpovědi je data o využití tokenů, která vám pomůžou monitorovat a spravovat spotřebu tokenů rozhraní API Azure OpenAI.

Váš názor

Byla tato stránka užitečná?

Last updated on 2025-06-27