-
Notifications
You must be signed in to change notification settings - Fork 1.3k
.NET: Add File Search Sample for Foundry Agents. #3990
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
rogerbarreto
merged 6 commits into
microsoft:main
from
rogerbarreto:feature/3674-file-search
Feb 19, 2026
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
227fc9c
.NET: Add File Search sample #3674
rogerbarreto bd2df43
Merge branch 'main' of https://github.com/microsoft/agent-framework i…
rogerbarreto c5ad8ec
Add FileSearch sample to solution and parent README
rogerbarreto 573af2b
Refactor FileSearch sample: local functions + DefaultAzureCredential
rogerbarreto 9c4d0a9
Fix orphaned temp file in FileSearch sample
rogerbarreto 7a40f8a
Merge branch 'main' into feature/3674-file-search
rogerbarreto File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
...rted/FoundryAgents/FoundryAgents_Step18_FileSearch/FoundryAgents_Step18_FileSearch.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
111 changes: 111 additions & 0 deletions
111
dotnet/samples/GettingStarted/FoundryAgents/FoundryAgents_Step18_FileSearch/Program.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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]) | ||
| } | ||
| }) | ||
| ); | ||
| } | ||
52 changes: 52 additions & 0 deletions
52
.../samples/GettingStarted/FoundryAgents/FoundryAgents_Step18_FileSearch/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.