Partilhar via

Importar uma API Microsoft Foundry

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

Pode importar endpoints de modelos de IA implementados no Microsoft Foundry para a sua instância de Gestão de APIs como APIs. 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.

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

Opções de compatibilidade do cliente

O API Management suporta duas opções de compatibilidade com clientes para APIs de IA da Microsoft Foundry. Ao importar a API usando o assistente, escolha a opção adequada para a implantação do modelo. A opção determina como os clientes chamam a API e como a instância de Gerenciamento de API roteia solicitações para o serviço de IA.

  • Azure OpenAI - Gerir Azure OpenAI em implementações de modelos Microsoft Foundry.

    Os clientes chamam a implantação num endpoint /openai como /openai/deployments/my-deployment/chat/completions. O nome da implantação é passado no caminho da solicitação. Use esta opção se o seu serviço de IA incluir apenas implantações de modelo OpenAI do Azure.

  • Azure AI - Gerir endpoints de modelos no Microsoft Foundry que são expostos através da API Azure AI Model Inference.

    Os clientes chamam a implementação num endpoint como /models. O nome da implantação é passado no corpo da solicitação. Use esta opção se quiser flexibilidade para alternar entre modelos expostos por meio da API de Inferência de Modelos de IA do Azure e aqueles implementados no Azure OpenAI em Foundry Models.

Pré-requisitos

  • Uma instância de gerenciamento de API existente. Crie um, caso ainda não o tenha feito.

  • Um serviço de IA do Azure em sua assinatura com um ou mais modelos implantados. Exemplos incluem modelos implementados no Microsoft Foundry ou Azure OpenAI.

Importar a API Microsoft Foundry usando o portal

Use as etapas a seguir para importar uma API de IA para o Gerenciamento de API.

Quando você importa a API, o Gerenciamento de API configura automaticamente:

  • Operações para cada um dos pontos de extremidade REST da API
  • Uma identidade atribuída ao sistema com as permissões necessárias para acessar a implantação do serviço de IA.
  • Um recurso de back-end e uma política de configuração de serviço do back-end que direcionam solicitações de API para o endpoint do serviço de IA.
  • Autenticação no back-end usando a identidade gerenciada atribuída ao sistema da instância.
  • (opcionalmente) Políticas para ajudá-lo a monitorar e gerenciar a API.

Para importar uma API Microsoft Foundry para a API Management:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. No menu à esquerda, em APIs, selecione APIs>+ Add API.

  3. Em Criar a partir do recurso Azure, selecione Microsoft Foundry.

    Captura de tela da criação de uma API compatível com OpenAI no portal.

  4. Na guia Selecionar serviço de IA :

    1. Selecione a Assinatura na qual pesquisar serviços de IA. Para obter informações sobre as implantações de modelo em um serviço, selecione o link de implantações ao lado do nome do serviço. Captura de tela de implantações para um serviço de IA no portal.
    2. Selecione um serviço de IA.
    3. Selecione Seguinte.

  5. Na aba Configurar API:

    1. Insira um Nome para exibição e uma Descrição opcional para a API.

    2. Em Caminho base, insira um caminho que sua instância de Gerenciamento de API usa para acessar o ponto de extremidade de implantação.

    3. Opcionalmente, selecione um ou mais Produtos para associar à API.

    4. Em Compatibilidade com cliente, selecione uma das seguintes opções com base nos tipos de cliente que você pretende suportar. Consulte Opções de compatibilidade de cliente para obter mais informações.

      • Azure OpenAI - Selecione esta opção se os seus clientes só precisarem de aceder ao Azure OpenAI nas implementações do modelo Microsoft Foundry.
      • Azure AI - Selecione esta opção se os seus clientes precisarem de aceder a outros modelos no Microsoft Foundry.

    5. Selecione Seguinte.

      Captura de ecrã da configuração da API Microsoft Foundry no portal.

  6. Na guia Gerenciar consumo de token , opcionalmente, insira configurações ou aceite padrões que definam as seguintes políticas para ajudar a monitorar e gerenciar a API:

  7. Na guia Aplicar cache semântico , opcionalmente, insira configurações ou aceite padrões que definem as políticas para ajudar a otimizar o desempenho e reduzir a latência da API:

  8. Na segurança de conteúdo de IA, opcionalmente, insira configurações ou aceite padrões para configurar o serviço de Segurança de Conteúdo de IA do Azure para bloquear prompts com conteúdo não seguro:

  9. Selecione Revisão.

  10. Depois que as configurações forem validadas, selecione Criar.

Teste a API de IA

Para garantir que sua API de IA esteja funcionando conforme o esperado, teste-a no console de teste de Gerenciamento de API.

  1. Selecione a API que criou no passo anterior.

  2. Selecione a guia Teste .

  3. Selecione uma operação que seja compatível com a implantação do modelo. A página exibe campos para parâmetros e cabeçalhos.

  4. Insira parâmetros e cabeçalhos conforme necessário. Dependendo da operação, talvez seja necessário configurar ou atualizar um corpo de solicitação. Aqui está um exemplo muito básico de pedido para uma operação de conclusão de chat:

    {
  "model": "any",
  "messages": [
    {
      "role": "user",
      "content": "Help me plan a trip to Paris",
      "max_tokens": 100
    }
  ]
}

    Observação

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

  5. Selecione Enviar.

    Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados. Anexados à resposta estão dados de uso de token para ajudá-lo a monitorar e gerenciar o consumo de token do modelo de idioma.

Conteúdo relacionado

  • Last updated on