You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

OpenAIMessageTests.cs 31 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // OpenAIMessageTests.cs
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Linq;
  6. using System.Reflection;
  7. using System.Text.Json;
  8. using System.Threading.Tasks;
  9. using ApprovalTests;
  10. using ApprovalTests.Namers;
  11. using ApprovalTests.Reporters;
  12. using AutoGen.Tests;
  13. using FluentAssertions;
  14. using OpenAI.Chat;
  15. using Xunit;
  16. namespace AutoGen.OpenAI.Tests;
  17. public class OpenAIMessageTests
  18. {
  19. private readonly JsonSerializerOptions jsonSerializerOptions = new JsonSerializerOptions
  20. {
  21. WriteIndented = true,
  22. IgnoreReadOnlyProperties = false,
  23. };
  24. [Fact]
  25. [UseReporter(typeof(DiffReporter))]
  26. [UseApprovalSubdirectory("ApprovalTests")]
  27. public void BasicMessageTest()
  28. {
  29. IMessage[] messages = [
  30. new TextMessage(Role.System, "You are a helpful AI assistant"),
  31. new TextMessage(Role.User, "Hello", "user"),
  32. new TextMessage(Role.Assistant, "How can I help you?", from: "assistant"),
  33. new ImageMessage(Role.User, "https://example.com/image.png", "user"),
  34. new MultiModalMessage(Role.Assistant,
  35. [
  36. new TextMessage(Role.User, "Hello", "user"),
  37. new ImageMessage(Role.User, "https://example.com/image.png", "user"),
  38. ], "user"),
  39. new ToolCallMessage("test", "test", "assistant"),
  40. new ToolCallResultMessage("result", "test", "test", "user"),
  41. new ToolCallResultMessage(
  42. [
  43. new ToolCall("result", "test", "test"),
  44. new ToolCall("result", "test", "test"),
  45. ], "user"),
  46. new ToolCallMessage(
  47. [
  48. new ToolCall("test", "test"),
  49. new ToolCall("test", "test"),
  50. ], "assistant"),
  51. new AggregateMessage<ToolCallMessage, ToolCallResultMessage>(
  52. message1: new ToolCallMessage("test", "test", "assistant"),
  53. message2: new ToolCallResultMessage("result", "test", "test", "assistant"), "assistant"),
  54. ];
  55. var openaiMessageConnectorMiddleware = new OpenAIChatRequestMessageConnector();
  56. var agent = new EchoAgent("assistant");
  57. var oaiMessages = messages.Select(m => (m, openaiMessageConnectorMiddleware.ProcessIncomingMessages(agent, [m])));
  58. VerifyOAIMessages(oaiMessages);
  59. }
  60. [Fact]
  61. public async Task ItProcessUserTextMessageAsync()
  62. {
  63. var middleware = new OpenAIChatRequestMessageConnector();
  64. var agent = new EchoAgent("assistant")
  65. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  66. {
  67. var innerMessage = msgs.Last();
  68. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  69. var chatRequestMessage = (UserChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  70. chatRequestMessage.Content.First().Text.Should().Be("Hello");
  71. chatRequestMessage.ParticipantName.Should().Be("user");
  72. return await innerAgent.GenerateReplyAsync(msgs);
  73. })
  74. .RegisterMiddleware(middleware);
  75. // user message
  76. IMessage message = new TextMessage(Role.User, "Hello", "user");
  77. await agent.GenerateReplyAsync([message]);
  78. }
  79. [Fact]
  80. public async Task ItShortcutChatRequestMessageAsync()
  81. {
  82. var middleware = new OpenAIChatRequestMessageConnector();
  83. var agent = new EchoAgent("assistant")
  84. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  85. {
  86. var innerMessage = msgs.Last();
  87. innerMessage!.Should().BeOfType<MessageEnvelope<UserChatMessage>>();
  88. var chatRequestMessage = (UserChatMessage)((MessageEnvelope<UserChatMessage>)innerMessage!).Content;
  89. chatRequestMessage.Content.First().Text.Should().Be("hello");
  90. return await innerAgent.GenerateReplyAsync(msgs);
  91. })
  92. .RegisterMiddleware(middleware);
  93. // user message
  94. var userMessage = new UserChatMessage("hello");
  95. var chatRequestMessage = MessageEnvelope.Create(userMessage);
  96. await agent.GenerateReplyAsync([chatRequestMessage]);
  97. }
  98. [Fact]
  99. public async Task ItShortcutMessageWhenStrictModelIsFalseAsync()
  100. {
  101. var middleware = new OpenAIChatRequestMessageConnector();
  102. var agent = new EchoAgent("assistant")
  103. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  104. {
  105. var innerMessage = msgs.Last();
  106. innerMessage!.Should().BeOfType<MessageEnvelope<string>>();
  107. var chatRequestMessage = ((MessageEnvelope<string>)innerMessage!).Content;
  108. chatRequestMessage.Should().Be("hello");
  109. return await innerAgent.GenerateReplyAsync(msgs);
  110. })
  111. .RegisterMiddleware(middleware);
  112. // user message
  113. var userMessage = "hello";
  114. var chatRequestMessage = MessageEnvelope.Create(userMessage);
  115. await agent.GenerateReplyAsync([chatRequestMessage]);
  116. }
  117. [Fact]
  118. public async Task ItThrowExceptionWhenStrictModeIsTrueAsync()
  119. {
  120. var middleware = new OpenAIChatRequestMessageConnector(true);
  121. var agent = new EchoAgent("assistant")
  122. .RegisterMiddleware(middleware);
  123. // user message
  124. var userMessage = "hello";
  125. var chatRequestMessage = MessageEnvelope.Create(userMessage);
  126. Func<Task> action = async () => await agent.GenerateReplyAsync([chatRequestMessage]);
  127. await action.Should().ThrowAsync<InvalidOperationException>().WithMessage("Invalid message type: MessageEnvelope`1");
  128. }
  129. [Fact]
  130. public async Task ItProcessAssistantTextMessageAsync()
  131. {
  132. var middleware = new OpenAIChatRequestMessageConnector();
  133. var agent = new EchoAgent("assistant")
  134. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  135. {
  136. var innerMessage = msgs.Last();
  137. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  138. var chatRequestMessage = (AssistantChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  139. chatRequestMessage.Content.First().Text.Should().Be("How can I help you?");
  140. chatRequestMessage.ParticipantName.Should().Be("assistant");
  141. return await innerAgent.GenerateReplyAsync(msgs);
  142. })
  143. .RegisterMiddleware(middleware);
  144. // assistant message
  145. IMessage message = new TextMessage(Role.Assistant, "How can I help you?", "assistant");
  146. await agent.GenerateReplyAsync([message]);
  147. }
  148. [Fact]
  149. public async Task ItProcessSystemTextMessageAsync()
  150. {
  151. var middleware = new OpenAIChatRequestMessageConnector();
  152. var agent = new EchoAgent("assistant")
  153. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  154. {
  155. var innerMessage = msgs.Last();
  156. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  157. var chatRequestMessage = (SystemChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  158. chatRequestMessage.Content.First().Text.Should().Be("You are a helpful AI assistant");
  159. return await innerAgent.GenerateReplyAsync(msgs);
  160. })
  161. .RegisterMiddleware(middleware);
  162. // system message
  163. IMessage message = new TextMessage(Role.System, "You are a helpful AI assistant");
  164. await agent.GenerateReplyAsync([message]);
  165. }
  166. [Fact]
  167. public async Task ItProcessImageMessageAsync()
  168. {
  169. var middleware = new OpenAIChatRequestMessageConnector();
  170. var agent = new EchoAgent("assistant")
  171. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  172. {
  173. var innerMessage = msgs.Last();
  174. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  175. var chatRequestMessage = (UserChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  176. chatRequestMessage.ParticipantName.Should().Be("user");
  177. chatRequestMessage.Content.Count().Should().Be(1);
  178. chatRequestMessage.Content.First().Kind.Should().Be(ChatMessageContentPartKind.Image);
  179. return await innerAgent.GenerateReplyAsync(msgs);
  180. })
  181. .RegisterMiddleware(middleware);
  182. // user message
  183. IMessage message = new ImageMessage(Role.User, "https://example.com/image.png", "user");
  184. await agent.GenerateReplyAsync([message]);
  185. }
  186. [Fact]
  187. public async Task ItThrowExceptionWhenProcessingImageMessageFromSelfAndStrictModeIsTrueAsync()
  188. {
  189. var middleware = new OpenAIChatRequestMessageConnector(true);
  190. var agent = new EchoAgent("assistant")
  191. .RegisterMiddleware(middleware);
  192. var imageMessage = new ImageMessage(Role.Assistant, "https://example.com/image.png", "assistant");
  193. Func<Task> action = async () => await agent.GenerateReplyAsync([imageMessage]);
  194. await action.Should().ThrowAsync<InvalidOperationException>().WithMessage("Invalid message type: ImageMessage");
  195. }
  196. [Fact]
  197. public async Task ItProcessMultiModalMessageAsync()
  198. {
  199. var middleware = new OpenAIChatRequestMessageConnector();
  200. var agent = new EchoAgent("assistant")
  201. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  202. {
  203. var innerMessage = msgs.Last();
  204. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  205. var chatRequestMessage = (UserChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  206. chatRequestMessage.ParticipantName.Should().Be("user");
  207. chatRequestMessage.Content.Count().Should().Be(2);
  208. chatRequestMessage.Content.First().Kind.Should().Be(ChatMessageContentPartKind.Text);
  209. chatRequestMessage.Content.Last().Kind.Should().Be(ChatMessageContentPartKind.Image);
  210. return await innerAgent.GenerateReplyAsync(msgs);
  211. })
  212. .RegisterMiddleware(middleware);
  213. // user message
  214. IMessage message = new MultiModalMessage(
  215. Role.User,
  216. [
  217. new TextMessage(Role.User, "Hello", "user"),
  218. new ImageMessage(Role.User, "https://example.com/image.png", "user"),
  219. ], "user");
  220. await agent.GenerateReplyAsync([message]);
  221. }
  222. [Fact]
  223. public async Task ItThrowExceptionWhenProcessingMultiModalMessageFromSelfAndStrictModeIsTrueAsync()
  224. {
  225. var middleware = new OpenAIChatRequestMessageConnector(true);
  226. var agent = new EchoAgent("assistant")
  227. .RegisterMiddleware(middleware);
  228. var multiModalMessage = new MultiModalMessage(
  229. Role.Assistant,
  230. [
  231. new TextMessage(Role.User, "Hello", "assistant"),
  232. new ImageMessage(Role.User, "https://example.com/image.png", "assistant"),
  233. ], "assistant");
  234. Func<Task> action = async () => await agent.GenerateReplyAsync([multiModalMessage]);
  235. await action.Should().ThrowAsync<InvalidOperationException>().WithMessage("Invalid message type: MultiModalMessage");
  236. }
  237. [Fact]
  238. public async Task ItProcessToolCallMessageAsync()
  239. {
  240. var middleware = new OpenAIChatRequestMessageConnector();
  241. var agent = new EchoAgent("assistant")
  242. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  243. {
  244. var innerMessage = msgs.Last();
  245. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  246. var chatRequestMessage = (AssistantChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  247. // when the message is a tool call message
  248. // the name field should not be set
  249. // please visit OpenAIChatRequestMessageConnector class for more information
  250. chatRequestMessage.ParticipantName.Should().BeNullOrEmpty();
  251. chatRequestMessage.ToolCalls.Count().Should().Be(1);
  252. chatRequestMessage.Content.First().Text.Should().Be("textContent");
  253. chatRequestMessage.ToolCalls.First().Should().BeOfType<ChatToolCall>();
  254. var functionToolCall = (ChatToolCall)chatRequestMessage.ToolCalls.First();
  255. functionToolCall.FunctionName.Should().Be("test");
  256. functionToolCall.Id.Should().Be("test");
  257. functionToolCall.FunctionArguments.ToString().Should().Be("test");
  258. return await innerAgent.GenerateReplyAsync(msgs);
  259. })
  260. .RegisterMiddleware(middleware);
  261. // user message
  262. IMessage message = new ToolCallMessage("test", "test", "assistant")
  263. {
  264. Content = "textContent",
  265. };
  266. await agent.GenerateReplyAsync([message]);
  267. }
  268. [Fact]
  269. public async Task ItProcessParallelToolCallMessageAsync()
  270. {
  271. var middleware = new OpenAIChatRequestMessageConnector();
  272. var agent = new EchoAgent("assistant")
  273. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  274. {
  275. var innerMessage = msgs.Last();
  276. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  277. var chatRequestMessage = (AssistantChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  278. chatRequestMessage.Content.Should().BeNullOrEmpty();
  279. // when the message is a tool call message
  280. // the name field should not be set
  281. // please visit OpenAIChatRequestMessageConnector class for more information
  282. chatRequestMessage.ParticipantName.Should().BeNullOrEmpty();
  283. chatRequestMessage.ToolCalls.Count().Should().Be(2);
  284. for (int i = 0; i < chatRequestMessage.ToolCalls.Count(); i++)
  285. {
  286. chatRequestMessage.ToolCalls.ElementAt(i).Should().BeOfType<ChatToolCall>();
  287. var functionToolCall = (ChatToolCall)chatRequestMessage.ToolCalls.ElementAt(i);
  288. functionToolCall.FunctionName.Should().Be("test");
  289. functionToolCall.Id.Should().Be($"test_{i}");
  290. functionToolCall.FunctionArguments.ToString().Should().Be("test");
  291. }
  292. return await innerAgent.GenerateReplyAsync(msgs);
  293. })
  294. .RegisterMiddleware(middleware);
  295. // user message
  296. var toolCalls = new[]
  297. {
  298. new ToolCall("test", "test"),
  299. new ToolCall("test", "test"),
  300. };
  301. IMessage message = new ToolCallMessage(toolCalls, "assistant");
  302. await agent.GenerateReplyAsync([message]);
  303. }
  304. [Fact]
  305. public async Task ItThrowExceptionWhenProcessingToolCallMessageFromUserAndStrictModeIsTrueAsync()
  306. {
  307. var middleware = new OpenAIChatRequestMessageConnector(strictMode: true);
  308. var agent = new EchoAgent("assistant")
  309. .RegisterMiddleware(middleware);
  310. var toolCallMessage = new ToolCallMessage("test", "test", "user");
  311. Func<Task> action = async () => await agent.GenerateReplyAsync([toolCallMessage]);
  312. await action.Should().ThrowAsync<InvalidOperationException>().WithMessage("Invalid message type: ToolCallMessage");
  313. }
  314. [Fact]
  315. public async Task ItProcessToolCallResultMessageAsync()
  316. {
  317. var middleware = new OpenAIChatRequestMessageConnector();
  318. var agent = new EchoAgent("assistant")
  319. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  320. {
  321. var innerMessage = msgs.Last();
  322. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  323. var chatRequestMessage = (ToolChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  324. chatRequestMessage.Content.First().Text.Should().Be("result");
  325. chatRequestMessage.ToolCallId.Should().Be("test");
  326. return await innerAgent.GenerateReplyAsync(msgs);
  327. })
  328. .RegisterMiddleware(middleware);
  329. // user message
  330. IMessage message = new ToolCallResultMessage("result", "test", "test", "user");
  331. await agent.GenerateReplyAsync([message]);
  332. }
  333. [Fact]
  334. public async Task ItProcessParallelToolCallResultMessageAsync()
  335. {
  336. var middleware = new OpenAIChatRequestMessageConnector();
  337. var agent = new EchoAgent("assistant")
  338. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  339. {
  340. msgs.Count().Should().Be(2);
  341. for (int i = 0; i < msgs.Count(); i++)
  342. {
  343. var innerMessage = msgs.ElementAt(i);
  344. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  345. var chatRequestMessage = (ToolChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  346. chatRequestMessage.Content.First().Text.Should().Be("result");
  347. chatRequestMessage.ToolCallId.Should().Be($"test_{i}");
  348. }
  349. return await innerAgent.GenerateReplyAsync(msgs);
  350. })
  351. .RegisterMiddleware(middleware);
  352. // user message
  353. var toolCalls = new[]
  354. {
  355. new ToolCall("test", "test", "result"),
  356. new ToolCall("test", "test", "result"),
  357. };
  358. IMessage message = new ToolCallResultMessage(toolCalls, "user");
  359. await agent.GenerateReplyAsync([message]);
  360. }
  361. [Fact]
  362. public async Task ItProcessFunctionCallMiddlewareMessageFromUserAsync()
  363. {
  364. var middleware = new OpenAIChatRequestMessageConnector();
  365. var agent = new EchoAgent("assistant")
  366. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  367. {
  368. msgs.Count().Should().Be(1);
  369. var innerMessage = msgs.Last();
  370. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  371. var chatRequestMessage = (UserChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  372. chatRequestMessage.Content.First().Text.Should().Be("result");
  373. chatRequestMessage.ParticipantName.Should().Be("user");
  374. return await innerAgent.GenerateReplyAsync(msgs);
  375. })
  376. .RegisterMiddleware(middleware);
  377. // user message
  378. var toolCallMessage = new ToolCallMessage("test", "test", "user");
  379. var toolCallResultMessage = new ToolCallResultMessage("result", "test", "test", "user");
  380. var aggregateMessage = new AggregateMessage<ToolCallMessage, ToolCallResultMessage>(toolCallMessage, toolCallResultMessage, "user");
  381. await agent.GenerateReplyAsync([aggregateMessage]);
  382. }
  383. [Fact]
  384. public async Task ItProcessFunctionCallMiddlewareMessageFromAssistantAsync()
  385. {
  386. var middleware = new OpenAIChatRequestMessageConnector();
  387. var agent = new EchoAgent("assistant")
  388. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  389. {
  390. msgs.Count().Should().Be(2);
  391. var innerMessage = msgs.Last();
  392. innerMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  393. var chatRequestMessage = (ToolChatMessage)((MessageEnvelope<ChatMessage>)innerMessage!).Content;
  394. chatRequestMessage.Content.First().Text.Should().Be("result");
  395. chatRequestMessage.ToolCallId.Should().Be("test");
  396. var toolCallMessage = msgs.First();
  397. toolCallMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  398. var toolCallRequestMessage = (AssistantChatMessage)((MessageEnvelope<ChatMessage>)toolCallMessage!).Content;
  399. toolCallRequestMessage.Content.Should().BeNullOrEmpty();
  400. toolCallRequestMessage.ToolCalls.Count().Should().Be(1);
  401. toolCallRequestMessage.ToolCalls.First().Should().BeOfType<ChatToolCall>();
  402. var functionToolCall = (ChatToolCall)toolCallRequestMessage.ToolCalls.First();
  403. functionToolCall.FunctionName.Should().Be("test");
  404. functionToolCall.Id.Should().Be("test");
  405. functionToolCall.FunctionArguments.ToString().Should().Be("test");
  406. return await innerAgent.GenerateReplyAsync(msgs);
  407. })
  408. .RegisterMiddleware(middleware);
  409. // user message
  410. var toolCallMessage = new ToolCallMessage("test", "test", "assistant");
  411. var toolCallResultMessage = new ToolCallResultMessage("result", "test", "test", "assistant");
  412. var aggregateMessage = new ToolCallAggregateMessage(toolCallMessage, toolCallResultMessage, "assistant");
  413. await agent.GenerateReplyAsync([aggregateMessage]);
  414. }
  415. [Fact]
  416. public async Task ItProcessParallelFunctionCallMiddlewareMessageFromAssistantAsync()
  417. {
  418. var middleware = new OpenAIChatRequestMessageConnector();
  419. var agent = new EchoAgent("assistant")
  420. .RegisterMiddleware(async (msgs, _, innerAgent, _) =>
  421. {
  422. msgs.Count().Should().Be(3);
  423. var toolCallMessage = msgs.First();
  424. toolCallMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  425. var toolCallRequestMessage = (AssistantChatMessage)((MessageEnvelope<ChatMessage>)toolCallMessage!).Content;
  426. toolCallRequestMessage.Content.Should().BeNullOrEmpty();
  427. toolCallRequestMessage.ToolCalls.Count().Should().Be(2);
  428. for (int i = 0; i < toolCallRequestMessage.ToolCalls.Count(); i++)
  429. {
  430. toolCallRequestMessage.ToolCalls.ElementAt(i).Should().BeOfType<ChatToolCall>();
  431. var functionToolCall = (ChatToolCall)toolCallRequestMessage.ToolCalls.ElementAt(i);
  432. functionToolCall.FunctionName.Should().Be("test");
  433. functionToolCall.Id.Should().Be($"test_{i}");
  434. functionToolCall.FunctionArguments.ToString().Should().Be("test");
  435. }
  436. for (int i = 1; i < msgs.Count(); i++)
  437. {
  438. var toolCallResultMessage = msgs.ElementAt(i);
  439. toolCallResultMessage!.Should().BeOfType<MessageEnvelope<ChatMessage>>();
  440. var toolCallResultRequestMessage = (ToolChatMessage)((MessageEnvelope<ChatMessage>)toolCallResultMessage!).Content;
  441. toolCallResultRequestMessage.Content.First().Text.Should().Be("result");
  442. toolCallResultRequestMessage.ToolCallId.Should().Be($"test_{i - 1}");
  443. }
  444. return await innerAgent.GenerateReplyAsync(msgs);
  445. })
  446. .RegisterMiddleware(middleware);
  447. // user message
  448. var toolCalls = new[]
  449. {
  450. new ToolCall("test", "test", "result"),
  451. new ToolCall("test", "test", "result"),
  452. };
  453. var toolCallMessage = new ToolCallMessage(toolCalls, "assistant");
  454. var toolCallResultMessage = new ToolCallResultMessage(toolCalls, "assistant");
  455. var aggregateMessage = new AggregateMessage<ToolCallMessage, ToolCallResultMessage>(toolCallMessage, toolCallResultMessage, "assistant");
  456. await agent.GenerateReplyAsync([aggregateMessage]);
  457. }
  458. [Fact]
  459. public async Task ItReturnOriginalMessageWhenStrictModeIsFalseAsync()
  460. {
  461. var middleware = new OpenAIChatRequestMessageConnector();
  462. var agent = new EchoAgent("assistant")
  463. .RegisterMiddleware(middleware);
  464. // text message
  465. var textMessage = "hello";
  466. var messageToSend = MessageEnvelope.Create(textMessage);
  467. var message = await agent.GenerateReplyAsync([messageToSend]);
  468. message.Should().BeOfType<MessageEnvelope<string>>();
  469. }
  470. [Fact]
  471. public async Task ItThrowInvalidOperationExceptionWhenStrictModeIsTrueAsync()
  472. {
  473. var middleware = new OpenAIChatRequestMessageConnector(true);
  474. var agent = new EchoAgent("assistant")
  475. .RegisterMiddleware(middleware);
  476. // text message
  477. var textMessage = new UserChatMessage("hello");
  478. var messageToSend = MessageEnvelope.Create(textMessage);
  479. Func<Task> action = async () => await agent.GenerateReplyAsync([messageToSend]);
  480. await action.Should().ThrowAsync<InvalidOperationException>().WithMessage("Invalid return message type MessageEnvelope`1");
  481. }
  482. [Fact]
  483. public void ToOpenAIChatRequestMessageShortCircuitTest()
  484. {
  485. var agent = new EchoAgent("assistant");
  486. var middleware = new OpenAIChatRequestMessageConnector();
  487. #pragma warning disable CS0618 // Type or member is obsolete
  488. ChatMessage[] messages =
  489. [
  490. new UserChatMessage("Hello"),
  491. new AssistantChatMessage("How can I help you?"),
  492. new SystemChatMessage("You are a helpful AI assistant"),
  493. new FunctionChatMessage("functionName", "result"),
  494. new ToolChatMessage("test", "test"),
  495. ];
  496. #pragma warning restore CS0618 // Type or member is obsolete
  497. foreach (var oaiMessage in messages)
  498. {
  499. IMessage message = new MessageEnvelope<ChatMessage>(oaiMessage);
  500. var oaiMessages = middleware.ProcessIncomingMessages(agent, [message]);
  501. oaiMessages.Count().Should().Be(1);
  502. //oaiMessages.First().Should().BeOfType<IMessage<ChatRequestMessage>>();
  503. if (oaiMessages.First() is IMessage<ChatMessage> chatRequestMessage)
  504. {
  505. chatRequestMessage.Content.Should().Be(oaiMessage);
  506. }
  507. else
  508. {
  509. // fail the test
  510. Assert.True(false);
  511. }
  512. }
  513. }
  514. private void VerifyOAIMessages(IEnumerable<(IMessage, IEnumerable<IMessage>)> messages)
  515. {
  516. var jsonObjects = messages.Select(pair =>
  517. {
  518. var (originalMessage, ms) = pair;
  519. var objs = new List<object>();
  520. foreach (var m in ms)
  521. {
  522. object? obj = null;
  523. var chatRequestMessage = (m as IMessage<ChatMessage>)?.Content;
  524. if (chatRequestMessage is UserChatMessage userMessage)
  525. {
  526. obj = new
  527. {
  528. Role = "user",
  529. Content = userMessage.Content,
  530. Name = userMessage.ParticipantName,
  531. MultiModaItem = userMessage.Content?.Select(item =>
  532. {
  533. return item switch
  534. {
  535. _ when item.Kind == ChatMessageContentPartKind.Image => new
  536. {
  537. Type = "Image",
  538. ImageUrl = GetImageUrlFromContent(item),
  539. } as object,
  540. _ when item.Kind == ChatMessageContentPartKind.Text => new
  541. {
  542. Type = "Text",
  543. Text = item.Text,
  544. } as object,
  545. _ => throw new System.NotImplementedException(),
  546. };
  547. }),
  548. };
  549. }
  550. if (chatRequestMessage is AssistantChatMessage assistantMessage)
  551. {
  552. obj = new
  553. {
  554. Role = "assistant",
  555. Content = assistantMessage.Content,
  556. Name = assistantMessage.ParticipantName,
  557. TooCall = assistantMessage.ToolCalls.Select(tc =>
  558. {
  559. return tc switch
  560. {
  561. ChatToolCall functionToolCall => new
  562. {
  563. Type = "Function",
  564. Name = functionToolCall.FunctionName,
  565. Arguments = functionToolCall.FunctionArguments,
  566. Id = functionToolCall.Id,
  567. } as object,
  568. _ => throw new System.NotImplementedException(),
  569. };
  570. }),
  571. };
  572. }
  573. if (chatRequestMessage is SystemChatMessage systemMessage)
  574. {
  575. obj = new
  576. {
  577. Name = systemMessage.ParticipantName,
  578. Role = "system",
  579. Content = systemMessage.Content,
  580. };
  581. }
  582. #pragma warning disable CS0618 // Type or member is obsolete
  583. if (chatRequestMessage is FunctionChatMessage functionMessage)
  584. {
  585. obj = new
  586. {
  587. Role = "function",
  588. Content = functionMessage.Content,
  589. Name = functionMessage.FunctionName,
  590. };
  591. }
  592. #pragma warning restore CS0618 // Type or member is obsolete
  593. if (chatRequestMessage is ToolChatMessage toolCallMessage)
  594. {
  595. obj = new
  596. {
  597. Role = "tool",
  598. Content = toolCallMessage.Content.First().Text,
  599. ToolCallId = toolCallMessage.ToolCallId,
  600. };
  601. }
  602. objs.Add(obj ?? throw new System.NotImplementedException());
  603. }
  604. return new
  605. {
  606. OriginalMessage = originalMessage.ToString(),
  607. ConvertedMessages = objs,
  608. };
  609. });
  610. var json = JsonSerializer.Serialize(jsonObjects, this.jsonSerializerOptions);
  611. Approvals.Verify(json);
  612. }
  613. private object? GetImageUrlFromContent(ChatMessageContentPart content)
  614. {
  615. return content.ImageUri;
  616. }
  617. private static T CreateInstance<T>(params object[] args)
  618. {
  619. var type = typeof(T);
  620. var instance = type.Assembly.CreateInstance(
  621. type.FullName!, false,
  622. BindingFlags.Instance | BindingFlags.NonPublic,
  623. null, args, null, null);
  624. return (T)instance!;
  625. }
  626. }