OpenAI-DotNet 8.7.3 (#468)

- Fixed Response.Instructions deserialization when using CreateResponseRequest.Prompt

Author: StephenHodgson

OpenAI-DotNet-Tests/TestFixture_14_Responses.cs

@@ -339,7 +339,7 @@ public async Task Test_04_01_JsonSchema()
         }
 
         [Test]
-        public async Task Test_04_01_JsonSchema_Streaming()
+        public async Task Test_04_02_JsonSchema_Streaming()
         {
             Assert.IsNotNull(OpenAIClient.ResponsesEndpoint);
 
@@ -385,5 +385,84 @@ Task StreamCallback(string @event, IServerSentEvent sseEvent)
             Assert.IsNotEmpty(mathResponse.Steps);
             response.PrintUsage();
         }
+
+        [Test]
+        public async Task Test_05_01_Prompts()
+        {
+            Assert.NotNull(OpenAIClient.ResponsesEndpoint);
+
+            var conversation = new List<IResponseItem>
+            {
+                new Message(Role.User, "What's the weather like today?"),
+            };
+            var tools = new List<Tool>
+            {
+                Tool.GetOrCreateTool(typeof(WeatherService), nameof(WeatherService.GetCurrentWeatherAsync)),
+            };
+            var request = new CreateResponseRequest(
+                input: conversation,
+                model: Model.GPT4_1_Nano,
+                prompt: new Prompt("pmpt_685c102c61608193b3654325fa76fc880b22337c811a3a71"),
+                tools: tools,
+                toolChoice: "none");
+            var response = await OpenAIClient.ResponsesEndpoint.CreateModelResponseAsync(request);
+            Assert.NotNull(response);
+            Assert.IsNotEmpty(response.Id);
+            Assert.AreEqual(ResponseStatus.Completed, response.Status);
+            var responseItem = response.Output.LastOrDefault();
+            Assert.NotNull(responseItem);
+            Assert.AreEqual(ResponseItemType.Message, responseItem.Type);
+            Assert.IsInstanceOf<Message>(responseItem);
+            var messageItem = responseItem as Message;
+            Assert.NotNull(messageItem);
+            Assert.IsNotEmpty(messageItem!.Content);
+            Assert.IsInstanceOf<Responses.TextContent>(messageItem.Content[0]);
+            var textContent = messageItem.Content[0] as Responses.TextContent;
+            Assert.NotNull(textContent);
+            Assert.IsNotEmpty(textContent!.Text);
+            Console.WriteLine($"{messageItem.Role}:{textContent.Text}");
+            response.PrintUsage();
+            conversation.Add(messageItem);
+            conversation.Add(new Message(Role.User, "I'm currently in San Francisco"));
+            request = new(conversation, Model.GPT4_1_Nano, tools: tools, toolChoice: "auto");
+            response = await OpenAIClient.ResponsesEndpoint.CreateModelResponseAsync(request);
+            Assert.NotNull(response);
+            Assert.IsNotEmpty(response.Id);
+            Assert.AreEqual(ResponseStatus.Completed, response.Status);
+            responseItem = response.Output.LastOrDefault();
+            Assert.NotNull(responseItem);
+            Assert.AreEqual(ResponseItemType.FunctionCall, responseItem.Type);
+            Assert.IsInstanceOf<FunctionToolCall>(responseItem);
+            var usedTool = responseItem as FunctionToolCall;
+            conversation.Add(usedTool);
+            Assert.NotNull(usedTool);
+            Assert.IsNotEmpty(usedTool.Name);
+            Assert.IsTrue(usedTool.Name.Contains(nameof(WeatherService.GetCurrentWeatherAsync)));
+            Assert.NotNull(usedTool.Arguments);
+            Console.WriteLine($"{usedTool.Name}: {usedTool.Arguments}");
+            response.PrintUsage();
+            var functionResult = await usedTool.InvokeFunctionAsync();
+            Assert.IsNotNull(functionResult);
+            Console.WriteLine($"{usedTool.Name} Result: {functionResult}");
+            conversation.Add(functionResult);
+            request = new(conversation, Model.GPT4_1_Nano, tools: tools, toolChoice: "none");
+            response = await OpenAIClient.ResponsesEndpoint.CreateModelResponseAsync(request);
+            Assert.NotNull(response);
+            Assert.IsNotEmpty(response.Id);
+            Assert.AreEqual(ResponseStatus.Completed, response.Status);
+            responseItem = response.Output.LastOrDefault();
+            Assert.NotNull(responseItem);
+            Assert.AreEqual(ResponseItemType.Message, responseItem.Type);
+            Assert.IsInstanceOf<Message>(responseItem);
+            messageItem = responseItem as Message;
+            Assert.NotNull(messageItem);
+            Assert.IsNotEmpty(messageItem!.Content);
+            Assert.IsInstanceOf<Responses.TextContent>(messageItem.Content[0]);
+            textContent = messageItem.Content[0] as Responses.TextContent;
+            Assert.NotNull(textContent);
+            Assert.IsNotEmpty(textContent!.Text);
+            Console.WriteLine($"{messageItem.Role}: {messageItem}");
+            response.PrintUsage();
+        }
     }
 }

OpenAI-DotNet/Extensions/StringOrObjectConverter.cs

@@ -14,6 +14,7 @@ public override dynamic Read(ref Utf8JsonReader reader, Type typeToConvert, Json
                 JsonTokenType.Null => null,
                 JsonTokenType.String => reader.GetString(),
                 JsonTokenType.StartObject => JsonSerializer.Deserialize<T>(ref reader, options),
+                JsonTokenType.StartArray => JsonSerializer.Deserialize<T>(ref reader, options),
                 _ => throw new JsonException($"Unexpected token type: {reader.TokenType}")
             };
 

OpenAI-DotNet/OpenAI-DotNet.csproj

@@ -29,8 +29,10 @@ More context [on Roger Pincombe's blog](https://rogerpincombe.com/openai-dotnet-
     <AssemblyOriginatorKeyFile>OpenAI-DotNet.pfx</AssemblyOriginatorKeyFile>
     <IncludeSymbols>true</IncludeSymbols>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>8.7.2</Version>
+    <Version>8.7.3</Version>
     <PackageReleaseNotes>
+Version 8.7.3
+- Fixed Response.Instructions deserialization when using CreateResponseRequest.Prompt
 Version 8.7.2
 - Add support for predefined prompts in Responses endpoint
 - Fixed WebSearchToolPreview streaming annotation deserialization

OpenAI-DotNet/Responses/Response.cs

@@ -90,15 +90,16 @@ public IReadOnlyList<IResponseItem> Output
         public bool? ParallelToolCalls { get; private set; }
 
         /// <summary>
-        /// Inserts a system (or developer) message as the first item in the model's context.
-        /// When using along with `previous_response_id`,
+        /// A system (or developer) message inserted into the model's context.
+        /// When using along with previous_response_id,
         /// the instructions from a previous response will not be carried over to the next response.
         /// This makes it simple to swap out system (or developer) messages in new responses.
         /// </summary>
         [JsonInclude]
         [JsonPropertyName("instructions")]
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
-        public string Instructions { get; private set; }
+        [JsonConverter(typeof(StringOrObjectConverter<IReadOnlyList<IResponseItem>>))]
+        public object Instructions { get; private set; }
 
         /// <summary>
         /// An upper bound for the number of tokens that can be generated for a