Import rozhraní API Azure OpenAI

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

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

Požadavky

  • Existující instance služby API Management. Vytvořte ho, pokud jste to ještě neudělali.

  • Prostředek Azure OpenAI s nasazeným modelem. Další informace o nasazení modelu najdete v tématu Průvodce nasazením prostředku.

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

  • 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 ze služby Azure OpenAI

Rozhraní API Azure OpenAI můžete importovat přímo ze služby Azure OpenAI Service 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ý prostředek a zásady back-endové služby, které směruje požadavky rozhraní API na koncový bod služby Azure OpenAI.
  • Zásady identity spravované ověřováním, které se můžou ověřit u prostředku Azure OpenAI pomocí identity přiřazené systémem instance.
  • (volitelně) Zásady, které vám pomůžou monitorovat a spravovat využití tokenů pomocí rozhraní API Azure OpenAI.

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

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. V nabídce vlevo v části Rozhraní API vyberte rozhraní API> + Přidat rozhraní API.

  3. V části Vytvořit z prostředku Azure vyberte Azure OpenAI Service.

    Snímek obrazovky s vytvořením rozhraní API ze služby Azure OpenAI na portálu

  4. Vyberte kartu 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í.

    3. Zadejte zobrazovaný název a volitelný popis 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ší.

  5. Na kartě Zásady volitelně povolte zásady pro monitorování a správu spotřeby tokenů rozhraní API Azure OpenAI. Pokud je tato možnost vybraná, zadejte nastavení nebo přijměte výchozí hodnoty, které definují azure-openai-token-limit zásady azure-openai-emit-token-metric pro vaše rozhraní API. Konfiguraci zásad můžete také nastavit nebo aktualizovat později. Vyberte Zkontrolovat a vytvořit.

  6. 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 2024-02-01.

  1. V textovém editoru otevřete stažený soubor specifikace.

  2. servers V prvku ve specifikaci nahraďte název koncového bodu služby Azure OpenAI v zástupných hodnotách url a default koncových bodech ve specifikaci. Pokud je contoso.openai.azure.comnapříklad koncový bod služby 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"
        }
      }
    }
  ],
[...]

  3. Poznamenejte si hodnotu rozhraní API version ve specifikaci. Budete ho potřebovat k otestování rozhraní API. Příklad: 2024-02-01.

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

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

Rozhraní API se naimportuje a zobrazí 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.

  1. Vyberte rozhraní API, které jste vytvořili v předchozím kroku.

  2. Vyberte kartu Test.

  3. 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í.

  4. V parametrech šablony zadejte následující hodnoty:

    • deployment-id – ID nasazení ve službě Azure OpenAI
    • api-version – platná verze rozhraní API Azure OpenAI, například verze rozhraní API, kterou jste vybrali při importu rozhraní API. Snímek obrazovky s testováním rozhraní API služby Azure OpenAI na portálu

  5. 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í konzole služba API Management automaticky naplní hlavičku klíče předplatného Ocp-Apim-Subscription-Key a nakonfiguruje klíč předplatného integrovaného předplatného s přístupem. 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.

  6. 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 rozhraní API Azure OpenAI. Snímek obrazovky s daty o využití tokenů v odpovědi rozhraní API na portálu

Zásady ukládání do mezipaměti pro rozhraní API Azure OpenAI

Kromě azure-openai-token-limit zásad, azure-openai-emit-token-metric které můžete nakonfigurovat při importu rozhraní API služby Azure OpenAI, poskytuje služba API Management následující zásady ukládání do mezipaměti, které vám pomůžou optimalizovat výkon a snížit latenci pro rozhraní API Azure OpenAI:

  • azure-openai-semantic-cache-store
  • azure-openai-semantic-cache-lookup

Související obsah