Importación de la API de Azure OpenAI como API REST

  • Artículo

SE APLICA A: todos los niveles de API Management

En este artículo se muestra cómo importar una API de Azure OpenAI en una instancia de Azure API Management desde su especificación de OpenAPI. Después de importar la API como API REST, puede administrarla, protegerla y publicarla para los desarrolladores.

Requisitos previos

  • Tener una instancia de API Management existente. Cree una suscripción si todavía no lo ha hecho.

  • Acceso concedido a Azure OpenAI en la suscripción de Azure que quiera. Para solicitar acceso a Azure OpenAI, rellene el formulario en https://aka.ms/oai/access. Si tiene algún problema, abra una incidencia en este repositorio para ponerse en contacto con nosotros.

  • Un recurso de Azure OpenAI con un modelo implementado. Para obtener más información sobre la implementación de modelos, consulte la guía de implementación de recursos.

    Anote el identificador (nombre) de implementación. Lo necesitará cuando pruebe la API importada en API Management.

Descargar la especificación de OpenAPI

Descargue la especificación de OpenAPI para un punto de conexión que admita el modelo. Por ejemplo, descargue la especificación de OpenAPI para el punto de conexión de finalización de chat de los modelos GPT-35-Turbo y GPT-4.

  1. En un editor de texto, abra el archivo de especificación que descargó.
  2. En el elemento servers de la especificación, sustituya el nombre del punto de conexión del recurso de Azure OpenAI por los valores de marcador de posición de la especificación. El siguiente elemento servers del ejemplo se actualiza con el punto de conexión del recurso contoso.openai.azure.com. 
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
  3. Anote el valor de la API version en la especificación. Necesitará este valor para probar la API. Ejemplo: 2023-05-15.

Agregar la especificación de OpenAPI a API Management

  1. Vaya a la instancia de API Management en Azure Portal.
  2. En el menú izquierdo, seleccione API>+Agregar API.
  3. En Definir una nueva API, seleccione OpenAPI. Escriba un nombre para mostrar y un nombre para la API, y escriba un sufijo de URL para la API.
  4. Seleccione Crear.

La API se importa y muestra las operaciones de la especificación OpenAPI.

Prueba de la nueva API en el portal

Se puede llamar a las operaciones directamente desde el portal, lo que proporciona a los administradores una forma cómoda de ver y de probar las operaciones de una API.

  1. Seleccione la API que creó en los pasos anteriores.

  2. Seleccione la pestaña Prueba.

  3. Seleccione una operación. La página muestra los campos de parámetros de consulta y los campos para los encabezados.

    Nota

    En la consola de prueba, API Management rellena automáticamente un encabezado Ocp-Apim-Subscription-Key y configura la clave de suscripción de la suscripción de acceso completo integrada. Esta clave permite el acceso a todas las API de la instancia de API Management. Opcionalmente, se puede mostrar el encabezado Ocp-Apim-Subscription-Key si se selecciona el icono de ojo situado junto a la Solicitud HTTP.

  4. En función de la operación, escriba los valores de los parámetros de consulta, los valores de encabezado o el cuerpo de la solicitud. Seleccione Enviar.

    Cuando la prueba se realiza correctamente, el back-end responde con un código de respuesta HTTP correcto y algunos datos.

    Sugerencia

    De forma predeterminada, la consola de prueba envía una solicitud al proxy CORS de API Management, que reenvía la solicitud a la instancia de API Management, que la reenvía al back-end. Este proxy usa la dirección IP pública 13.91.254.72 y solo puede acceder a los puntos de conexión públicos. Si desea enviar una solicitud directamente desde el explorador al servicio API Management, seleccione Omitir proxy CORS. Use esta opción si desea usar la consola de prueba y la puerta de enlace de API Management está aislada de red o no permite el tráfico desde el proxy CORS.

Para depurar una API, consulte Tutorial: Depuración de las API con el seguimiento de solicitudes.

Importante

La autenticación en la API de OpenAI requiere una clave de API o una identidad administrada. Para configurar la autenticación mediante directivas de API Management, consulte Autenticación y autorización en la API de Azure OpenAI.

Contenido relacionado