Importar uma API do OpenAI do Azure como uma API REST

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo mostra como importar uma API do OpenAI do Azure para uma instância do Gerenciamento de API do Azure de sua especificação OpenAPI. Depois de importar a API como uma API REST, você pode gerenciá-la, protegê-la e publicá-la para desenvolvedores.

Pré-requisitos

  • Uma instância de Gerenciamento de API existente. Crie uma, se ainda não tiver.

  • Acesso permitido ao OpenAI do Azure na assinatura do Azure desejada. Você pode solicitar acesso ao Serviço OpenAI do Azure preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se você tiver algum problema.

  • Um recurso do OpenAI do Azure com um modelo implantado. Para obter mais informações sobre a implantação do modelo, consulte o Guia de implantação de recursos.

    Anote a ID da implantação (nome). Você precisará dela ao testar a API importada no Gerenciamento de API.

Baixar a especificação de OpenAPI

Baixe a especificação OpenAPI para um ponto de extremidade compatível com o modelo. Por exemplo, baixe a especificação OpenAPI para o ponto de extremidade de conclusão de chat dos modelos GPT-35-Turbo e GPT-4.

  1. Em um editor de texto, abra o arquivo de especificação que você baixou.
  2. No elemento servers na especificação, substitua o nome do ponto de extremidade do recurso do OpenAI do Azure pelos valores dos espaço reservado na especificação. O elemento servers de exemplo a seguir é atualizado com o ponto de extremidade do recurso contoso.openai.azure.com. 
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
  3. Anote o valor da API version na especificação. Você precisará dela para testar a API. Exemplo: 2023-05-15.

Adicionar a especificação OpenAPI para o Gerenciamento de API

  1. No portal do Azure, navegue até a instância do Gerenciamento de API.
  2. No menu à esquerda, selecione APIs>+ Adicionar API.
  3. Em Definir uma nova API, selecione OpenAPI. Insira um Nome de exibição e um Nome para a API e insira um sufixo para a URL da API.
  4. Selecione Criar.

A API é importada e exibe as operações da especificação OpenAPI.

Testar a nova API no portal

As operações podem ser chamadas diretamente do portal, que fornece uma maneira conveniente para administradores exibirem e testarem as operações de uma API.

  1. Selecione a API que você criou na etapa anterior.

  2. Selecione a guia Testar.

  3. Selecione uma operação. A página exibe os campos dos parâmetros de consulta e os campos dos cabeçalhos.

    Observação

    No console de teste, o Gerenciamento de API preenche automaticamente um cabeçalho Ocp-Apim-Subscription-Key e configura a chave de assinatura da assinatura interna de acesso total. Essa chave permite o acesso a todas as API na instância de Gerenciamento de API. Opcionalmente, exiba o cabeçalho Ocp-Apim-Subscription-Key selecionando o ícone "olho" ao lado da Solicitação HTTP.

  4. Dependendo da operação, insira valores de parâmetro de consulta, valores de cabeçalho ou um corpo da solicitação. Selecione Enviar.

    Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados.

    Dica

    Por padrão, o console de teste envia uma solicitação para o proxy CORS do Gerenciamento de API, que encaminha a solicitação para a instância Gerenciamento de API, que a encaminha para o back-end. Esse proxy usa o endereço de IP público 13.91.254.72 e só pode alcançar pontos de extremidade públicos. Se você quiser enviar uma solicitação diretamente do navegador para o serviço Gerenciamento de API, selecione Ignorar proxy CORS. Use essa opção quando quiser usar o console de teste e o gateway do Gerenciamento de API estiver isolado na rede ou não permitir o tráfego do proxy CORS.

Para depurar uma API, confira o Tutorial: Depurar suas APIs usando o rastreamento de solicitações.

Importante

A autenticação na API do OpenAI requer uma chave de API ou uma identidade gerenciada. Para configurar a autenticação usando políticas de Gerenciamento de API, consulte Autenticar e autorizar na API do OpenAI do Azure.

Conteúdo relacionado