Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Note
Este documento refere-se ao portal do Microsoft Foundry (clássico ).
🔄 Alterne para a documentação nova do Microsoft Foundry se você estiver usando o novo portal.
Note
Este documento refere-se ao portal do Microsoft Foundry (novo ).
Este artigo descreve os SDKs e endpoints que você pode usar com o recurso Foundry. Ele mostra como se conectar ao seu projeto, acessar modelos de diferentes provedores e usar Ferramentas Foundry. O SDK oferece uma maneira unificada de trabalhar com recursos de IA por meio de bibliotecas de cliente em várias linguagens de programação.
O SDK do Microsoft Foundry simplifica o desenvolvimento de aplicativos de IA no Azure. Ele permite aos desenvolvedores:
- Acessar modelos de vários provedores por meio de uma interface
- Combinar modelos, dados e Ferramentas de Fundimento para criar aplicativos alimentados por IA
- Avaliar, depurar e melhorar a qualidade e a segurança do aplicativo no desenvolvimento, teste e produção
O SDK do Microsoft Foundry integra-se a outras bibliotecas e serviços de cliente que funcionam em conjunto.
Foundry SDK
Os desenvolvedores que trabalham com o Microsoft Foundry precisam de flexibilidade para integrar vários recursos de IA em fluxos de trabalho unificados. Esses SDKs fornecem os blocos de construção para provisionar recursos, orquestrar agentes e conectar-se a ferramentas especializadas Foundry Tools. Ao escolher a biblioteca certa, você pode simplificar o desenvolvimento, reduzir a complexidade e garantir que suas soluções sejam dimensionadas entre projetos do Foundry e pontos de extremidade externos.
Note
Este artigo se aplica a um projeto do Foundry. O código mostrado aqui não funciona para um projeto baseado em hub. Para obter mais informações, confira Tipos de projetos.
Prerequisites
- Uma conta do Azure com uma assinatura ativa. Se você não tiver uma, crie uma conta gratuita do Azure, que inclui uma assinatura de avaliação gratuita.
- Crie um projeto do Foundry se você ainda não tiver um.
- Os Modelos da Fábrica da Microsoft permitem que os clientes consumam os modelos mais poderosos de provedores de modelos principais usando um único ponto de extremidade e credenciais. Isso significa que é possível alternar entre modelos e consumi-los do aplicativo sem alterar uma única linha de código.Copie o ponto de extremidade do projeto Foundry na seção Visão geral do seu projeto. Você vai usá-lo em breve.
Tip
Se você não vir o ponto de extremidade do projeto da Fábrica, você está usando um projeto baseado em hub. (Consulte tipos de projetos). Alterne para um projeto do Foundry ou use as etapas anteriores para criar um.
- Selecione Página Inicial na navegação superior direita.
- Selecione Chaves e copie o Endpoint. Você vai usá-lo em um momento.
- Copie o endpoint da tela de boas-vindas. Você o usará na próxima etapa.
Entre com a CLI do Azure usando a mesma conta que você usa para acessar seu projeto:
az login
Os exemplos a seguir mostram como autenticar e criar um cliente para o endpoint do seu projeto.
Tip
Esses exemplos de código são pontos de partida. Use esses clientes para interagir com modelos, executar avaliações e muito mais, conforme explicado na seção bibliotecas de clientes.
A biblioteca de clientes do Azure AI Projects para Python é uma biblioteca unificada que permite que você use várias bibliotecas de cliente juntas conectando-se a um único ponto de extremidade de projeto.
Instalar a biblioteca de clientes do projeto
pip install azure-ai-projects azure-identity openaipip install --pre azure-ai-projects pip install azure-identity openaiCrie um cliente de projeto no código. Copie o ponto de extremidade do projeto da Fábrica da página Visão geral do projeto e atualize o valor da cadeia de caracteres do ponto de extremidade.
from azure.identity import DefaultAzureCredential from azure.ai.projects import AIProjectClient project = AIProjectClient( endpoint="your_project_endpoint", # Replace with your endpoint credential=DefaultAzureCredential()) # The AIProjectClient lets you access models, data, and services in your project.
A biblioteca de clientes do Azure AI Projects para Java (versão prévia) é uma biblioteca unificada que permite que você use várias bibliotecas de cliente juntas conectando-se a um único ponto de extremidade de projeto.
Important
Os itens marcados (versão prévia) neste artigo estão atualmente em versão prévia pública. Essa versão prévia é fornecida sem um contrato de nível de serviço e não recomendamos isso para cargas de trabalho de produção. Alguns recursos podem não ter suporte ou podem ter restrição de recursos. Para obter mais informações, consulte Termos de Uso Complementares para Versões Prévias do Microsoft Azure.
Adicione estes pacotes à sua instalação:
com.azure.ai.projectscom.azure.core
Crie um cliente de projeto no código. Copie o ponto de extremidade do projeto da Fábrica da página Visão geral do projeto e atualize o valor da cadeia de caracteres de conexões.
import com.azure.ai.projects.ProjectsClient; import com.azure.ai.projects.ProjectsClientBuilder; import com.azure.core.credential.AzureKeyCredential; String endpoint ="your_project_endpoint"; // Replace with your endpoint ProjectsClient projectClient = new ProjectsClientBuilder() .credential(new DefaultAzureCredential()) .endpoint(endpoint) .buildClient(); // The ProjectsClient enables unified access to your project's resources.
A biblioteca de clientes do Azure AI Projects para JavaScript é uma biblioteca unificada que permite que você use várias bibliotecas de clientes juntas conectando-se a um único ponto de extremidade de projeto.
Instalar dependências (versão prévia):
npm install @azure/ai-projects @azure/identityCrie um cliente de projeto no código. Copie o ponto de extremidade do projeto da Fábrica da página Visão geral do projeto e atualize o valor da cadeia de caracteres do ponto de extremidade.
import { AIProjectClient } from '@azure/ai-projects'; import { DefaultAzureCredential } from '@azure/identity'; const endpoint = "your_project_endpoint"; // Replace with your actual endpoint const project = new AIProjectClient(endpoint, new DefaultAzureCredential()); // The AIProjectClient lets you access models, data, and services in your project.
A biblioteca de clientes do Azure AI Projects para .NET é uma biblioteca unificada que permite que você use várias bibliotecas de cliente juntas conectando-se a um único ponto de extremidade de projeto.
Instalar pacotes:
dotnet add package Azure.Identity dotnet add package Azure.Core dotnet add package OpenAICrie um cliente de projeto no código. Copie o ponto de extremidade do projeto da Fábrica da página Visão geral do projeto e atualize o valor da cadeia de caracteres endpointUrl.
using Azure.Identity; using Azure.Core; using Azure.Core.Pipeline; using Azure.AI.Projects; using System; string endpointUrl = "your_project_endpoint"; // Replace with your endpoint DefaultAzureCredential credential = new(); BearerTokenPolicy tokenPolicy = new(credential, "https://cognitiveservices.azure.com/.default"); AIProjectClientOptions clientOptions = new AIProjectClientOptions(); // The PerRetry position ensures the authentication policy is applied to every retry attempt. // This is important for robust authentication in distributed/cloud environments. clientOptions.AddPolicy(tokenPolicy, HttpPipelinePosition.PerRetry); AIProjectClient projectClient = new(new Uri(endpointUrl), new DefaultAzureCredential(), clientOptions); // The AIProjectClient lets you access models, data, and services in your project.
SDK de OpenAI
O SDK do OpenAI permite que você interaja com o serviço Azure OpenAI. Ele oferece uma interface simples para fazer chamadas à API e gerenciar a autenticação. O SDK da OpenAI chama diretamente o ponto de extremidade do OpenAI do Azure. O trecho de código a seguir mostra como criar o cliente OpenAI a partir do cliente Project para um escopo e gerenciamento de contexto adequados.
Qual endpoint você deve usar?
- Gerenciando um projeto ou chamando agentes v2? Use o ponto de extremidade do Projeto da Fábrica com o SDK da Fábrica. Obtenha seu cliente OpenAI do Projeto usando a ID do Microsoft Entra para autenticação.
- Chamando um modelo diretamente? Use o ponto de extremidade do OpenAI do Azure com o SDK do OpenAI com Microsoft Entra ID como o método de autenticação preferencial. Se estiver usando chaves de API, escolha o ponto de extremidade v1:
https://<YOUR-RESOURCE-NAME>.openai.azure.com/openai/v1/.
Criar um cliente OpenAI do seu projeto
# Use the AIProjectClient to create an OpenAI client for your project
openai_client = project.get_openai_client(api_version="api_version")
response = openai_client.responses.create(
model="gpt-4.1-mini",
input="What is the size of France in square miles?",
)
print(f"Response output: {response.output_text}")
O trecho de código a seguir demonstra como usar o endpoint do Azure OpenAI v1 com o cliente OpenAI para respostas.
from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider
token_provider = get_bearer_token_provider(
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
)
client = OpenAI(
base_url = "https://<YOUR-RESOURCE-NAME>.openai.azure.com/openai/v1/",
api_key=token_provider,
)
response = client.responses.create(
model="model_deployment_name",
input= "What is the size of France in square miles?"
)
print(response.model_dump_json(indent=2))
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI.
# Use the AIProjectClient to create an OpenAI client for your project
openai_client = project.get_openai_client()
response = openai_client.responses.create(
model="gpt-4.1-mini",
input="What is the size of France in square miles?",
)
print(f"Response output: {response.output_text}")
O trecho de código a seguir demonstra como usar o endpoint do Azure OpenAI v1 com o cliente OpenAI para respostas.
from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider
token_provider = get_bearer_token_provider(
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
)
client = OpenAI(
base_url = "https://<YOUR-RESOURCE-NAME>.openai.azure.com/openai/v1/",
api_key=token_provider,
)
response = client.responses.create(
model="model_deployment_name",
input= "What is the size of France in square miles?"
)
print(response.model_dump_json(indent=2))
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI
Important
Os itens marcados (versão prévia) neste artigo estão atualmente em versão prévia pública. Essa versão prévia é fornecida sem um contrato de nível de serviço e não recomendamos isso para cargas de trabalho de produção. Alguns recursos podem não ter suporte ou podem ter restrição de recursos. Para obter mais informações, consulte Termos de Uso Complementares para Versões Prévias do Microsoft Azure.
//
OpenAIClient openAIClient = projectClient.getOpenAIClient();
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI.
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI
// Use the AIProjectClient to create an OpenAI client for your project
const openAIClient = await project.getOpenAIClient();
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI.
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI
Instale o pacote OpenAI:
dotnet add package OpenAIO snippet de código seguinte demonstra como criar o cliente OpenAI diretamente usando o endpoint Azure OpenAI v1.
using Azure.Identity; using Azure.Core; using Azure.Core.Pipeline; using OpenAI; using System; using System.ClientModel.Primitives; endpointUrl = "https://<YOUR-RESOURCE-NAME>.openai.azure.com/openai/v1/" DefaultAzureCredential credential = new(); BearerTokenPolicy tokenPolicy = new(credential, "https://cognitiveservices.azure.com/.default"); OpenAIClientOptions clientOptions = new() { Endpoint = new Uri(endpointUrl) }; // The PerRetry position ensures the authentication policy is applied to every retry attempt. // This is important for robust authentication in distributed/cloud environments. clientOptions.AddPolicy(tokenPolicy, HttpPipelinePosition.PerRetry); var projectClient = new ResponseClient( endpointUrl, credential, clientOptions ); // The ResponseClient lets you interact with models and services in your project.
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI.
Para obter mais informações sobre como usar o SDK do OpenAI, consulte as linguagens de programação compatíveis com o Azure OpenAI
Depois de criar um cliente, use-o para acessar modelos, executar avaliações e conectar com outras Ferramentas Foundry.
- Usando o endpoint do projeto, você pode:
- Usar Foundry Models, incluindo Azure OpenAI
- Usar o Serviço de Agente da Fábrica
- Executar avaliações na nuvem
- Habilitar o rastreamento para seu aplicativo
- Ajustar um modelo
- Recupere pontos de extremidade e chaves para conexões de recursos externos, como Foundry Tools, orquestração local e muito mais.
A próxima seção lista as bibliotecas de clientes do Foundry Tools e mostra como usá-las.
SDKs do Foundry Tools
Para usar as Ferramentas do Foundry, você pode usar os seguintes SDKs com os pontos de extremidade listados.
Qual endpoint você deve usar?
Escolha um ponto de extremidade com base em suas necessidades:
Use o ponto de extremidade dos Serviços de IA do Azure para acessar a Pesquisa Visual Computacional, a Segurança de Conteúdo, a Inteligência de Documentos, a Linguagem, a Tradução e as Ferramentas de Fundimento de Token.
Ponto de extremidade dos Serviços de IA do Azure: https://<YOUR-RESOURCE-NAME>.services.ai.azure.com/
Para Foundry Tools de Fala e Tradução, use os pontos de extremidade nas tabelas a seguir. Substitua os espaços reservados pelas informações do seu recurso.
Pontos de Extremidade de Fala
| Ferramenta de Fundição | Ponto final |
|---|---|
| Conversão de Fala em Texto (Padrão) | https://<YOUR-RESOURCE-REGION>.stt.speech.microsoft.com |
| Conversão de Texto em Fala (Neural) | https://<YOUR-RESOURCE-REGION>.tts.speech.microsoft.com |
| Voz Personalizada | https://<YOUR-RESOURCE-NAME>.cognitiveservices.azure.com/ |
Pontos de Extremidade de Tradução
| Ferramenta de Fundição | Ponto final |
|---|---|
| Tradução de texto | https://api.cognitive.microsofttranslator.com/ |
| Tradução de Documento | https://<YOUR-RESOURCE-NAME>.cognitiveservices.azure.com/ |
As seções a seguir incluem links de início rápido para os SDKs do Foundry Tools e informações de referência sobre os SDKs.
Ferramentas Foundry compatíveis com C#
Ferramentas de Fundição suportadas por Java
Ferramentas de Fundição compatíveis com JavaScript
Ferramentas de Foundry com suporte de Python
Usando a Estrutura do Agente para orquestração local
O Microsoft Agent Framework é um kit de desenvolvimento de software livre para criar agentes de IA e fluxos de trabalho de vários agentes para .NET e Python. Ele fornece uma maneira de criar e gerenciar agentes de IA que podem interagir com usuários e outros serviços. Ele pode orquestrar agentes na Foundry ou ter agentes locais que usam modelos da Foundry.
Para obter mais informações, consulte a visão geral do Microsoft Agent Framework