Merge pull request #574 from pappde/feature/AssistantFileIdsStability

Feature/assistant file ids stability
betalgo · Jun 3, 2024 · 3919318 · 3919318
2 parents dada0cc + a61801d
commit 3919318
Show file tree

Hide file tree

Showing 12 changed files with 173 additions and 107 deletions.
diff --git a/OpenAI.Playground/Program.cs b/OpenAI.Playground/Program.cs
@@ -49,11 +49,12 @@
 //await AssistantTestHelper.MessagesTestHelper.RunTests(sdk);
 //await AssistantTestHelper.RunTestHelper.RunTests(sdk);
 //await AssistantTestHelper.VectorTestHelper.RunTests(sdk);
+//await AssistantTestHelper3.RunTests(sdk);
 
 // Vision
 //await VisionTestHelper.RunSimpleVisionTest(sdk);
-//await VisionTestHelper.RunSimpleVisionStreamTest(sdk);
 //await VisionTestHelper.RunSimpleVisionTestUsingBase64EncodedImage(sdk);
+//await VisionTestHelper.RunSimpleVisionStreamTest(sdk);
 
 // Tools
 //await ChatCompletionTestHelper.RunChatFunctionCallTest(sdk);

diff --git a/OpenAI.Playground/TestHelpers/AssistantHelpers/AssistantTestHelper3.cs b/OpenAI.Playground/TestHelpers/AssistantHelpers/AssistantTestHelper3.cs
@@ -10,6 +10,12 @@ namespace OpenAI.Playground.TestHelpers.AssistantHelpers;
 
 internal static class AssistantTestHelper3
 {
+    public static async Task RunTests(IOpenAIService sdk)
+    {
+        await RunAssistantApiTest(sdk);
+        await RunHowAssistantsWorkTest(sdk);
+    }
+
     /// <summary>
     ///     Test Assistant api
     /// </summary>
@@ -133,8 +139,11 @@ public static async Task RunHowAssistantsWorkTest(IOpenAIService sdk)
         var sampleFile = await FileExtensions.ReadAllBytesAsync($"SampleData/{fileName}");
         var sampleFileAsString = Encoding.UTF8.GetString(sampleFile);
 
+        // HACK: drp052424 - CSV format is not supported for Assistant, so we tell OpenAI it's a TXT. A better solution would be to update the test asset.
+        var fileNameForOpenAI = Path.ChangeExtension(fileName, ".txt");
+
         ConsoleExtensions.WriteLine($"Uploading file: {fileName}", ConsoleColor.DarkCyan);
-        var uploadFilesResponse = await sdk.Files.FileUpload(UploadFilePurposes.UploadFilePurpose.Assistants, sampleFile, fileName);
+        var uploadFilesResponse = await sdk.Files.FileUpload(UploadFilePurposes.UploadFilePurpose.Assistants, sampleFile, fileNameForOpenAI);
         if (uploadFilesResponse.Successful)
         {
             ConsoleExtensions.WriteLine($"{fileName} uploaded", ConsoleColor.DarkGreen);
@@ -145,8 +154,8 @@ public static async Task RunHowAssistantsWorkTest(IOpenAIService sdk)
             return;
         }
 
-        var uplaodFileId = uploadFilesResponse.Id;
-        ConsoleExtensions.WriteLine($"uplaodFileId:{uplaodFileId}, purpose:{uploadFilesResponse.Purpose}");
+        var uploadFileId = uploadFilesResponse.Id;
+        ConsoleExtensions.WriteLine($"uploadFileId:{uploadFileId}, purpose:{uploadFilesResponse.Purpose}");
 
         #endregion
 
@@ -163,7 +172,6 @@ public static async Task RunHowAssistantsWorkTest(IOpenAIService sdk)
             Name = "Qicha",
             Model = Models.Gpt_3_5_Turbo_1106,
             Tools = new List<ToolDefinition>() { ToolDefinition.DefineCodeInterpreter(), ToolDefinition.DefineFileSearch(), ToolDefinition.DefineFunction(func) },
-            FileIds = new List<string>() { uplaodFileId }
         });
 
         if (assistantResult.Successful)
@@ -207,7 +215,12 @@ public static async Task RunHowAssistantsWorkTest(IOpenAIService sdk)
         {
             Role = StaticValues.AssistantsStatics.MessageStatics.Roles.User,
             Content =new("Where is Zhejiang Jiacheng Supply Chain Co., LTD."),
-            Attachments = [new() { FileId = uplaodFileId }]
+            // Tools must be specified for Attachments
+            Attachments = [new() 
+            { 
+                FileId = uploadFileId,
+                Tools = [ ToolDefinition.DefineFileSearch() ]
+            }]
         });
 
         if (messageResult.Successful)

diff --git a/OpenAI.Playground/TestHelpers/AssistantHelpers/MessagesTestHelper.cs b/OpenAI.Playground/TestHelpers/AssistantHelpers/MessagesTestHelper.cs
@@ -1,7 +1,9 @@
 using OpenAI.Interfaces;
 using OpenAI.ObjectModels;
+using OpenAI.ObjectModels.RequestModels;
 using OpenAI.ObjectModels.SharedModels;
 using OpenAI.Playground.ExtensionsAndHelpers;
+using static OpenAI.ObjectModels.StaticValues;
 
 namespace OpenAI.Playground.TestHelpers.AssistantHelpers;
 
@@ -11,11 +13,13 @@ internal static partial class MessagesTestHelper
     {
         private static string? CreatedMessageId { get; set; }
         private static string? CreatedThreadId { get; set; }
+        private static string? CreatedFileId { get; set; }
 
         public static async Task RunTests(IOpenAIService openAI)
         {
             ConsoleExtensions.WriteLine("Message Basics Testing is starting:", ConsoleColor.Blue);
             await CreateMessage(openAI);
+            await CreateMessageWithImage(openAI);
             await ListMessages(openAI);
             await RetrieveMessage(openAI);
             await ModifyMessage(openAI);
@@ -39,7 +43,62 @@ public static async Task CreateMessage(IOpenAIService openAI)
             }
 
             CreatedThreadId = thread.Id;
-            var result = await openAI.Beta.Messages.CreateMessage(CreatedThreadId, new(StaticValues.AssistantsStatics.MessageStatics.Roles.User, new("How does AI work? Explain it in simple terms.")));
+            var result = await openAI.Beta.Messages.CreateMessage(CreatedThreadId, new(AssistantsStatics.MessageStatics.Roles.User, new("How does AI work? Explain it in simple terms.")));
+            if (result.Successful)
+            {
+                CreatedMessageId = result.Id;
+                ConsoleExtensions.WriteLine($"Message Created Successfully with ID: {result.Id}", ConsoleColor.Green);
+            }
+            else
+            {
+                ConsoleExtensions.WriteError(result.Error);
+            }
+        }
+
+        public static async Task CreateMessageWithImage(IOpenAIService openAI)
+        {
+            ConsoleExtensions.WriteLine("Create MessageWithImage Testing is starting:", ConsoleColor.Cyan);
+
+            var prompt = "Tell me about this image";
+            var filename = "image_edit_original.png";
+            var filePath = $"SampleData/{filename}";
+
+            var sampleBytes = await FileExtensions.ReadAllBytesAsync(filePath);
+
+            // Upload File
+            ConsoleExtensions.WriteLine("Upload File Test", ConsoleColor.DarkCyan);
+
+            ConsoleExtensions.WriteLine($"Uploading file: {filename}", ConsoleColor.DarkCyan);
+            var uploadFilesResponse = await openAI.Files.FileUpload(UploadFilePurposes.UploadFilePurpose.Vision, sampleBytes, filename);
+            if (uploadFilesResponse.Successful)
+            {
+                ConsoleExtensions.WriteLine($"{filename} uploaded", ConsoleColor.DarkGreen);
+            }
+            else
+            {
+                ConsoleExtensions.WriteLine($"{filename} failed", ConsoleColor.DarkRed);
+                return;
+            }
+
+            var uploadFileId = uploadFilesResponse.Id;
+            ConsoleExtensions.WriteLine($"uploadFileId:{uploadFileId}, purpose:{uploadFilesResponse.Purpose}");
+
+
+            // Message.ImageFileContent
+            ConsoleExtensions.WriteLine("Message with ImageFileContent Test:", ConsoleColor.DarkCyan);
+
+            MessageContentOneOfType content = new([
+                MessageContent.TextContent(prompt),
+                MessageContent.ImageFileContent(uploadFileId, ImageStatics.ImageDetailTypes.High)
+            ]);
+
+            MessageCreateRequest request = new()
+            {
+                Role = AssistantsStatics.MessageStatics.Roles.User,
+                Content = content
+            };
+
+            var result = await openAI.Beta.Messages.CreateMessage(CreatedThreadId!, request);
             if (result.Successful)
             {
                 CreatedMessageId = result.Id;
@@ -203,6 +262,11 @@ private static async Task Cleanup(IOpenAIService sdk)
             {
                 await sdk.Beta.Threads.ThreadDelete(CreatedThreadId);
             }
+
+            if (!string.IsNullOrWhiteSpace(CreatedFileId))
+            {
+                await sdk.Files.DeleteFile(CreatedFileId);
+            }
         }
     }
 }
diff --git a/OpenAI.Playground/TestHelpers/AssistantHelpers/VectorTestHelper.cs b/OpenAI.Playground/TestHelpers/AssistantHelpers/VectorTestHelper.cs
@@ -502,11 +502,11 @@ public static async Task CancelVectorStoreFileBatch(IOpenAIService openAI)
 
         private static async Task Cleanup(IOpenAIService sdk)
         {
-
-            if (!string.IsNullOrWhiteSpace(CreatedVectorFileId))
+            if (!string.IsNullOrWhiteSpace(CreatedVectorFileId) && !string.IsNullOrWhiteSpace(CreatedVectorId))
             {
                 await sdk.Beta.VectorStoreFiles.DeleteVectorStoreFile(CreatedVectorId, CreatedVectorFileId);
             }
+
             if (!string.IsNullOrWhiteSpace(CreatedFileId1))
             {
                 await sdk.Files.DeleteFile(CreatedFileId1);
@@ -523,4 +523,4 @@ private static async Task Cleanup(IOpenAIService sdk)
             }
         }
     }
-}
+}
diff --git a/OpenAI.Playground/TestHelpers/VisionTestHelper.cs b/OpenAI.Playground/TestHelpers/VisionTestHelper.cs
@@ -10,34 +10,28 @@ internal static class VisionTestHelper
 {
     public static async Task RunSimpleVisionTest(IOpenAIService sdk)
     {
-        ConsoleExtensions.WriteLine("VIsion Testing is starting:", ConsoleColor.Cyan);
+        ConsoleExtensions.WriteLine("Vision Testing is starting:", ConsoleColor.Cyan);
 
         try
         {
             ConsoleExtensions.WriteLine("Vision Test:", ConsoleColor.DarkCyan);
 
-            var completionResult = await sdk.ChatCompletion.CreateCompletion(
-                new ChatCompletionCreateRequest
+            var completionResult = await sdk.ChatCompletion.CreateCompletion(new()
+            {
+                Messages = new List<ChatMessage>
                 {
-                    Messages = new List<ChatMessage>
+                    ChatMessage.FromSystem("You are an image analyzer assistant."),
+                    ChatMessage.FromUser(new List<MessageContent>
                     {
-                        ChatMessage.FromSystem("You are an image analyzer assistant."),
-                        ChatMessage.FromUser(
-                            new List<MessageContent>
-                            {
-                                MessageContent.TextContent("What is on the picture in details?"),
-                                MessageContent.ImageUrlContent(
-                                    "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
-                                    ImageStatics.ImageDetailTypes.High
-                                )
-                            }
-                        ),
-                    },
-                    MaxTokens = 300,
-                    Model = Models.Gpt_4_vision_preview,
-                    N = 1
-                }
-            );
+                        MessageContent.TextContent("What is on the picture in details?"),
+                        MessageContent.ImageUrlContent("https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
+                            ImageStatics.ImageDetailTypes.High)
+                    })
+                },
+                MaxTokens = 300,
+                Model = Models.Gpt_4_vision_preview,
+                N = 1
+            });
 
             if (completionResult.Successful)
             {
@@ -47,12 +41,10 @@ public static async Task RunSimpleVisionTest(IOpenAIService sdk)
             {
                 if (completionResult.Error == null)
                 {
-                    throw new Exception("Unknown Error");
+                    throw new("Unknown Error");
                 }
 
-                Console.WriteLine(
-                    $"{completionResult.Error.Code}: {completionResult.Error.Message}"
-                );
+                Console.WriteLine($"{completionResult.Error.Code}: {completionResult.Error.Message}");
             }
         }
         catch (Exception e)
@@ -69,28 +61,22 @@ public static async Task RunSimpleVisionStreamTest(IOpenAIService sdk)
         {
             ConsoleExtensions.WriteLine("Vision Stream Test:", ConsoleColor.DarkCyan);
 
-            var completionResult = sdk.ChatCompletion.CreateCompletionAsStream(
-                new ChatCompletionCreateRequest
+            var completionResult = sdk.ChatCompletion.CreateCompletionAsStream(new()
+            {
+                Messages = new List<ChatMessage>
                 {
-                    Messages = new List<ChatMessage>
+                    ChatMessage.FromSystem("You are an image analyzer assistant."),
+                    ChatMessage.FromUser(new List<MessageContent>
                     {
-                        ChatMessage.FromSystem("You are an image analyzer assistant."),
-                        ChatMessage.FromUser(
-                            new List<MessageContent>
-                            {
-                                MessageContent.TextContent("What’s in this image?"),
-                                MessageContent.ImageUrlContent(
-                                    "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
-                                    ImageStatics.ImageDetailTypes.Low
-                                )
-                            }
-                        ),
-                    },
-                    MaxTokens = 300,
-                    Model = Models.Gpt_4_vision_preview,
-                    N = 1
-                }
-            );
+                        MessageContent.TextContent("What’s in this image?"),
+                        MessageContent.ImageUrlContent("https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
+                            ImageStatics.ImageDetailTypes.Low)
+                    })
+                },
+                MaxTokens = 300,
+                Model = Models.Gpt_4_vision_preview,
+                N = 1
+            });
 
             await foreach (var completion in completionResult)
             {
@@ -102,12 +88,10 @@ public static async Task RunSimpleVisionStreamTest(IOpenAIService sdk)
                 {
                     if (completion.Error == null)
                     {
-                        throw new Exception("Unknown Error");
+                        throw new("Unknown Error");
                     }
 
-                    Console.WriteLine(
-                        $"{completion.Error.Code}: {completion.Error.Message}"
-                    );
+                    Console.WriteLine($"{completion.Error.Code}: {completion.Error.Message}");
                 }
             }
 
@@ -127,39 +111,26 @@ public static async Task RunSimpleVisionTestUsingBase64EncodedImage(IOpenAIServi
 
         try
         {
-            ConsoleExtensions.WriteLine(
-                "Vision with base64 encoded image Test:",
-                ConsoleColor.DarkCyan
-            );
+            ConsoleExtensions.WriteLine("Vision with base64 encoded image Test:", ConsoleColor.DarkCyan);
 
             const string originalFileName = "image_edit_original.png";
-            var originalFile = await FileExtensions.ReadAllBytesAsync(
-                $"SampleData/{originalFileName}"
-            );
+            var originalFile = await FileExtensions.ReadAllBytesAsync($"SampleData/{originalFileName}");
 
-            var completionResult = await sdk.ChatCompletion.CreateCompletion(
-                new ChatCompletionCreateRequest
+            var completionResult = await sdk.ChatCompletion.CreateCompletion(new()
+            {
+                Messages = new List<ChatMessage>
                 {
-                    Messages = new List<ChatMessage>
+                    ChatMessage.FromSystem("You are an image analyzer assistant."),
+                    ChatMessage.FromUser(new List<MessageContent>
                     {
-                        ChatMessage.FromSystem("You are an image analyzer assistant."),
-                        ChatMessage.FromUser(
-                            new List<MessageContent>
-                            {
-                                MessageContent.TextContent("What is on the picture in details?"),
-                                MessageContent.ImageBinaryContent(
-                                    originalFile,
-                                    ImageStatics.ImageFileTypes.Png,
-                                    ImageStatics.ImageDetailTypes.High
-                                )
-                            }
-                        ),
-                    },
-                    MaxTokens = 300,
-                    Model = Models.Gpt_4_vision_preview,
-                    N = 1
-                }
-            );
+                        MessageContent.TextContent("What is on the picture in details?"),
+                        MessageContent.ImageBinaryContent(originalFile, ImageStatics.ImageFileTypes.Png, ImageStatics.ImageDetailTypes.High)
+                    })
+                },
+                MaxTokens = 300,
+                Model = Models.Gpt_4_vision_preview,
+                N = 1
+            });
 
             if (completionResult.Successful)
             {
@@ -169,12 +140,10 @@ public static async Task RunSimpleVisionTestUsingBase64EncodedImage(IOpenAIServi
             {
                 if (completionResult.Error == null)
                 {
-                    throw new Exception("Unknown Error");
+                    throw new("Unknown Error");
                 }
 
-                Console.WriteLine(
-                    $"{completionResult.Error.Code}: {completionResult.Error.Message}"
-                );
+                Console.WriteLine($"{completionResult.Error.Code}: {completionResult.Error.Message}");
             }
         }
         catch (Exception e)
@@ -183,4 +152,4 @@ public static async Task RunSimpleVisionTestUsingBase64EncodedImage(IOpenAIServi
             throw;
         }
     }
-}
+}