Importar uma API do OpenAI do Azure

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

Você pode importar pontos de extremidade de modelo de IA implantados em Serviço OpenAI do Azure nos Modelos Foundry para sua instância do Gerenciamento de API como uma API REST. Use políticas de gateway de IA e outros recursos no Gerenciamento de API para simplificar a integração, melhorar a observabilidade e aprimorar o controle sobre os pontos de extremidade do modelo.

Este artigo mostra duas opções para importar uma API do Azure OpenAI para uma instância de Gerenciamento de API do Azure como uma API REST:

Importar uma API do Azure OpenAI diretamente de uma implantação no Microsoft Foundry (recomendado)
Baixe e edite a especificação OpenAPI do Azure OpenAI e adicione-a ao Gerenciamento de API como uma API OpenAPI.

Saiba mais sobre como gerenciar APIs llm no Gerenciamento de API:

Funcionalidades do gateway de IA no Gerenciamento de API do Azure

Observação

As políticas de Gerenciamento de API, como azure-openai-token-limit e azure-openai-emit-token-metric, dão suporte a determinados pontos de extremidade de API expostos por meio de modelos específicos do Azure OpenAI. Para obter mais informações, consulte modelos do Azure OpenAI com suporte.

Pré-requisitos

Uma instância de Gerenciamento de API existente. Crie uma, se ainda não tiver.
(Para importação do Microsoft Foundry) Um projeto do Microsoft Foundry com um modelo do Azure OpenAI implantado. Para obter mais informações sobre a implantação de modelo no Azure OpenAI, consulte o guia de implantação de recursos.

Anote a ID (o nome) da implantação. Você precisa dela ao testar a API importada no Gerenciamento de API.
Permissões para conceder acesso ao recurso do OpenAI do Azure da instância de Gerenciamento de API.

Opção 1. Importar a API OpenAI do Microsoft Foundry

Você pode importar uma implantação de modelo do Azure OpenAI diretamente do Microsoft Foundry para o Gerenciamento de API. Para obter detalhes, consulte Importar uma API do Microsoft Foundry.

Ao importar a API:

Especifique o serviço Microsoft Foundry que hospeda a implantação de modelo do Azure OpenAI.
Especifique a opção de compatibilidade do cliente do Azure OpenAI . Essa opção configura API da API Management com um /openai ponto de extremidade.

Opção 2. Adicionar a especificação OpenAPI ao Gerenciamento de API

Alternativamente, baixe manualmente a especificação OpenAPI para a API REST do OpenAI do Azure e a adicione ao Gerenciamento de API como uma API OpenAPI.

Baixar a especificação OpenAPI

Baixe a especificação OpenAPI para a API REST do Azure OpenAI, como a versão 2024-10-21 GA.

Em um editor de texto, abra o arquivo de especificação que você baixou.
No elemento servers na especificação, substitua o nome do seu ponto de extremidade do OpenAI do Azure nos valores de espaço reservado de ponto de extremidade url e default. Por exemplo, se o ponto de extremidade do Serviço OpenAI do Azure for contoso.openai.azure.com, atualize o elemento servers com os seguintes valores:
- url: https://contoso.openai.azure.com/openai
- ponto de extremidade padrão:contoso.openai.azure.com
```
[...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
```
Anote o valor da API version na especificação. Você precisa dela para testar a API. Exemplo: 2024-10-21.

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

No portal do Azure, acesse sua instância de Gerenciamento de API.
No menu à esquerda, selecione APIs >+Adicionar API.
Em Definir uma nova API, selecione OpenAPI. Insira um Nome de exibição e um Nome para a API.
Insira um sufixo de URL de API que termine em /openai para acessar os pontos de extremidade da API do OpenAI do Azure na sua instância de Gerenciamento de API. Por exemplo: my-openai-api/openai.
Selecione Criar.

O Gerenciamento de API importa a API e exibe as operações da especificação OpenAPI.

Configurar a autenticação para a API do OpenAI do Azure

Para se autenticar na API openai do Azure, forneça uma chave de API ou use uma identidade gerenciada. Se você importou a API do Azure OpenAI diretamente do Microsoft Foundry, a autenticação usando a identidade gerenciada da instância de Gerenciamento de API será configurada automaticamente.

Se adicionou a API do OpenAI do Azure da sua especificação OpenAPI, você precisará configurar a autenticação. Para obter mais informações sobre como configurar a autenticação usando políticas de Gerenciamento de APIs, consulte Autenticar e autorizar às APIs LLM.

Testar a API do OpenAI do Azure

Para garantir que a API do Azure OpenAI funcione conforme o esperado, teste-a no console de teste do Gerenciamento de API. Você precisa fornecer uma ID de implantação de modelo (nome) configurada no recurso de projeto do Microsoft Foundry e na versão da API para testar a API.

Selecione a API que você criou na etapa anterior.
Selecione a guia Testar.
Selecione uma operação que seja compatível com o modelo que você implantou no recurso do OpenAI do Azure. A página mostra os campos dos parâmetros e cabeçalhos.
Nos Parâmetros de modelo, insira os seguintes valores:
- deployment-id - o ID de uma implantação de modelo do Azure OpenAI no Microsoft Foundry
- api-version — uma versão válida da API do OpenAI do Azure, como a versão da API que você selecionou quando importou a API.
Insira outros parâmetros e cabeçalhos conforme necessário. Dependendo da operação e do modelo, talvez seja necessário configurar ou atualizar um corpo da solicitação. Por exemplo, aqui está um corpo da solicitação básico para uma operação de conclusão de chat:
```
{
  "model": "any",
  "messages": [
    {
      "role": "user",
      "content": "Help me plan a vacation trip to Paris."
    }
  ],
  "max_tokens": 100
}
```
Observação

No console de teste, o Gerenciamento de API adiciona automaticamente um cabeçalho Ocp-Apim-Subscription-Key e define a chave de assinatura para a assinatura interna de todos os acessos. Essa chave fornece acesso a todas as API na instância de Gerenciamento de API. Para exibir opcionalmente o cabeçalho Ocp-Apim-Subscription-Key , selecione o ícone "olho" ao lado da Solicitação HTTP.
Selecione Enviar.

Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados. A resposta inclui dados de uso de token para ajudá-lo a monitorar e gerenciar o consumo de token da API OpenAI do Azure.

Comentários

Esta página foi útil?

Last updated on 2025-12-24