Importer une API Azure OpenAI en tant qu’API REST

  • Article

S’APPLIQUE À : tous les niveaux Gestion des API

Cet article explique comment importer une API Azure OpenAI dans une instance de Gestion des API Azure à partir de sa spécification OpenAPI. Après avoir importé l’API en tant qu’API REST, vous pouvez la gérer et la sécuriser, et la publier pour des développeurs.

Prérequis

  • Disposer d’une instance d’API Management. Si vous ne l’avez pas déjà fait, créez-en un.

  • Accès accordé à Azure OpenAI dans l’abonnement Azure souhaité. Vous pouvez demander l’accès à Azure OpenAI en complétant le formulaire à l’adresse https://aka.ms/oai/access. Ouvrez un problème sur ce dépôt pour nous contacter si vous rencontrez un problème.

  • Ressource Azure OpenAI avec un modèle déployé. Pour plus d’informations sur le déploiement de modèle, consultez le guide de déploiement de ressources.

    Prenez note de l’ID (nom) de déploiement. Vous en aurez besoin lors du test de l’API importée dans Gestion des API.

Télécharger la spécification OpenAPI

Téléchargez la spécification OpenAPI pour un point de terminaison pris en charge par votre modèle. Par exemple, téléchargez la spécification OpenAPI pour le point de terminaison d’achèvement de complétion de conversation des modèles GPT-35-Turbo et GPT-4.

  1. Dans un éditeur de texte, ouvrez le fichier de spécification que vous avez téléchargé.
  2. Dans l’élément servers de la spécification, remplacez le nom du point de terminaison de votre ressource Azure OpenAI pour les valeurs de l’espace réservé dans la spécification. L’exemple d’élément servers suivant est mis à jour avec le point de terminaison de ressource contoso.openai.azure.com. 
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
  3. Prenez note de la valeur de la version de l’API dans la spécification. Vous en aurez besoin pour tester l’API. Exemple : 2023-05-15.

Ajouter la spécification OpenAPI à Gestion des API

  1. Dans le portail Azure, accédez à votre instance APIM.
  2. Dans le menu de gauche, cliquez sur API>+Ajouter une API.
  3. Sous Définir une nouvelle API, sélectionnez OpenAPI. Entrez un Nom d’affichage et un Nom pour l’API, puis entrez un Suffixe de l’URL de l’API.
  4. Sélectionnez Créer.

L’API est importée et affiche les opérations depuis la spécification OpenAPI.

Tester la nouvelle API dans le portail

Les opérations peuvent être appelées directement à partir du portail, ce qui permet d’afficher et de tester facilement les opérations d’une API.

  1. Sélectionnez l’API que vous avez créée à l’étape précédente.

  2. Sélectionnez l’onglet Test.

  3. Sélectionnez une opération. La page affiche des champs pour les paramètres de requête et des champs pour les en-têtes.

    Notes

    Dans la console de test, Gestion des API renseigne automatiquement un en-tête Ocp-Apim-Subscription-Key, et configure la clé d’abonnement de l’abonnement avec accès complet intégré. Cette clé permet d’accéder à toutes les API dans l’instance Gestion des API. Vous pouvez éventuellement afficher l’en-tête Ocp-Apim-Subscription-Key en sélectionnant l’icône « œil » en regard de la requête HTTP.

  4. En fonction de l’opération, entrez des valeurs de paramètre de requête, des valeurs d’en-tête ou un corps de requête. Sélectionnez Envoyer.

    Lorsque le test réussit, le backend répond avec un code de réponse HTTP réussi et quelques données.

    Conseil

    Par défaut, la console de test envoie une demande au proxy CORS de Gestion des API, qui transmet la demande à l'instance d'API Management, qui la transmet ensuite au backend. Ce proxy utilise l'adresse IP publique 13.91.254.72 et ne peut atteindre que les terminaux publics. Si vous souhaitez envoyer une requête directement du navigateur au service Gestion des API, sélectionnez Bypass CORS proxy. Utilisez cette option lorsque vous souhaitez utiliser la console de test et que votre passerelle de Gestion des API est isolée du réseau ou n'autorise pas le trafic provenant du proxy CORS.

Pour déboguer une API, consultez Tutoriel : Déboguer vos API à l’aide du suivi des demandes.

Important

L’authentification auprès de l’API OpenAI nécessite une clé API ou une identité managée. Pour configurer l’authentification en utilisant des stratégies Gestion des API, consultez Authentifier et autoriser sur l’API Azure OpenAI.

Contenu connexe