Share via

Importar uma API OpenAI do Azure como uma API REST

  • Artigo

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo mostra como importar uma API OpenAI do Azure para uma instância de Gerenciamento de API do Azure a partir 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 um, caso ainda não o tenha feito.

  • Acesso concedido ao Azure OpenAI na subscrição pretendida do Azure. Você pode solicitar acesso ao Azure OpenAI preenchendo o formulário em https://aka.ms/oai/access. Abra um problema neste repositório para entrar em contato conosco se tiver um problema.

  • Um recurso OpenAI do Azure com um modelo implantado. Para obter mais informações sobre a implementação de modelos, veja o guia de implementação de recursos.

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

Faça o download da especificação OpenAPI

Transfira a especificação OpenAPI para um ponto de extremidade suportado pelo seu modelo. Por exemplo, baixe a especificação OpenAPI para o ponto de extremidade de conclusão de bate-papo dos modelos GPT-35-Turbo e GPT-4.

  1. Em um editor de texto, abra o arquivo de especificação que você baixou.
  2. servers No elemento na especificação, substitua o nome do ponto de extremidade do recurso OpenAI do Azure pelos valores de espaço reservado na especificação. O elemento de exemplo servers a seguir é atualizado com o ponto de extremidade do contoso.openai.azure.com recurso. 
    [...]
"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á dele para testar a API. Exemplo: 2023-05-15.

Adicionar especificação OpenAPI ao Gerenciamento de API

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

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

Teste a nova API no portal

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

  1. Selecione a API que criou no passo anterior.

  2. Selecione o separador Teste.

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

    Nota

    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 de acesso total interna. Essa chave permite o acesso a todas as APIs 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âmetros de consulta, valores de cabeçalho ou um corpo de 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.

    Gorjeta

    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 de Gerenciamento de API, que a encaminha para o back-end. Este proxy usa o endereço IP público 13.91.254.72 e só pode alcançar pontos de extremidade públicos. Se quiser enviar uma solicitação diretamente do navegador para o serviço de Gerenciamento de API, selecione Ignorar proxy CORS. Use essa opção quando quiser usar o console de teste e seu gateway de Gerenciamento de API estiver isolado na rede ou não permitir tráfego do proxy CORS.

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

Importante

A autenticação para a API 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 a API OpenAI do Azure.

Conteúdos relacionados