Import rozhraní API Azure OpenAI jako rozhraní REST API

  • Článek

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

Tento článek ukazuje, jak importovat rozhraní API Azure OpenAI do instance služby Azure API Management ze specifikace OpenAPI. Po importu rozhraní API jako rozhraní REST API ho můžete spravovat a zabezpečit a publikovat je vývojářům.

Požadavky

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

  • Přístup k Azure OpenAI je udělován v požadovaném předplatném Azure. Pokud chcete získat přístup k Azure OpenAI, vyplňte formulář na adrese https://aka.ms/oai/access. Pokud máte problém, otevřete problém v tomto úložišti a kontaktujte nás.

  • 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 nasazení (název). Budete ho potřebovat při testování importovaného rozhraní API ve službě API Management.

Stažení specifikace OpenAPI

Stáhněte si specifikaci OpenAPI pro koncový bod, který váš model podporuje. Stáhněte si například specifikaci OpenAPI pro koncový bod dokončení chatu modelů GPT-35-Turbo a GPT-4.

  1. V textovém editoru otevřete stažený soubor specifikace.
  2. servers V elementu ve specifikaci nahraďte názvem koncového bodu prostředku Azure OpenAI zástupné hodnoty ve specifikaci. Následující ukázkový servers prvek se aktualizuje pomocí koncového contoso.openai.azure.com bodu prostředku. 
    [...]
"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: 2023-05-15.

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 a zadejte příponu adresy URL rozhraní API.
  4. Vyberte Vytvořit.

Rozhraní API se naimportuje a zobrazí operace ze specifikace OpenAPI.

Testování nového rozhraní API na portálu

Operace je možné volat přímo z portálu, což správcům poskytuje pohodlný způsob zobrazení a testování operací rozhraní API.

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

  2. Vyberte kartu Test.

  3. Vyberte operaci. Stránka zobrazí pole pro parametry dotazu a pole pro hlavičky.

    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.

  4. V závislosti na operaci zadejte hodnoty parametrů dotazu, hodnoty hlaviček nebo text požadavku. Vyberte Odeslat.

    Když je test úspěšný, back-end odpoví úspěšným kódem odpovědi HTTP a některými daty.

    Tip

    Ve výchozím nastavení testovací konzola odešle požadavek na proxy SERVER CORS služby API Management, který požadavek předá instanci služby API Management, která ji pak předá back-endu. Tento proxy server používá veřejnou IP adresu 13.91.254.72 a může se připojit pouze k veřejným koncovým bodům. Pokud chcete odeslat požadavek přímo z prohlížeče do služby API Management, vyberte Obejít proxy server CORS. Tuto možnost použijte, pokud chcete použít testovací konzolu a brána služby API Management je izolovaná v síti nebo nepovoluje provoz z proxy serveru CORS.

Pokud chcete ladit rozhraní API, projděte si kurz : Ladění rozhraní API pomocí trasování požadavků.

Důležité

Ověřování rozhraní OpenAI API vyžaduje klíč rozhraní API nebo spravovanou identitu. Pokud chcete nakonfigurovat ověřování pomocí zásad služby API Management, přečtěte si téma Ověřování a autorizace pro rozhraní Azure OpenAI API.

Související obsah