Merge pull request #4995 from petehauge/update-samples-May16

thomps23 · web-flow · commit e993c253a8c6 · 2025-05-17T09:10:28.000-07:00
Update samples with latest SDK details - ask mode approved merge
diff --git a/articles/ai-services/agents/how-to/tools/azure-ai-search-samples.md b/articles/ai-services/agents/how-to/tools/azure-ai-search-samples.md
@@ -165,7 +165,7 @@ PersistentAgentsClient agentClient = new(projectEndpoint, new DefaultAzureCreden
 Using the AI Search Connection ID, configure the Azure AI Search tool to use your Azure AI Search index.
 
 ```csharp
-AzureAISearchResource searchResource = new(
+AzureAISearchToolResource searchResource = new(
     indexConnectionId: azureAiSearchConnectionId,
     indexName: "sample_index",
     topK: 5,
@@ -185,9 +185,10 @@ Change the model to the one deployed in your project. You can find the model nam
 PersistentAgent agent = agentClient.Administration.CreateAgent(
     model: modelDeploymentName,
     name: "my-agent",
-    instructions: "You are a helpful agent.",
+    instructions: "Use the index provided to answer questions.",
     tools: [new AzureAISearchToolDefinition()],
-    toolResources: toolResource);
+    toolResources: toolResource
+);
 
 ```
 
@@ -199,7 +200,7 @@ Now that the agent is created, ask it questions about the data in your Azure AI
 PersistentAgentThread thread = agentClient.Threads.CreateThread();
 
 // Create message and run the agent
-ThreadMessage message = agentClient.Messages.CreateMessage(
+PersistentThreadMessage message = agentClient.Messages.CreateMessage(
     thread.Id,
     MessageRole.User,
     "What is the temperature rating of the cozynights sleeping bag?");
@@ -228,13 +229,13 @@ if (run.Status != RunStatus.Completed)
 }
 
 // Retrieve the messages from the agent client
-Pageable<ThreadMessage> messages = agentClient.Messages.GetMessages(
+Pageable<PersistentThreadMessage> messages = agentClient.Messages.GetMessages(
     threadId: thread.Id,
     order: ListSortOrder.Ascending
 );
 
 // Process messages in order
-foreach (ThreadMessage threadMessage in messages)
+foreach (PersistentThreadMessage threadMessage in messages)
 {
     Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
     foreach (MessageContent contentItem in threadMessage.ContentItems)
@@ -249,11 +250,11 @@ foreach (ThreadMessage threadMessage in messages)
                 // 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)
+                    if (annotation is MessageTextUriCitationAnnotation urlAnnotation)
                     {
                         annotatedText = annotatedText.Replace(
                             urlAnnotation.Text,
-                            $" [see {urlAnnotation.UrlCitation.Title}] ({urlAnnotation.UrlCitation.Url})");
+                            $" [see {urlAnnotation.UriCitation.Title}] ({urlAnnotation.UriCitation.Uri})");
                     }
                 }
                 Console.Write(annotatedText);
@@ -270,14 +271,45 @@ foreach (ThreadMessage threadMessage in messages)
         Console.WriteLine();
     }
 }
+```
+
+## Optionally output the run steps used by the agent
+
+```csharp
+// Retrieve the run steps used by the agent and print those to the console
+Console.WriteLine("Run Steps used by Agent:");
+Pageable<RunStep> runSteps = agentClient.Runs.GetRunSteps(run);
+
+foreach (var step in runSteps)
+{
+    Console.WriteLine($"Step ID: {step.Id}, Total Tokens: {step.Usage.TotalTokens}, Status: {step.Status}, Type: {step.Type}");
+
+    if (step.StepDetails is RunStepMessageCreationDetails messageCreationDetails)
+    {
+        Console.WriteLine($"   Message Creation Id: {messageCreationDetails.MessageCreation.MessageId}");
+    }
+    else if (step.StepDetails is RunStepToolCallDetails toolCallDetails)
+    {
+        // We know this agent only has the AI Search tool, so we can cast it directly
+        foreach (RunStepAzureAISearchToolCall toolCall in toolCallDetails.ToolCalls)
+        {
+            Console.WriteLine($"   Tool Call Details: {toolCall.GetType()}");
+
+            foreach (var result in toolCall.AzureAISearch)
+            { 
+                Console.WriteLine($"      {result.Key}: {result.Value}");
+            }
+        }
+    }
+}
+
 ```
 ## Clean up resources
 
 Clean up the resources from this sample.
 
 ```csharp
-
-// Delete thread and agent
+// Clean up resources
 agentClient.Threads.DeleteThread(thread.Id);
 agentClient.Administration.DeleteAgent(agent.Id);
 
diff --git a/articles/ai-services/agents/how-to/tools/bing-code-samples.md b/articles/ai-services/agents/how-to/tools/bing-code-samples.md
@@ -168,7 +168,7 @@ To make the Grounding with Bing search tool available to your agent, use a conne
 ```csharp
 // Create the BingGroundingToolDefinition object used when creating the agent
 BingGroundingToolDefinition bingGroundingTool = new BingGroundingToolDefinition(
-    new BingGroundingSearchConfigurationList(
+    new BingGroundingSearchToolParameters(
         [
             new BingGroundingSearchConfiguration(bingConnectionId)
         ]
@@ -179,7 +179,7 @@ BingGroundingToolDefinition bingGroundingTool = new BingGroundingToolDefinition(
 PersistentAgent agent = agentClient.Administration.CreateAgent(
     model: modelDeploymentName,
     name: "my-agent",
-    instructions: "You are a helpful agent.",
+    instructions: "Use the bing grounding tool to answer questions.",
     tools: [bingGroundingTool]
 );
 ```
@@ -190,11 +190,10 @@ PersistentAgent agent = agentClient.Administration.CreateAgent(
 PersistentAgentThread thread = agentClient.Threads.CreateThread();
 
 // Create message and run the agent
-ThreadMessage message = agentClient.Messages.CreateMessage(
+PersistentThreadMessage message = agentClient.Messages.CreateMessage(
     thread.Id,
     MessageRole.User,
     "How does wikipedia explain Euler's Identity?");
-
 ThreadRun run = agentClient.Runs.CreateRun(thread, agent);
 
 ```
@@ -204,7 +203,6 @@ ThreadRun run = agentClient.Runs.CreateRun(thread, agent);
 First, wait for the agent to complete the run by polling its status. Observe that the model uses the Grounding with Bing Search tool to provide a response to the user's question.
 
 ```csharp
-
 // Wait for the agent to finish running
 do
 {
@@ -225,13 +223,13 @@ Then, retrieve and process the messages from the completed run.
 
 ```csharp
 // Retrieve all messages from the agent client
-Pageable<ThreadMessage> messages = agentClient.Messages.GetMessages(
+Pageable<PersistentThreadMessage> messages = agentClient.Messages.GetMessages(
     threadId: thread.Id,
     order: ListSortOrder.Ascending
 );
 
 // Process messages in order
-foreach (ThreadMessage threadMessage in messages)
+foreach (PersistentThreadMessage threadMessage in messages)
 {
     Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
     foreach (MessageContent contentItem in threadMessage.ContentItems)
@@ -245,10 +243,9 @@ foreach (ThreadMessage threadMessage in messages)
             {
                 foreach (MessageTextAnnotation annotation in textItem.Annotations)
                 {
-                    if (annotation is MessageTextUrlCitationAnnotation urlAnnotation)
+                    if (annotation is MessageTextUriCitationAnnotation urlAnnotation)
                     {
-                        response = response.Replace(urlAnnotation.Text, 
-                            $" [{urlAnnotation.UrlCitation.Title}]({urlAnnotation.UrlCitation.Url})");
+                        response = response.Replace(urlAnnotation.Text, $" [{urlAnnotation.UriCitation.Title}]({urlAnnotation.UriCitation.Uri})");
                     }
                 }
             }
@@ -264,16 +261,46 @@ foreach (ThreadMessage threadMessage in messages)
 
 ```
 
+## Optionally output the run steps used by the agent
+
+```csharp
+// Retrieve the run steps used by the agent and print those to the console
+Console.WriteLine("Run Steps used by Agent:");
+Pageable<RunStep> runSteps = agentClient.Runs.GetRunSteps(run);
+
+foreach (var step in runSteps)
+{
+    Console.WriteLine($"Step ID: {step.Id}, Total Tokens: {step.Usage.TotalTokens}, Status: {step.Status}, Type: {step.Type}");
+
+    if (step.StepDetails is RunStepMessageCreationDetails messageCreationDetails)
+    {
+        Console.WriteLine($"   Message Creation Id: {messageCreationDetails.MessageCreation.MessageId}");
+    }
+    else if (step.StepDetails is RunStepToolCallDetails toolCallDetails)
+    {
+        // We know this agent only has the Bing Grounding tool, so we can cast it directly
+        foreach (RunStepBingGroundingToolCall toolCall in toolCallDetails.ToolCalls)
+        {
+            Console.WriteLine($"   Tool Call Details: {toolCall.GetType()}");
+
+            foreach (var result in toolCall.BingGrounding)
+            {
+                Console.WriteLine($"      {result.Key}: {result.Value}");
+            }
+        }
+    }
+}
+
+```
+
 ## 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
diff --git a/articles/ai-services/agents/how-to/tools/file-search-upload-files.md b/articles/ai-services/agents/how-to/tools/file-search-upload-files.md
@@ -205,7 +205,7 @@ Dictionary<string, string> fileIds = new()
 // Create a vector store with the file and wait for it to be processed.
 // If you do not specify a vector store, CreateMessage will create a vector
 // store with a default expiration policy of seven days after they were last active
-VectorStore vectorStore = agentClient.VectorStores.CreateVectorStore(
+PersistentAgentsVectorStore vectorStore = agentClient.VectorStores.CreateVectorStore(
     fileIds: new List<string> { uploadedAgentFile.Id },
     name: "my_vector_store");
 
@@ -238,7 +238,7 @@ You can also attach files as Message attachments on your thread. Doing so create
 PersistentAgentThread thread = agentClient.Threads.CreateThread();
 
 // Create message and run the agent
-ThreadMessage messageResponse = agentClient.Messages.CreateMessage(
+PersistentThreadMessage messageResponse = agentClient.Messages.CreateMessage(
     thread.Id,
     MessageRole.User,
     "Can you give me the documented codes for 'banana' and 'orange'?");
@@ -273,7 +273,7 @@ Once the run is complete, retrieve the messages from the thread and process them
 
 ```csharp
 // Retrieve all messages from the agent client
-Pageable<ThreadMessage> messages = agentClient.Messages.GetMessages(
+Pageable<PersistentThreadMessage> messages = agentClient.Messages.GetMessages(
     threadId: thread.Id,
     order: ListSortOrder.Ascending
 );
@@ -288,7 +288,7 @@ static string replaceReferences(Dictionary<string, string> fileIds, string fileI
 }
 
 // Process messages in order
-foreach (ThreadMessage threadMessage in messages)
+foreach (PersistentThreadMessage threadMessage in messages)
 {
     Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
 
