Use RunStepFileSearchToolCallResults instead of a string in search tool deserialization step during streaming. (Azure#48344)

nick863 · web-flow · commit f01e2fe18ead · 2025-02-19T14:14:20.000-08:00
* Add unit test

* Fix deserialization of a streaming response from the file search tool.

* Record new tests and update changelog
diff --git a/sdk/ai/Azure.AI.Projects/CHANGELOG.md b/sdk/ai/Azure.AI.Projects/CHANGELOG.md
@@ -9,6 +9,7 @@
 ### Bugs Fixed
 
 * Fixed deserialization failure for AzureBlobStorage connection [issue](https://github.com/Azure/azure-sdk-for-net/issues/47874)
+* Fixed a bug on deserialization of RunStepDeltaFileSearchToolCall [issue](https://github.com/Azure/azure-sdk-for-net/issues/48333)
 
 ### Other Changes
 
diff --git a/sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.net8.0.cs b/sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.net8.0.cs
@@ -528,7 +528,7 @@ public static partial class AIProjectsModelFactory
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterLogOutput RunStepDeltaCodeInterpreterLogOutput(int index = 0, string logs = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterOutput RunStepDeltaCodeInterpreterOutput(int index = 0, string type = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterToolCall RunStepDeltaCodeInterpreterToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepDeltaCodeInterpreterDetailItemObject codeInterpreter = null) { throw null; }
-        public static Azure.AI.Projects.RunStepDeltaFileSearchToolCall RunStepDeltaFileSearchToolCall(int index = 0, string id = null, System.Collections.Generic.IReadOnlyDictionary<string, string> fileSearch = null) { throw null; }
+        public static Azure.AI.Projects.RunStepDeltaFileSearchToolCall RunStepDeltaFileSearchToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepFileSearchToolCallResults fileSearch = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaFunction RunStepDeltaFunction(string name = null, string arguments = null, string output = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaFunctionToolCall RunStepDeltaFunctionToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepDeltaFunction function = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaMessageCreation RunStepDeltaMessageCreation(Azure.AI.Projects.RunStepDeltaMessageCreationObject messageCreation = null) { throw null; }
@@ -2070,7 +2070,7 @@ protected virtual void JsonModelWriteCore(System.Text.Json.Utf8JsonWriter writer
     public partial class RunStepDeltaFileSearchToolCall : Azure.AI.Projects.RunStepDeltaToolCall, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>
     {
         internal RunStepDeltaFileSearchToolCall() : base (default(int), default(string)) { }
-        public System.Collections.Generic.IReadOnlyDictionary<string, string> FileSearch { get { throw null; } }
+        public Azure.AI.Projects.RunStepFileSearchToolCallResults FileSearch { get { throw null; } }
         protected override void JsonModelWriteCore(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
         Azure.AI.Projects.RunStepDeltaFileSearchToolCall System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>.Create(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
         void System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>.Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
diff --git a/sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.netstandard2.0.cs b/sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.netstandard2.0.cs
@@ -528,7 +528,7 @@ public static partial class AIProjectsModelFactory
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterLogOutput RunStepDeltaCodeInterpreterLogOutput(int index = 0, string logs = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterOutput RunStepDeltaCodeInterpreterOutput(int index = 0, string type = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaCodeInterpreterToolCall RunStepDeltaCodeInterpreterToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepDeltaCodeInterpreterDetailItemObject codeInterpreter = null) { throw null; }
-        public static Azure.AI.Projects.RunStepDeltaFileSearchToolCall RunStepDeltaFileSearchToolCall(int index = 0, string id = null, System.Collections.Generic.IReadOnlyDictionary<string, string> fileSearch = null) { throw null; }
+        public static Azure.AI.Projects.RunStepDeltaFileSearchToolCall RunStepDeltaFileSearchToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepFileSearchToolCallResults fileSearch = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaFunction RunStepDeltaFunction(string name = null, string arguments = null, string output = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaFunctionToolCall RunStepDeltaFunctionToolCall(int index = 0, string id = null, Azure.AI.Projects.RunStepDeltaFunction function = null) { throw null; }
         public static Azure.AI.Projects.RunStepDeltaMessageCreation RunStepDeltaMessageCreation(Azure.AI.Projects.RunStepDeltaMessageCreationObject messageCreation = null) { throw null; }
@@ -2070,7 +2070,7 @@ protected virtual void JsonModelWriteCore(System.Text.Json.Utf8JsonWriter writer
     public partial class RunStepDeltaFileSearchToolCall : Azure.AI.Projects.RunStepDeltaToolCall, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>
     {
         internal RunStepDeltaFileSearchToolCall() : base (default(int), default(string)) { }
-        public System.Collections.Generic.IReadOnlyDictionary<string, string> FileSearch { get { throw null; } }
+        public Azure.AI.Projects.RunStepFileSearchToolCallResults FileSearch { get { throw null; } }
         protected override void JsonModelWriteCore(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
         Azure.AI.Projects.RunStepDeltaFileSearchToolCall System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>.Create(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
         void System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaFileSearchToolCall>.Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
diff --git a/sdk/ai/Azure.AI.Projects/assets.json b/sdk/ai/Azure.AI.Projects/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/ai/Azure.AI.Projects",
-  "Tag": "net/ai/Azure.AI.Projects_c34fc3243d"
+  "Tag": "net/ai/Azure.AI.Projects_8d76f03633"
 }
diff --git a/sdk/ai/Azure.AI.Projects/src/Generated/AIProjectsModelFactory.cs b/sdk/ai/Azure.AI.Projects/src/Generated/AIProjectsModelFactory.cs
diff --git a/sdk/ai/Azure.AI.Projects/src/Generated/RunStepDeltaFileSearchToolCall.Serialization.cs b/sdk/ai/Azure.AI.Projects/src/Generated/RunStepDeltaFileSearchToolCall.Serialization.cs
diff --git a/sdk/ai/Azure.AI.Projects/src/Generated/RunStepDeltaFileSearchToolCall.cs b/sdk/ai/Azure.AI.Projects/src/Generated/RunStepDeltaFileSearchToolCall.cs
diff --git a/sdk/ai/Azure.AI.Projects/tests/AgentClientTests.cs b/sdk/ai/Azure.AI.Projects/tests/AgentClientTests.cs
@@ -26,6 +26,7 @@ public class AgentClientTests : RecordedTestBase<AIProjectsTestEnvironment>
         private const string TEMP_DIR = "cs_e2e_temp_dir";
 
         private const string FILE_UPLOAD_CONSTRAINT = "The file is being uploaded as a multipart multipart/form-data, which cannot be recorded.";
+        private const string STREAMING_CONSTRAINT = "The test framework does not support iteration of stream in Sync mode.";
 
         public AgentClientTests(bool isAsync) : base(isAsync) {
             TestDiagnostics = false;
@@ -617,16 +618,24 @@ public async Task TestSubmitToolOutputs(ArgumentType argType, bool parallelToolC
         }
 
         [RecordedTest]
-        [TestCase(VecrorStoreTestType.JustVectorStore, true)]
-        [TestCase(VecrorStoreTestType.Batch, true)]
-        [TestCase(VecrorStoreTestType.File, true)]
-        [TestCase(VecrorStoreTestType.JustVectorStore, false)]
-        [TestCase(VecrorStoreTestType.Batch, false)]
-        [TestCase(VecrorStoreTestType.File, false)]
-        public async Task TestCreateVectorStore(VecrorStoreTestType testType, bool useFileSource)
+        [TestCase(VecrorStoreTestType.JustVectorStore, true, false)]
+        [TestCase(VecrorStoreTestType.Batch, true, false)]
+        [TestCase(VecrorStoreTestType.File, true, false)]
+        [TestCase(VecrorStoreTestType.JustVectorStore, false, false)]
+        [TestCase(VecrorStoreTestType.Batch, false, false)]
+        [TestCase(VecrorStoreTestType.File, false, false)]
+        [TestCase(VecrorStoreTestType.JustVectorStore, true, true)]
+        [TestCase(VecrorStoreTestType.Batch, true, true)]
+        [TestCase(VecrorStoreTestType.File, true, true)]
+        [TestCase(VecrorStoreTestType.JustVectorStore, false, true)]
+        [TestCase(VecrorStoreTestType.Batch, false, true)]
+        [TestCase(VecrorStoreTestType.File, false, true)]
+        public async Task TestCreateVectorStore(VecrorStoreTestType testType, bool useFileSource, bool useStreaming)
         {
             if (useFileSource && Mode != RecordedTestMode.Live)
                 Assert.Inconclusive(FILE_UPLOAD_CONSTRAINT);
+            if (useStreaming && !IsAsync)
+                Assert.Inconclusive(STREAMING_CONSTRAINT);
             AgentsClient client = GetClient();
             VectorStore vectorStore;
 
@@ -693,11 +702,29 @@ await client.CreateVectorStoreFileAsync(
                 role: MessageRole.User,
                 content: "What does the attachment say?"
             ));
-            ThreadRun fileSearchRun = await client.CreateThreadAndRunAsync(
-                assistantId: agent.Id,
-                thread: threadOp
-            );
-            fileSearchRun = await WaitForRun(client, fileSearchRun);
+            ThreadRun fileSearchRun = default;
+            if (useStreaming)
+            {
+                AgentThread thread = await client.CreateThreadAsync(messages: [new ThreadMessageOptions(
+                    role: MessageRole.User,
+                    content: "What does the attachment say?"
+                )]);
+                await foreach (StreamingUpdate streamingUpdate in client.CreateRunStreamingAsync(thread.Id, agent.Id))
+                {
+                    if (streamingUpdate is RunUpdate runUpdate)
+                        fileSearchRun = runUpdate.Value;
+                }
+                Assert.AreEqual(RunStatus.Completed, fileSearchRun.Status, fileSearchRun.LastError?.ToString());
+            }
+            else
+            {
+                fileSearchRun = await client.CreateThreadAndRunAsync(
+                    assistantId: agent.Id,
+                    thread: threadOp
+                );
+                fileSearchRun = await WaitForRun(client, fileSearchRun);
+            }
+            Assert.IsNotNull(fileSearchRun);
             PageableList<ThreadMessage> messages = await client.GetMessagesAsync(fileSearchRun.ThreadId, fileSearchRun.Id);
             Assert.Greater(messages.Data.Count, 1);
             // Check list, get and delete operations.
@@ -892,7 +919,7 @@ public async Task TestCreateVectorStoreOnline()
         public async Task TestIncludeFileSearchContent(bool useStream, bool includeContent)
         {
             if (useStream && !IsAsync)
-                Assert.Inconclusive("The test framework does not support iteration of stream in Sync mode.");
+                Assert.Inconclusive(STREAMING_CONSTRAINT);
             AgentsClient client = GetClient();
             VectorStoreDataSource vectorStoreDataSource = new(
                     assetIdentifier: TestEnvironment.AZURE_BLOB_URI,
@@ -1229,7 +1256,7 @@ private async Task<ThreadRun> WaitForRun(AgentsClient client, ThreadRun run)
             while (run.Status == RunStatus.Queued
                 || run.Status == RunStatus.InProgress
                 || run.Status == RunStatus.RequiresAction);
-            Assert.AreEqual(RunStatus.Completed, run.Status);
+            Assert.AreEqual(RunStatus.Completed, run.Status, message: run.LastError?.ToString());
             return run;
         }
 
diff --git a/sdk/ai/Azure.AI.Projects/tests/TestData/product_info_1.md b/sdk/ai/Azure.AI.Projects/tests/TestData/product_info_1.md
@@ -0,0 +1,51 @@
+# Information about product item_number: 1
+
+## Brand
+Contoso Galaxy Innovations
+
+## Category
+Smart Eyewear
+
+## Features
+- Augmented Reality interface
+- Voice-controlled AI assistant
+- HD video recording with 3D audio
+- UV protection and blue light filtering
+- Wireless charging with extended battery life
+
+## User Guide
+
+### 1. Introduction
+Introduction to your new SmartView Glasses
+
+### 2. Product Overview
+Overview of features and controls
+
+### 3. Sizing and Fit
+Finding your perfect fit and style adjustments
+
+### 4. Proper Care and Maintenance
+Cleaning and caring for your SmartView Glasses
+
+### 5. Break-in Period
+Adjusting to the augmented reality experience
+
+### 6. Safety Tips
+Safety guidelines for public and private spaces
+
+### 7. Troubleshooting
+Quick fixes for common issues
+
+## Warranty Information
+Two-year limited warranty on all electronic components
+
+## Contact Information
+Customer Support at support@contoso-galaxy-innovations.com
+
+## Return Policy
+30-day return policy with no questions asked
+
+## FAQ
+- How to sync your SmartView Glasses with your devices
+- Troubleshooting connection issues
+- Customizing your augmented reality environment
diff --git a/sdk/ai/Azure.AI.Projects/tsp-location.yaml b/sdk/ai/Azure.AI.Projects/tsp-location.yaml
@@ -1,4 +1,4 @@
 directory: specification/ai/Azure.AI.Projects
-commit: 6e507701253408679175e95176995c437f8e00d4
+commit: 27e45fc03fd2698e3ad9b2799b313f289daeb142
 repo: Azure/azure-rest-api-specs
 additionalDirectories: 

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"AssetsRepo": "Azure/azure-sdk-assets",`
`3`	`3`	`"AssetsRepoPrefixPath": "net",`
`4`	`4`	`"TagPrefix": "net/ai/Azure.AI.Projects",`
`5`		`- "Tag": "net/ai/Azure.AI.Projects_c34fc3243d"`
	`5`	`+ "Tag": "net/ai/Azure.AI.Projects_8d76f03633"`
`6`	`6`	`}`