mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Roger Barreto
100 lines
3.2 KiB
C#
100 lines
3.2 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
// This sample shows how to use OpenAPI Tools with AI Agents.
|
|
|
|
using Azure.AI.Projects;
|
|
using Azure.AI.Projects.OpenAI;
|
|
using Azure.Identity;
|
|
using Microsoft.Agents.AI;
|
|
using OpenAI.Responses;
|
|
|
|
string endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_PROJECT_ENDPOINT is not set.");
|
|
string deploymentName = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
|
|
|
|
const string AgentInstructions = "You are a helpful assistant that can use the countries API to retrieve information about countries by their currency code.";
|
|
const string AgentName = "OpenAPIToolsAgent";
|
|
|
|
// A simple OpenAPI specification for the REST Countries API
|
|
const string CountriesOpenApiSpec = """
|
|
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "REST Countries API",
|
|
"description": "Retrieve information about countries by currency code",
|
|
"version": "v3.1"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://restcountries.com/v3.1"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/currency/{currency}": {
|
|
"get": {
|
|
"description": "Get countries that use a specific currency code (e.g., USD, EUR, GBP)",
|
|
"operationId": "GetCountriesByCurrency",
|
|
"parameters": [
|
|
{
|
|
"name": "currency",
|
|
"in": "path",
|
|
"description": "Currency code (e.g., USD, EUR, GBP)",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response with list of countries",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "No countries found for the currency"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
""";
|
|
|
|
// Get a client to create/retrieve/delete server side agents with Azure Foundry Agents.
|
|
AIProjectClient aiProjectClient = new(new Uri(endpoint), new AzureCliCredential());
|
|
|
|
// Create the OpenAPI tool definition
|
|
ResponseTool openApiTool = (ResponseTool)AgentTool.CreateOpenApiTool(
|
|
new OpenAPIFunctionDefinition(
|
|
"get_countries",
|
|
BinaryData.FromString(CountriesOpenApiSpec),
|
|
new OpenAPIAnonymousAuthenticationDetails())
|
|
{
|
|
Description = "Retrieve information about countries by currency code"
|
|
});
|
|
|
|
// Create an agent with OpenAPI tool using PromptAgentDefinition (native SDK approach)
|
|
AIAgent agent = await aiProjectClient.CreateAIAgentAsync(
|
|
name: AgentName,
|
|
creationOptions: new AgentVersionCreationOptions(
|
|
new PromptAgentDefinition(model: deploymentName)
|
|
{
|
|
Instructions = AgentInstructions,
|
|
Tools = { openApiTool }
|
|
})
|
|
);
|
|
|
|
// Run the agent with a question about countries
|
|
Console.WriteLine(await agent.RunAsync("What countries use the Euro (EUR) as their currency? Please list them."));
|
|
|
|
// Cleanup by deleting the agent
|
|
await aiProjectClient.Agents.DeleteAgentAsync(agent.Name);
|