Merge pull request #4796 from aahill/petersamples

code updates

Author: v-dirichards

articles/ai-services/agents/how-to/tools/azure-ai-search-samples.md

@@ -136,112 +136,132 @@ print("Deleted agent")
 
 :::zone pivot="csharp"
 
-## Step 1: Create an Azure AI Client
-First, create an Azure AI Client using the connection string of your project.
+## Step 1: Create a project client
+Create a client object, which will contain the project endpoint for connecting to your AI project and other resources.
 
 ```csharp
+using Azure;
+using Azure.AI.Agents.Persistent;
+using Azure.Identity;
+using Microsoft.Extensions.Configuration;
 using System;
-using System.Threading.Tasks;
-using Azure.Core;
-using Azure.Core.TestFramework;
-using NUnit.Framework;
-using System.Collections.Generic;
-
-// Create an Azure AI Client from a connection string, copied from your Azure AI Foundry project.
-// At the moment, it should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<ProjectName>"
-// Customer needs to login to Azure subscription via Azure CLI and set the environment variables
-var connectionString = TestEnvironment.AzureAICONNECTIONSTRING;
-var clientOptions = new AIProjectClientOptions();
-
-// Adding the custom headers policy
-clientOptions.AddPolicy(new CustomHeadersPolicy(), HttpPipelinePosition.PerCall);
-var projectClient = new AIProjectClient(connectionString, new DefaultAzureCredential(), clientOptions);
-```
+using System.Threading;
 
-## Step 2: Get the connection ID for the Azure AI Search resource
-Get the connection ID of the Azure AI Search connection in the project.
+// Get Connection information from app configuration
+IConfigurationRoot configuration = new ConfigurationBuilder()
+    .SetBasePath(AppContext.BaseDirectory)
+    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
+    .Build();
 
-```csharp
-ListConnectionsResponse connections = await projectClient.GetConnectionsClient().GetConnectionsAsync(ConnectionType.AzureAISearch).ConfigureAwait(false);
+var projectEndpoint = configuration["ProjectEndpoint"];
+var modelDeploymentName = configuration["ModelDeploymentName"];
+var azureAiSearchConnectionId = configuration["AzureAiSearchConnectionId"];
 
-if (connections?.Value == null || connections.Value.Count == 0)
-{
-    throw new InvalidOperationException("No connections found for the Azure AI Search.");
-}
+// Create the Agent Client
+PersistentAgentsClient agentClient = new(projectEndpoint, new DefaultAzureCredential());
 ```
 
-## Step 3: Configure the Azure AI Search tool
-Using the connection ID you got in the previous step, you can now configure the Azure AI Search tool to use your Azure AI Search index.
+## Step 2: Configure the Azure AI Search tool
+Using the AI Search Connection ID, configure the Azure AI Search tool to use your Azure AI Search index.
 
 ```csharp
-// TO DO: replace this value with the connection ID of the search index
-ConnectionResponse connection = connections.Value[0];
+AzureAISearchResource searchResource = new(
+    indexConnectionId: azureAiSearchConnectionId,
+    indexName: "sample_index",
+    topK: 5,
+    filter: "category eq 'sleeping bag'",
+    queryType: AzureAISearchQueryType.Simple
+);
+
+ToolResources toolResource = new() { AzureAISearch = searchResource };
 
-// Initialize agent Azure AI search tool and add the search index connection ID and index name
-// TO DO: replace <your-index-name> with the name of the index you want to use
-ToolResources searchResource = new ToolResources
-{
-    AzureAISearch = new AzureAISearchResource
-    {
-        IndexList = { new IndexResource(connection.Id, "<your-index-name>", "<select-search-type>") }
-    }
-};
 ```
 
-## Step 4: Create an agent with the Azure AI Search tool enabled
+## Step 3: Create an agent with the Azure AI Search tool enabled
 Change the model to the one deployed in your project. You can find the model name in the Azure AI Foundry under the **Models** tab. You can also change the name and instructions of the agent to suit your needs.
 
 ```csharp
-AgentsClient agentClient = projectClient.GetAgentsClient();
-
-Response<Agent> agentResponse = await agentClient.CreateAgentAsync(
-    model: "gpt-4o-mini",
-    name: "my-assistant",
-    instructions: "You are a helpful assistant.",
-    tools: new List<ToolDefinition> { new AzureAISearchToolDefinition() },
-    toolResources: searchResource);
-Agent agent = agentResponse.Value;
+// Create an agent with Tools and Tool Resources
+PersistentAgent agent = agentClient.Administration.CreateAgent(
+    model: modelDeploymentName,
+    name: "my-agent",
+    instructions: "You are a helpful agent.",
+    tools: [new AzureAISearchToolDefinition()],
+    toolResources: toolResource);
+
 ```
 
-## Step 5: Ask the agent questions about data in the index
+## Step 4: Ask the agent questions about data in the index
 Now that the agent is created, ask it questions about the data in your Azure AI Search index.
 
 ```csharp
 // Create thread for communication
-Response<AgentThread> threadResponse = await agentClient.CreateThreadAsync();
-AgentThread thread = threadResponse.Value;
+PersistentAgentThread thread = agentClient.Threads.CreateThread();
 
-// Create message to thread
-Response<ThreadMessage> messageResponse = await agentClient.CreateMessageAsync(
+// Create message and run the agent
+ThreadMessage message = agentClient.Messages.CreateMessage(
     thread.Id,
     MessageRole.User,
-    "what are my health insurance plan coverage types?");
-ThreadMessage message = messageResponse.Value;
+    "What is the temperature rating of the cozynights sleeping bag?");
+ThreadRun run = agentClient.Runs.CreateRun(thread, agent);
+
+```
+
+## Step 4: Wait for the agent to complete and print the output
 
-// Run the agent
-Response<ThreadRun> runResponse = await agentClient.CreateRunAsync(thread, agent);
+Wait for the agent to complete the run and print output to console.
 
+```csharp
+// Wait for the agent to finish running
 do
 {
-    await Task.Delay(TimeSpan.FromMilliseconds(500));
-    runResponse = await agentClient.GetRunAsync(thread.Id, runResponse.Value.Id);
+    Thread.Sleep(TimeSpan.FromMilliseconds(500));
+    run = agentClient.Runs.GetRun(thread.Id, run.Id);
 }
-while (runResponse.Value.Status == RunStatus.Queued
-    || runResponse.Value.Status == RunStatus.InProgress);
+while (run.Status == RunStatus.Queued
+    || run.Status == RunStatus.InProgress);
 
-Response<PageableList<ThreadMessage>> afterRunMessagesResponse
-    = await agentClient.GetMessagesAsync(thread.Id);
-IReadOnlyList<ThreadMessage> messages = afterRunMessagesResponse.Value.Data;
+// Confirm that the run completed successfully
+if (run.Status != RunStatus.Completed)
+{
+    throw new Exception("Run did not complete successfully, error: " + run.LastError?.Message);
+}
+
+// Retrieve the messages from the agent client
+Pageable<ThreadMessage> messages = agentClient.Messages.GetMessages(
+    threadId: thread.Id,
+    order: ListSortOrder.Ascending
+);
 
-// Note: messages iterate from newest to oldest, with the messages[0] being the most recent
+// Process messages in order
 foreach (ThreadMessage threadMessage in messages)
 {
     Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
     foreach (MessageContent contentItem in threadMessage.ContentItems)
     {
         if (contentItem is MessageTextContent textItem)
         {
-            Console.Write(textItem.Text);
+            // We need to annotate only Agent messages.
+            if (threadMessage.Role == MessageRole.Agent && textItem.Annotations.Count > 0)
+            {
+                string annotatedText = textItem.Text;
+
+                // If we have Text URL citation annotations, reformat the response to show title & URL for citations
+                foreach (MessageTextAnnotation annotation in textItem.Annotations)
+                {
+                    if (annotation is MessageTextUrlCitationAnnotation urlAnnotation)
+                    {
+                        annotatedText = annotatedText.Replace(
+                            urlAnnotation.Text,
+                            $" [see {urlAnnotation.UrlCitation.Title}] ({urlAnnotation.UrlCitation.Url})");
+                    }
+                }
+                Console.Write(annotatedText);
+            }
+            else
+            {
+                Console.Write(textItem.Text);
+            }
         }
         else if (contentItem is MessageImageFileContent imageFileItem)
         {
@@ -250,6 +270,17 @@ foreach (ThreadMessage threadMessage in messages)
         Console.WriteLine();
     }
 }
+```
+## Step 5: Clean up resources
+
+Clean up the resources from this sample.
+
+```csharp
+
+// Delete thread and agent
+agentClient.Threads.DeleteThread(thread.Id);
+agentClient.Administration.DeleteAgent(agent.Id);
+
 ```
 
 :::zone-end

articles/ai-services/agents/how-to/tools/bing-code-samples.md

@@ -47,85 +47,96 @@ Use this article to find step-by-step instructions and code samples for Groundin
 ::: zone pivot="csharp"
 ## Step 1: Create a project client
 
-Create a client object, which will contain the connection string for connecting to your AI project and other resources.
+Create a client object, which will contain the project endpoint for connecting to your AI project and other resources.
 
 ```csharp
+using Azure;
+using Azure.AI.Agents.Persistent;
+using Azure.Identity;
+using Microsoft.Extensions.Configuration;
 using System;
-using System.Collections.Generic;
-using System.Threading.Tasks;
-using Azure.Core;
-using Azure.Core.TestFramework;
-using NUnit.Framework;
+using System.Threading;
 
-var connectionString = System.Environment.GetEnvironmentVariable("PROJECT_CONNECTION_STRING");
-var modelDeploymentName = System.Environment.GetEnvironmentVariable("MODEL_DEPLOYMENT_NAME");
-var bingConnectionName = System.Environment.GetEnvironmentVariable("BING_CONNECTION_NAME");
+// Get Connection information from app configuration
+IConfigurationRoot configuration = new ConfigurationBuilder()
+    .SetBasePath(AppContext.BaseDirectory)
+    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
+    .Build();
 
-var projectClient = new AIProjectClient(connectionString, new DefaultAzureCredential());
+var projectEndpoint = configuration["ProjectEndpoint"];
+var modelDeploymentName = configuration["ModelDeploymentName"];
+var bingConnectionId = configuration["BingConnectionId"];
 
-AgentsClient agentClient = projectClient.GetAgentsClient();
+// Create the Agent Client
+PersistentAgentsClient agentClient = new(projectEndpoint, new DefaultAzureCredential());
 ```
 
 ## Step 2: Create an Agent with the Grounding with Bing search tool enabled
 
 To make the Grounding with Bing search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
 
 ```csharp
-ConnectionResponse bingConnection = projectClient.GetConnectionsClient().GetConnection(bingConnectionName);
-var connectionId = bingConnection.Id;
+// Create the BingGroundingToolDefinition object used when creating the agent
+BingGroundingToolDefinition bingGroundingTool = new BingGroundingToolDefinition(
+    new BingGroundingSearchConfigurationList(
+        [
+            new BingGroundingSearchConfiguration(bingConnectionId)
+        ]
+    )
+);
 
-ToolConnectionList connectionList = new()
-{
-    ConnectionList = { new ToolConnection(connectionId) }
-};
-BingGroundingToolDefinition bingGroundingTool = new(connectionList);
-
-Agent agent = agentClient.CreateAgent(
-   model: modelDeploymentName,
-   name: "my-assistant",
-   instructions: "You are a helpful assistant.",
-   tools: [bingGroundingTool]);
+// Create the Agent
+PersistentAgent agent = agentClient.Administration.CreateAgent(
+    model: modelDeploymentName,
+    name: "my-agent",
+    instructions: "You are a helpful agent.",
+    tools: [bingGroundingTool]
+);
 ```
 
-## Step 3: Create a thread
+## Step 3: Create a thread and run
 
 ```csharp
-AgentThread thread = agentClient.CreateThread();
+PersistentAgentThread thread = agentClient.Threads.CreateThread();
 
-// Create message to thread
-ThreadMessage message = agentClient.CreateMessage(
+// Create message and run the agent
+ThreadMessage message = agentClient.Messages.CreateMessage(
     thread.Id,
     MessageRole.User,
     "How does wikipedia explain Euler's Identity?");
-```
 
-## Step 4: Create a run and check the output
+ThreadRun run = agentClient.Runs.CreateRun(thread, agent);
 
-Create a run and observe that the model uses the Grounding with Bing Search tool to provide a response to the user's question.
+```
 
+## Step 4: Wait for the agent to complete and print the output
+
+Wait for the agent to complete the run and print output to console. Observe that the model uses the Grounding with Bing Search tool to provide a response to the user's question.
 
 ```csharp
 
-// Run the agent
-ThreadRun run = agentClient.CreateRun(thread, agent);
+// Wait for the agent to finish running
 do
 {
     Thread.Sleep(TimeSpan.FromMilliseconds(500));
-    run = agentClient.GetRun(thread.Id, run.Id);
+    run = agentClient.Runs.GetRun(thread.Id, run.Id);
 }
 while (run.Status == RunStatus.Queued
     || run.Status == RunStatus.InProgress);
 
-Assert.AreEqual(
-    RunStatus.Completed,
-    run.Status,
-    run.LastError?.Message);
+// Confirm that the run completed successfully
+if (run.Status != RunStatus.Completed)
+{
+    throw new Exception("Run did not complete successfully, error: " + run.LastError?.Message);
+}
 
-PageableList<ThreadMessage> messages = agentClient.GetMessages(
+// Retrieve all messages from the agent client
+Pageable<ThreadMessage> messages = agentClient.Messages.GetMessages(
     threadId: thread.Id,
     order: ListSortOrder.Ascending
 );
 
+// Process messages in order
 foreach (ThreadMessage threadMessage in messages)
 {
     Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
@@ -134,13 +145,16 @@ foreach (ThreadMessage threadMessage in messages)
         if (contentItem is MessageTextContent textItem)
         {
             string response = textItem.Text;
+
+            // If we have Text URL citation annotations, reformat the response to show title & URL for citations
             if (textItem.Annotations != null)
             {
                 foreach (MessageTextAnnotation annotation in textItem.Annotations)
                 {
                     if (annotation is MessageTextUrlCitationAnnotation urlAnnotation)
                     {
-                        response = response.Replace(urlAnnotation.Text, $" [{urlAnnotation.UrlCitation.Title}]({urlAnnotation.UrlCitation.Url})");
+                        response = response.Replace(urlAnnotation.Text, 
+                            $" [{urlAnnotation.UrlCitation.Title}]({urlAnnotation.UrlCitation.Url})");
                     }
                 }
             }
@@ -154,8 +168,18 @@ foreach (ThreadMessage threadMessage in messages)
     }
 }
 
-agentClient.DeleteThread(threadId: thread.Id);
-agentClient.DeleteAgent(agentId: agent.Id);
+```
+
+## Step 5: Clean up resources
+
+Clean up the resources from this sample.
+
+```csharp
+
+// Delete thread and agent
+agentClient.Threads.DeleteThread(threadId: thread.Id);
+agentClient.Administration.DeleteAgent(agentId: agent.Id);
+
 ```
 
 ::: zone-end