.NET: Inline const values in samples where used only once (#1387)

* Inline const values in samples where used only once * Fix some spacing issues and use consistent ordering of settings/params
2026-06-16 21:04:09 +08:00 · 2025-10-10 17:50:53 +01:00
parent 3730db3e94
commit d6fdb91480
21 changed files with 53 additions and 106 deletions
@@ -14,9 +14,6 @@ var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_ENDPOINT
 var apiKey = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_APIKEY");
 var model = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_MODEL_DEPLOYMENT") ?? "Phi-4-mini-instruct";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Since we are using the OpenAI Client SDK, we need to override the default endpoint to point to Azure Foundry.
 var clientOptions = new OpenAIClientOptions() { Endpoint = new Uri(endpoint) };

@@ -26,8 +23,8 @@ OpenAIClient client = string.IsNullOrWhiteSpace(apiKey)
    : new OpenAIClient(new ApiKeyCredential(apiKey), clientOptions);

 AIAgent agent = client
-     .GetChatClient(model)
-     .CreateAIAgent(JokerInstructions, JokerName);
+    .GetChatClient(model)
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -10,14 +10,11 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
     .GetChatClient(deploymentName)
-     .CreateAIAgent(JokerInstructions, JokerName);
+     .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -10,14 +10,11 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
     .GetOpenAIResponseClient(deploymentName)
-     .CreateAIAgent(JokerInstructions, JokerName);
+     .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -10,12 +10,9 @@ using Microsoft.ML.OnnxRuntimeGenAI;
 // E.g. C:\repos\Phi-4-mini-instruct-onnx\cpu_and_mobile\cpu-int4-rtn-block-32-acc-level-4
 var modelPath = Environment.GetEnvironmentVariable("ONNX_MODEL_PATH") ?? throw new InvalidOperationException("ONNX_MODEL_PATH is not set.");

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Get a chat client for ONNX and use it to construct an AIAgent.
 using OnnxRuntimeGenAIChatClient chatClient = new(modelPath);
-AIAgent agent = chatClient.CreateAIAgent(JokerInstructions, JokerName);
+AIAgent agent = chatClient.CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -9,12 +9,9 @@ using OllamaSharp;
 var endpoint = Environment.GetEnvironmentVariable("OLLAMA_ENDPOINT") ?? throw new InvalidOperationException("OLLAMA_ENDPOINT is not set.");
 var modelName = Environment.GetEnvironmentVariable("OLLAMA_MODEL_NAME") ?? throw new InvalidOperationException("OLLAMA_MODEL_NAME is not set.");

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Get a chat client for Ollama and use it to construct an AIAgent.
 AIAgent agent = new OllamaApiClient(new Uri(endpoint), modelName)
-    .CreateAIAgent(JokerInstructions, JokerName);
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -8,13 +8,10 @@ using OpenAI;
 var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
 var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new OpenAIClient(
    apiKey)
     .GetChatClient(model)
-     .CreateAIAgent(JokerInstructions, JokerName);
+     .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -8,13 +8,10 @@ using OpenAI;
 var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
 var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new OpenAIClient(
    apiKey)
     .GetOpenAIResponseClient(model)
-     .CreateAIAgent(JokerInstructions, JokerName);
+     .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -10,12 +10,9 @@ using OpenAI.Chat;
 var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
 var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new OpenAIClient(apiKey)
    .GetChatClient(model)
-    .CreateAIAgent(JokerInstructions, JokerName);
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 UserChatMessage chatMessage = new("Tell me a joke about a pirate.");

@@ -10,14 +10,11 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(JokerInstructions, JokerName);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
@@ -10,14 +10,11 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(JokerInstructions, JokerName);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Invoke the agent with a multi-turn conversation, where the context is preserved in the thread object.
 AgentThread thread = agent.GetNewThread();
@@ -21,8 +21,8 @@ static string GetWeather([Description("The location to get the weather for.")] s
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(instructions: "You are a helpful assistant", tools: [AIFunctionFactory.Create(GetWeather)]);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are a helpful assistant", tools: [AIFunctionFactory.Create(GetWeather)]);

 // Non-streaming agent interaction with function tools.
 Console.WriteLine(await agent.RunAsync("What is the weather like in Amsterdam?"));
@@ -25,8 +25,8 @@ static string GetWeather([Description("The location to get the weather for.")] s
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(instructions: "You are a helpful assistant", tools: [new ApprovalRequiredAIFunction(AIFunctionFactory.Create(GetWeather))]);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are a helpful assistant", tools: [new ApprovalRequiredAIFunction(AIFunctionFactory.Create(GetWeather))]);

 // Call the agent and check if there are any user input requests to handle.
 AgentThread thread = agent.GetNewThread();
@@ -11,15 +11,12 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Create the agent
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(JokerInstructions, JokerName);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker");

 // Start a new thread for the agent conversation.
 AgentThread thread = agent.GetNewThread();
@@ -17,9 +17,6 @@ using SampleApp;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Create a vector store to store the chat messages in.
 // Replace this with a vector store implementation of your choice if you want to persist the chat history to disk.
 VectorStore vectorStore = new InMemoryVectorStore();
@@ -28,19 +25,19 @@ VectorStore vectorStore = new InMemoryVectorStore();
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(new ChatClientAgentOptions
-     {
-         Name = JokerName,
-         Instructions = JokerInstructions,
-         ChatMessageStoreFactory = ctx =>
-         {
-             // Create a new chat message store for this agent that stores the messages in a vector store.
-             // Each thread must get its own copy of the VectorChatMessageStore, since the store
-             // also contains the id that the thread is stored under.
-             return new VectorChatMessageStore(vectorStore, ctx.SerializedState, ctx.JsonSerializerOptions);
-         }
-     });
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(new ChatClientAgentOptions
+    {
+        Instructions = "You are good at telling jokes.",
+        Name = "Joker",
+        ChatMessageStoreFactory = ctx =>
+        {
+            // Create a new chat message store for this agent that stores the messages in a vector store.
+            // Each thread must get its own copy of the VectorChatMessageStore, since the store
+            // also contains the id that the thread is stored under.
+            return new VectorChatMessageStore(vectorStore, ctx.SerializedState, ctx.JsonSerializerOptions);
+        }
+    });

 // Start a new thread for the agent conversation.
 AgentThread thread = agent.GetNewThread();
@@ -14,9 +14,6 @@ var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? th
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
 var applicationInsightsConnectionString = Environment.GetEnvironmentVariable("APPLICATIONINSIGHTS_CONNECTION_STRING");

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Create TracerProvider with console exporter
 // This will output the telemetry data to the console.
 string sourceName = Guid.NewGuid().ToString("N");
@@ -32,7 +29,7 @@ using var tracerProvider = tracerProviderBuilder.Build();
 // Create the agent, and enable OpenTelemetry instrumentation.
 AIAgent agent = new AzureOpenAIClient(new Uri(endpoint), new AzureCliCredential())
    .GetChatClient(deploymentName)
-    .CreateAIAgent(JokerInstructions, JokerName)
+    .CreateAIAgent(instructions: "You are good at telling jokes.", name: "Joker")
    .AsBuilder()
    .UseOpenTelemetry(sourceName: sourceName)
    .Build();
@@ -18,9 +18,8 @@ var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT
 HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

 // Add agent options to the service collection.
-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-builder.Services.AddSingleton(new ChatClientAgentOptions(JokerInstructions, JokerName));
+builder.Services.AddSingleton(
+    new ChatClientAgentOptions(instructions: "You are good at telling jokes.", name: "Joker"));

 // Add a chat client to the service collection.
 builder.Services.AddKeyedChatClient("AzureOpenAI", (sp) => new AzureOpenAIClient(
@@ -12,18 +12,14 @@ using ModelContextProtocol.Server;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_PROJECT_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerDescription = "An agent that tells jokes.";
-const string JokerInstructions = "You are good at telling jokes, and you always start each joke with 'Aye aye, captain!'.";
-
 var persistentAgentsClient = new PersistentAgentsClient(endpoint, new AzureCliCredential());

 // Create a server side persistent agent
 var agentMetadata = await persistentAgentsClient.Administration.CreateAgentAsync(
    model: deploymentName,
-    name: JokerName,
-    description: JokerDescription,
-    instructions: JokerInstructions);
+    instructions: "You are good at telling jokes, and you always start each joke with 'Aye aye, captain!'.",
+    name: "Joker",
+    description: "An agent that tells jokes.");

 // Retrieve the server side persistent agent as an AIAgent.
 AIAgent agent = await persistentAgentsClient.GetAIAgentAsync(agentMetadata.Value.Id);
@@ -31,8 +31,8 @@ AIAgent weatherAgent = new AzureOpenAIClient(
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(instructions: "You are a helpful assistant who responds in French.", tools: [weatherAgent.AsAIFunction()]);
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(instructions: "You are a helpful assistant who responds in French.", tools: [weatherAgent.AsAIFunction()]);

 // Invoke the agent and output the text result.
 Console.WriteLine(await agent.RunAsync("What is the weather like in Amsterdam?"));
@@ -27,16 +27,13 @@ services.AddSingleton<AgentPlugin>(); // The plugin depends on WeatherProvider a

 IServiceProvider serviceProvider = services.BuildServiceProvider();

-const string AgentName = "Assistant";
-const string AgentInstructions = "You are a helpful assistant that helps people find information.";
-
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(
-        instructions: AgentInstructions,
-        name: AgentName,
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(
+        instructions: "You are a helpful assistant that helps people find information.",
+        name: "Assistant",
        tools: [.. serviceProvider.GetRequiredService<AgentPlugin>().AsAITools()],
        services: serviceProvider); // Pass the service provider to the agent so it will be available to plugin functions to resolve dependencies.

@@ -14,20 +14,17 @@ using OpenAI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o-mini";

-const string JokerName = "Joker";
-const string JokerInstructions = "You are good at telling jokes.";
-
 // Construct the agent, and provide a factory to create an in-memory chat message store with a reducer that keeps only the last 2 non-system messages.
 AIAgent agent = new AzureOpenAIClient(
    new Uri(endpoint),
    new AzureCliCredential())
-     .GetChatClient(deploymentName)
-     .CreateAIAgent(new ChatClientAgentOptions
-     {
-         Name = JokerName,
-         Instructions = JokerInstructions,
-         ChatMessageStoreFactory = ctx => new InMemoryChatMessageStore(new MessageCountingChatReducer(2), ctx.SerializedState, ctx.JsonSerializerOptions)
-     });
+    .GetChatClient(deploymentName)
+    .CreateAIAgent(new ChatClientAgentOptions
+    {
+        Instructions = "You are good at telling jokes.",
+        Name = "Joker",
+        ChatMessageStoreFactory = ctx => new InMemoryChatMessageStore(new MessageCountingChatReducer(2), ctx.SerializedState, ctx.JsonSerializerOptions)
+    });

 AgentThread thread = agent.GetNewThread();

@@ -9,9 +9,6 @@ using Microsoft.Agents.AI;
 var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_PROJECT_ENDPOINT is not set.");
 var model = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_MODEL_ID") ?? "gpt-4.1-mini";

-const string AgentName = "MicrosoftLearnAgent";
-const string AgentInstructions = "You answer questions by searching the Microsoft Learn content only.";
-
 // Get a client to create/retrieve server side agents with.
 var persistentAgentsClient = new PersistentAgentsClient(endpoint, new AzureCliCredential());

@@ -24,8 +21,8 @@ mcpTool.AllowedTools.Add("microsoft_docs_search");
 // Create a server side persistent agent with the Azure.AI.Agents.Persistent SDK.
 var agentMetadata = await persistentAgentsClient.Administration.CreateAgentAsync(
    model: model,
-    name: AgentName,
-    instructions: AgentInstructions,
+    name: "MicrosoftLearnAgent",
+    instructions: "You answer questions by searching the Microsoft Learn content only.",
    tools: [mcpTool]);

 // Retrieve an already created server side persistent agent as an AIAgent.