.NET: Add File Search Sample for Foundry Agents. (#3990)

* .NET: Add File Search sample #3674 * Add FileSearch sample to solution and parent README - Add FoundryAgents_Step18_FileSearch to agent-framework-dotnet.slnx - Add FileSearch entry to FoundryAgents samples table in README.md - Fix README inaccuracy: sample creates one agent, not two Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refactor FileSearch sample: local functions + DefaultAzureCredential - Refactor agent creation into switchable local functions - Use DefaultAzureCredential with WARNING comment (matching other samples) - Update README to reference DefaultAzureCredential Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix orphaned temp file in FileSearch sample Use Path.Combine + Path.GetRandomFileName instead of Path.GetTempFileName to avoid leaving an orphaned temp file on disk. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-16 21:04:09 +08:00 · 2026-02-19 10:36:43 +00:00
parent c3eca2567a
commit 5aa05ebe29
5 changed files with 187 additions and 0 deletions
@@ -176,6 +176,7 @@
    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Step13_Plugins/FoundryAgents_Step13_Plugins.csproj" />
    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Step14_CodeInterpreter/FoundryAgents_Step14_CodeInterpreter.csproj" />
    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Step15_ComputerUse/FoundryAgents_Step15_ComputerUse.csproj" />
+    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Step18_FileSearch/FoundryAgents_Step18_FileSearch.csproj" />
    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Evaluations_Step01_RedTeaming/FoundryAgents_Evaluations_Step01_RedTeaming.csproj" />
    <Project Path="samples/GettingStarted/FoundryAgents/FoundryAgents_Evaluations_Step02_SelfReflection/FoundryAgents_Evaluations_Step02_SelfReflection.csproj" />
  </Folder>
@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>net10.0</TargetFrameworks>
+
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <NoWarn>$(NoWarn);CA1812</NoWarn>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="Azure.AI.Projects" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.AzureAI\Microsoft.Agents.AI.AzureAI.csproj" />
+  </ItemGroup>
+  
+</Project>
@@ -0,0 +1,111 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample shows how to use File Search Tool with AI Agents.
+
+using Azure.AI.Projects;
+using Azure.AI.Projects.OpenAI;
+using Azure.Identity;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using OpenAI.Assistants;
+using OpenAI.Files;
+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 search through uploaded files to answer questions.";
+
+// Get a client to create/retrieve/delete server side agents with Azure Foundry Agents.
+// WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
+// In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
+// latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
+AIProjectClient aiProjectClient = new(new Uri(endpoint), new DefaultAzureCredential());
+var projectOpenAIClient = aiProjectClient.GetProjectOpenAIClient();
+var filesClient = projectOpenAIClient.GetProjectFilesClient();
+var vectorStoresClient = projectOpenAIClient.GetProjectVectorStoresClient();
+
+// 1. Create a temp file with test content and upload it.
+string searchFilePath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName() + "_lookup.txt");
+File.WriteAllText(
+    path: searchFilePath,
+    contents: """
+        Employee Directory:
+        - Alice Johnson, 28 years old, Software Engineer, Engineering Department
+        - Bob Smith, 35 years old, Sales Manager, Sales Department
+        - Carol Williams, 42 years old, HR Director, Human Resources Department
+        - David Brown, 31 years old, Customer Support Lead, Support Department
+        """
+);
+
+Console.WriteLine($"Uploading file: {searchFilePath}");
+OpenAIFile uploadedFile = filesClient.UploadFile(
+    filePath: searchFilePath,
+    purpose: FileUploadPurpose.Assistants
+);
+Console.WriteLine($"Uploaded file, file ID: {uploadedFile.Id}");
+
+// 2. Create a vector store with the uploaded file.
+var vectorStoreResult = await vectorStoresClient.CreateVectorStoreAsync(
+    options: new() { FileIds = { uploadedFile.Id }, Name = "EmployeeDirectory_VectorStore" }
+);
+string vectorStoreId = vectorStoreResult.Value.Id;
+Console.WriteLine($"Created vector store, vector store ID: {vectorStoreId}");
+
+AIAgent agent = await CreateAgentWithMEAI();
+// AIAgent agent = await CreateAgentWithNativeSDK();
+
+// Run the agent
+Console.WriteLine("\n--- Running File Search Agent ---");
+AgentResponse response = await agent.RunAsync("Who is the youngest employee?");
+Console.WriteLine($"Response: {response}");
+
+// Getting any file citation annotations generated by the tool
+foreach (AIAnnotation annotation in response.Messages.SelectMany(m => m.Contents).SelectMany(c => c.Annotations ?? []))
+{
+    if (annotation.RawRepresentation is TextAnnotationUpdate citationAnnotation)
+    {
+        Console.WriteLine($$"""
+            File Citation:
+              File Id: {{citationAnnotation.OutputFileId}}
+              Text to Replace: {{citationAnnotation.TextToReplace}}
+            """);
+    }
+}
+
+// Cleanup.
+Console.WriteLine("\n--- Cleanup ---");
+await aiProjectClient.Agents.DeleteAgentAsync(agent.Name);
+await vectorStoresClient.DeleteVectorStoreAsync(vectorStoreId);
+await filesClient.DeleteFileAsync(uploadedFile.Id);
+File.Delete(searchFilePath);
+Console.WriteLine("Cleanup completed successfully.");
+
+// --- Agent Creation Options ---
+
+#pragma warning disable CS8321 // Local function is declared but never used
+// Option 1 - Using HostedFileSearchTool (MEAI + AgentFramework)
+async Task<AIAgent> CreateAgentWithMEAI()
+{
+    return await aiProjectClient.CreateAIAgentAsync(
+        model: deploymentName,
+        name: "FileSearchAgent-MEAI",
+        instructions: AgentInstructions,
+        tools: [new HostedFileSearchTool() { Inputs = [new HostedVectorStoreContent(vectorStoreId)] }]);
+}
+
+// Option 2 - Using PromptAgentDefinition with ResponseTool.CreateFileSearchTool (Native SDK)
+async Task<AIAgent> CreateAgentWithNativeSDK()
+{
+    return await aiProjectClient.CreateAIAgentAsync(
+        name: "FileSearchAgent-NATIVE",
+        creationOptions: new AgentVersionCreationOptions(
+            new PromptAgentDefinition(model: deploymentName)
+            {
+                Instructions = AgentInstructions,
+                Tools = {
+                    ResponseTool.CreateFileSearchTool(vectorStoreIds: [vectorStoreId])
+                }
+            })
+    );
+}
@@ -0,0 +1,52 @@
+# Using File Search with AI Agents
+
+This sample demonstrates how to use the file search tool with AI agents. The file search tool allows agents to search through uploaded files stored in vector stores to answer user questions.
+
+## What this sample demonstrates
+
+- Uploading files and creating vector stores
+- Creating agents with file search capabilities
+- Using HostedFileSearchTool (MEAI abstraction)
+- Using native SDK file search tools (ResponseTool.CreateFileSearchTool)
+- Handling file citation annotations
+- Managing agent and resource lifecycle (creation and deletion)
+
+## Prerequisites
+
+Before you begin, ensure you have the following prerequisites:
+
+- .NET 10 SDK or later
+- Azure Foundry service endpoint and deployment configured
+- Azure CLI installed and authenticated (for Azure credential authentication)
+
+**Note**: This demo uses `DefaultAzureCredential` for authentication. For local development, make sure you're logged in with `az login` and have access to the Azure Foundry resource. For more information, see the [Azure Identity documentation](https://learn.microsoft.com/dotnet/api/azure.identity.defaultazurecredential).
+
+Set the following environment variables:
+
+```powershell
+$env:AZURE_FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Azure Foundry resource endpoint
+$env:AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME="gpt-4o-mini"  # Optional, defaults to gpt-4o-mini
+```
+
+## Run the sample
+
+Navigate to the FoundryAgents sample directory and run:
+
+```powershell
+cd dotnet/samples/GettingStarted/FoundryAgents
+dotnet run --project .\FoundryAgents_Step18_FileSearch
+```
+
+## Expected behavior
+
+The sample will:
+
+1. Create a temporary text file with employee directory information
+2. Upload the file to Azure Foundry
+3. Create a vector store with the uploaded file
+4. Create an agent with file search capabilities using one of:
+   - Option 1: Using HostedFileSearchTool (MEAI abstraction)
+   - Option 2: Using native SDK file search tools
+5. Run a query against the agent to search through the uploaded file
+6. Display file citation annotations from responses
+7. Clean up resources (agent, vector store, and uploaded file)
@@ -58,6 +58,7 @@ Before you begin, ensure you have the following prerequisites:
 |[Using plugins](./FoundryAgents_Step13_Plugins/)|This sample demonstrates how to use plugins with a Foundry agent|
 |[Code interpreter](./FoundryAgents_Step14_CodeInterpreter/)|This sample demonstrates how to use the code interpreter tool with a Foundry agent|
 |[Computer use](./FoundryAgents_Step15_ComputerUse/)|This sample demonstrates how to use computer use capabilities with a Foundry agent|
+|[File search](./FoundryAgents_Step18_FileSearch/)|This sample demonstrates how to use the file search tool with a Foundry agent|
 |[Local MCP](./FoundryAgents_Step27_LocalMCP/)|This sample demonstrates how to use a local MCP client with a Foundry agent|

 ## Evaluation Samples