|
| 1 | +// Licensed to the .NET Foundation under one or more agreements. |
| 2 | +// The .NET Foundation licenses this file to you under the MIT license. |
| 3 | + |
| 4 | +using System; |
| 5 | +using System.Collections.Generic; |
| 6 | +using System.ComponentModel; |
| 7 | +using System.Linq; |
| 8 | +using System.Text.Json; |
| 9 | +using OpenAI.Assistants; |
| 10 | +using OpenAI.Chat; |
| 11 | +using OpenAI.Realtime; |
| 12 | +using OpenAI.Responses; |
| 13 | +using Xunit; |
| 14 | + |
| 15 | +namespace Microsoft.Extensions.AI; |
| 16 | + |
| 17 | +public class OpenAIConversionTests |
| 18 | +{ |
| 19 | + private static readonly AIFunction _testFunction = AIFunctionFactory.Create( |
| 20 | + ([Description("The name parameter")] string name) => name, |
| 21 | + "test_function", |
| 22 | + "A test function for conversion"); |
| 23 | + |
| 24 | + [Fact] |
| 25 | + public void AsOpenAIChatTool_ProducesValidInstance() |
| 26 | + { |
| 27 | + var tool = _testFunction.AsOpenAIChatTool(); |
| 28 | + |
| 29 | + Assert.NotNull(tool); |
| 30 | + Assert.Equal("test_function", tool.FunctionName); |
| 31 | + Assert.Equal("A test function for conversion", tool.FunctionDescription); |
| 32 | + ValidateSchemaParameters(tool.FunctionParameters); |
| 33 | + } |
| 34 | + |
| 35 | + [Fact] |
| 36 | + public void AsOpenAIResponseTool_ProducesValidInstance() |
| 37 | + { |
| 38 | + var tool = _testFunction.AsOpenAIResponseTool(); |
| 39 | + |
| 40 | + Assert.NotNull(tool); |
| 41 | + } |
| 42 | + |
| 43 | + [Fact] |
| 44 | + public void AsOpenAIConversationFunctionTool_ProducesValidInstance() |
| 45 | + { |
| 46 | + var tool = _testFunction.AsOpenAIConversationFunctionTool(); |
| 47 | + |
| 48 | + Assert.NotNull(tool); |
| 49 | + Assert.Equal("test_function", tool.Name); |
| 50 | + Assert.Equal("A test function for conversion", tool.Description); |
| 51 | + ValidateSchemaParameters(tool.Parameters); |
| 52 | + } |
| 53 | + |
| 54 | + [Fact] |
| 55 | + public void AsOpenAIAssistantsFunctionToolDefinition_ProducesValidInstance() |
| 56 | + { |
| 57 | + var tool = _testFunction.AsOpenAIAssistantsFunctionToolDefinition(); |
| 58 | + |
| 59 | + Assert.NotNull(tool); |
| 60 | + Assert.Equal("test_function", tool.FunctionName); |
| 61 | + Assert.Equal("A test function for conversion", tool.Description); |
| 62 | + ValidateSchemaParameters(tool.Parameters); |
| 63 | + } |
| 64 | + |
| 65 | + /// <summary>Helper method to validate function parameters match our schema.</summary> |
| 66 | + private static void ValidateSchemaParameters(BinaryData parameters) |
| 67 | + { |
| 68 | + Assert.NotNull(parameters); |
| 69 | + |
| 70 | + using var jsonDoc = JsonDocument.Parse(parameters); |
| 71 | + var root = jsonDoc.RootElement; |
| 72 | + |
| 73 | + Assert.Equal("object", root.GetProperty("type").GetString()); |
| 74 | + Assert.True(root.TryGetProperty("properties", out var properties)); |
| 75 | + Assert.True(properties.TryGetProperty("name", out var nameProperty)); |
| 76 | + Assert.Equal("string", nameProperty.GetProperty("type").GetString()); |
| 77 | + Assert.Equal("The name parameter", nameProperty.GetProperty("description").GetString()); |
| 78 | + } |
| 79 | + |
| 80 | + [Fact] |
| 81 | + public void AsOpenAIChatMessages_ProducesExpectedOutput() |
| 82 | + { |
| 83 | + Assert.Throws<ArgumentNullException>("messages", () => ((IEnumerable<ChatMessage>)null!).AsOpenAIChatMessages()); |
| 84 | + |
| 85 | + List<ChatMessage> messages = |
| 86 | + [ |
| 87 | + new(ChatRole.System, "You are a helpful assistant."), |
| 88 | + new(ChatRole.User, "Hello"), |
| 89 | + new(ChatRole.Assistant, |
| 90 | + [ |
| 91 | + new TextContent("Hi there!"), |
| 92 | + new FunctionCallContent("callid123", "SomeFunction", new Dictionary<string, object?> |
| 93 | + { |
| 94 | + ["param1"] = "value1", |
| 95 | + ["param2"] = 42 |
| 96 | + }), |
| 97 | + ]), |
| 98 | + new(ChatRole.Tool, [new FunctionResultContent("callid123", "theresult")]), |
| 99 | + new(ChatRole.Assistant, "The answer is 42."), |
| 100 | + ]; |
| 101 | + |
| 102 | + var convertedMessages = messages.AsOpenAIChatMessages().ToArray(); |
| 103 | + |
| 104 | + Assert.Equal(5, convertedMessages.Length); |
| 105 | + |
| 106 | + SystemChatMessage m0 = Assert.IsType<SystemChatMessage>(convertedMessages[0]); |
| 107 | + Assert.Equal("You are a helpful assistant.", Assert.Single(m0.Content).Text); |
| 108 | + |
| 109 | + UserChatMessage m1 = Assert.IsType<UserChatMessage>(convertedMessages[1]); |
| 110 | + Assert.Equal("Hello", Assert.Single(m1.Content).Text); |
| 111 | + |
| 112 | + AssistantChatMessage m2 = Assert.IsType<AssistantChatMessage>(convertedMessages[2]); |
| 113 | + Assert.Single(m2.Content); |
| 114 | + Assert.Equal("Hi there!", m2.Content[0].Text); |
| 115 | + var tc = Assert.Single(m2.ToolCalls); |
| 116 | + Assert.Equal("callid123", tc.Id); |
| 117 | + Assert.Equal("SomeFunction", tc.FunctionName); |
| 118 | + Assert.True(JsonElement.DeepEquals(JsonSerializer.SerializeToElement(new Dictionary<string, object?> |
| 119 | + { |
| 120 | + ["param1"] = "value1", |
| 121 | + ["param2"] = 42 |
| 122 | + }), JsonSerializer.Deserialize<JsonElement>(tc.FunctionArguments.ToMemory().Span))); |
| 123 | + |
| 124 | + ToolChatMessage m3 = Assert.IsType<ToolChatMessage>(convertedMessages[3]); |
| 125 | + Assert.Equal("callid123", m3.ToolCallId); |
| 126 | + Assert.Equal("theresult", Assert.Single(m3.Content).Text); |
| 127 | + |
| 128 | + AssistantChatMessage m4 = Assert.IsType<AssistantChatMessage>(convertedMessages[4]); |
| 129 | + Assert.Equal("The answer is 42.", Assert.Single(m4.Content).Text); |
| 130 | + } |
| 131 | + |
| 132 | + [Fact] |
| 133 | + public void AsOpenAIResponseItems_ProducesExpectedOutput() |
| 134 | + { |
| 135 | + Assert.Throws<ArgumentNullException>("messages", () => ((IEnumerable<ChatMessage>)null!).AsOpenAIResponseItems()); |
| 136 | + |
| 137 | + List<ChatMessage> messages = |
| 138 | + [ |
| 139 | + new(ChatRole.System, "You are a helpful assistant."), |
| 140 | + new(ChatRole.User, "Hello"), |
| 141 | + new(ChatRole.Assistant, |
| 142 | + [ |
| 143 | + new TextContent("Hi there!"), |
| 144 | + new FunctionCallContent("callid123", "SomeFunction", new Dictionary<string, object?> |
| 145 | + { |
| 146 | + ["param1"] = "value1", |
| 147 | + ["param2"] = 42 |
| 148 | + }), |
| 149 | + ]), |
| 150 | + new(ChatRole.Tool, [new FunctionResultContent("callid123", "theresult")]), |
| 151 | + new(ChatRole.Assistant, "The answer is 42."), |
| 152 | + ]; |
| 153 | + |
| 154 | + var convertedItems = messages.AsOpenAIResponseItems().ToArray(); |
| 155 | + |
| 156 | + Assert.Equal(6, convertedItems.Length); |
| 157 | + |
| 158 | + MessageResponseItem m0 = Assert.IsAssignableFrom<MessageResponseItem>(convertedItems[0]); |
| 159 | + Assert.Equal("You are a helpful assistant.", Assert.Single(m0.Content).Text); |
| 160 | + |
| 161 | + MessageResponseItem m1 = Assert.IsAssignableFrom<MessageResponseItem>(convertedItems[1]); |
| 162 | + Assert.Equal(OpenAI.Responses.MessageRole.User, m1.Role); |
| 163 | + Assert.Equal("Hello", Assert.Single(m1.Content).Text); |
| 164 | + |
| 165 | + MessageResponseItem m2 = Assert.IsAssignableFrom<MessageResponseItem>(convertedItems[2]); |
| 166 | + Assert.Equal(OpenAI.Responses.MessageRole.Assistant, m2.Role); |
| 167 | + Assert.Equal("Hi there!", Assert.Single(m2.Content).Text); |
| 168 | + |
| 169 | + FunctionCallResponseItem m3 = Assert.IsAssignableFrom<FunctionCallResponseItem>(convertedItems[3]); |
| 170 | + Assert.Equal("callid123", m3.CallId); |
| 171 | + Assert.Equal("SomeFunction", m3.FunctionName); |
| 172 | + Assert.True(JsonElement.DeepEquals(JsonSerializer.SerializeToElement(new Dictionary<string, object?> |
| 173 | + { |
| 174 | + ["param1"] = "value1", |
| 175 | + ["param2"] = 42 |
| 176 | + }), JsonSerializer.Deserialize<JsonElement>(m3.FunctionArguments.ToMemory().Span))); |
| 177 | + |
| 178 | + FunctionCallOutputResponseItem m4 = Assert.IsAssignableFrom<FunctionCallOutputResponseItem>(convertedItems[4]); |
| 179 | + Assert.Equal("callid123", m4.CallId); |
| 180 | + Assert.Equal("theresult", m4.FunctionOutput); |
| 181 | + |
| 182 | + MessageResponseItem m5 = Assert.IsAssignableFrom<MessageResponseItem>(convertedItems[5]); |
| 183 | + Assert.Equal(OpenAI.Responses.MessageRole.Assistant, m5.Role); |
| 184 | + Assert.Equal("The answer is 42.", Assert.Single(m5.Content).Text); |
| 185 | + } |
| 186 | +} |
0 commit comments