[AG-UI详解-05]如何构建一个兼容AG-UI协议的客户端

📅 2026/7/23 19:07:37 👁️ 阅读次数 📝 编程学习
[AG-UI详解-05]如何构建一个兼容AG-UI协议的客户端

在AG-UI详解-04:如果构建一个兼容AG-UI协议的Agent中,我们通过在一个ASP.NET Core应用中注册了一个绑定指定IChatClient的路由终结点,使外界可以通过Web调用的方式以AG-UI协议调用对应的LLM。在这篇文章中,我们看看AG-UI客户端又该如何开发。和前面一样,我们的目的仅仅是作一个简单的演示,并非开发一款真正的功能完备的AG-UI客户端,所以我们的客户端建立在一个简单的假设上面,比如不考虑工具调用、人机交互、多模态消息内容和中断等。

1. 流式读取AG-UI事件

我们创建的客户端将用于对接AG-UI详解-04:如果构建一个兼容AG-UI协议的Agent创建的Agent后端。由于此后端采用SSE输出AG-UI响应的事件,所以我们的客户端的核心功能就是读取这些事件并交给上层应用处理。

我们创建的AG-UI客户端的实现非常简单。如下面这个AGUIClient所示,唯一的InvokeAsync方法将RunAgentInput对象作为输入。我们将RunAgentInput对象序列化成JSON,作为远程调用AG-UI服务(地址通过构造函数指定)的输入。在得到作为响应的HttpResponseMessage对象后,我们利用创建的SseParser采用SSE协议将每个Chunk读出来,并反序列化成BaseEvent对象。整个方法以IAsyncEnumerable<BaseEvent>的形式返回读取的AG-UI事件。

publicclassAGUIClient(stringserver):IDisposable{privatereadonlyHttpClient_httpClient=new();publicasyncIAsyncEnumerable<BaseEvent>InvokeAsync(RunAgentInputinput,[EnumeratorCancellation]CancellationTokencancellationToken){varresponse=await_httpClient.PostAsJsonAsync(server,input,cancellationToken);usingStreamstream=awaitresponse.Content.ReadAsStreamAsync(cancellationToken);varsseParser=SseParser.Create(stream,(eventType,bytes)=>JsonSerializer.Deserialize<BaseEvent>(bytes)!);awaitforeach(SseItem<BaseEvent>iteminsseParser.EnumerateAsync(cancellationToken)){yieldreturnitem.Data;}}publicvoidDispose()=>_httpClient.Dispose();}

2. 利用AGUIClient构建一个聊天应用

我们在一个控制台上利用上面定义的这个AGUIClient构建一个简单的聊天应用。如下面代码所示,我们通过连接AG-UI详解-04:如果构建一个兼容AG-UI协议的Agent构建的Agent后端创建出AGUIClient对象后,开启了一个对话循环。为了保持对话上下文,我们让输入的RunAgentInput对象共享同一个ThreadId

varthreadId=$"thread-{Guid.NewGuid()}";varrunIndex=0;varinput=newRunAgentInput{ThreadId=threadId,};varisFirstDialog=true;varsystemMessage=newAGUISystemMessage{Content=""" 你是一个深谙中国古代历史的专家,善于根据正史,以公正客观的态度于人交流历史问题。 对于用户提出的问题,请以简介概括性的语言予以答复,字数尽量保持在200字以内。"""};usingvarclient=newAGUIClient("http://localhost:5566");while(true){Console.Write("\n$ (:q or quit to exit): ");varmessage=Console.ReadLine();if(messageis":q"or"quit"){break;}input.RunId=$"run-{runIndex++}";input.Messages=isFirstDialog?[systemMessage,newAGUIUserMessage{Content=newAGUIUserContent(message!)}]:[newAGUIUserMessage{Content=newAGUIUserContent(message!)}];isFirstDialog=false;Console.WriteLine();awaitforeach(var@eventinclient.InvokeAsync(input,CancellationToken.None)){if(@eventisTextMessageContentEventcontentEvent&&!string.IsNullOrEmpty(contentEvent.Delta)){Console.Write(contentEvent.Delta);}}}

我们将用户输入转换成一个AGUIUserMessage对象,并添加到RunAgentInputMessages列表中。对于初始调用,我们还会添加一个AGUISystemMessage对象作为系统指令。我们将RunAgentInput对象作为输入调用AGUIClientInvokeAsync方法,并得到一个IAsyncEnumerable<BaseEvent>对象。在异步迭代中,我们输出TextMessageContentEvent事件携带的实时生成的文本。运行程序后,我们于AI展开如下这段关于战国国君排名的简单对话。

$ (:q or quit to exit): 给战国国君排个序,你觉得前四位会有谁? 若以“综合国力塑造、制度影响、战略眼光、历史结果”衡量,我会把战国国君前四大致排为: 1. 秦孝公:重用商鞅变法,彻底改变秦国结构,为统一奠基。 2. 齐威王:整顿吏治、广纳谏言,齐国一度成为东方最强国。 3. 赵武灵王:推行“胡服骑射”,完成军事革命,使赵国跃升强国。 4. 秦昭襄王:在位最长,重用范雎、白起,持续削弱六国,统一已见雏形。 若看个人雄才,燕昭王、魏文侯、楚悼王也很突出;若看最终成果,秦始皇当然最耀眼,但严格说已属“战国末—秦朝开端”。 $ (:q or quit to exit): 对于这四位,赵雍的结局令人唏嘘,你觉得是什么造成的? 赵武灵王赵雍的悲剧,核心还是“改革成功,却未处理好权力交接”。 他通过胡服骑射让赵国崛起,但晚年过早让位给幼子赵何,自称“主父”,形成“两套权威并存”。同时,他偏爱长子赵章,又未彻底明确继承秩序,结果引发“沙丘之乱”。赵章失败后,赵成、李兑等人担心主父再起变数,最终将赵雍围困沙丘宫,活活饿死。 赵雍强于开创,却失于收束。他敢打破传统,却低估了宗室、贵族与继承问题的破坏力。战国很多名君都能“兴国”,但“善终”往往比改革更难。赵武灵王正是典型例子。 $ (:q or quit to exit): 如果他能向其余三位一样处理好继承人的问题,地位能否排在田婴齐前面? 有可能,甚至不少后世史家会倾向把赵武灵王排到齐威王之前。 赵武灵王的“胡服骑射”不仅是强兵,更是文明层面的制度突破。他直接改变了中原传统战争方式,使赵国从二流国家跃升为能与秦抗衡的强国,对战国军事格局影响极大。相比之下,齐威王的成就更多是“中兴齐国”,制度创新和长期影响力略逊一筹。 但赵雍的问题在于:他留下的是“强国”,却不是“稳固秩序”。他死后赵国内耗加剧,国力虽强,却逐渐失去持续扩张能力。而齐威王给齐国留下的政治结构相对稳定,还开启了稷下学宫的文化高峰。 所以若赵武灵王能平稳完成权力交接,让改革成果延续两三代,他的历史地位确实有机会进入“战国第一流君主”的更前列。

3. 将AGUIClient进一步封装成IChatClient

如果将基于AG-UI的Agent后端视为一个AI服务(实际上就是),我们可以定义一个连接它的IChatClient实现类型,以方便上层应用的使用,毕竟AG-UI的BaseEvent还偏底层。为此我们定义了如下这个AGUIChatClient类型。

如代码片段所示,AGUIChatClient实际上是对上面定义的AGUIClient对象的封装。由于作为AG-UI输入的RunAgentInput需要指定ThreadId,对于IChatClient接口的定义来看,这个ThreadId要么放在传入的消息中,要么放在ChatOptions中,我选择了后者。在实现的GetStreamingResponseAsync中,我们从ChatOptions中取出ThreadId,并将传入的ChatMessage消息列表转换成AGUIMessage消息列表,两者组合生成的RunAgentInput作为调用AGUIClient对象InvokeAsync方法的输入。

publicclassAGUIChatClient(stringserver):IChatClient{privatereadonlyAGUIClient_client=new(server);privatereadonlyJsonSerializerOptions_jsonSerializerOptions=AGUIJsonSerializerContext.Default.Options;publicvoidDispose()=>_client.Dispose();publicasyncTask<ChatResponse>GetResponseAsync(IEnumerable<ChatMessage>messages,ChatOptions?options=null,CancellationTokencancellationToken=default){List<AgentResponseUpdate>updates=[];awaitforeach(varupdateinGetStreamingResponseAsync(messages,options,cancellationToken)){updates.Add(newAgentResponseUpdate(update));}returnnewChatResponse(updates.ToAgentResponse().Messages);}publicobject?GetService(TypeserviceType,object?serviceKey=null)=>null;publicIAsyncEnumerable<ChatResponseUpdate>GetStreamingResponseAsync(IEnumerable<ChatMessage>messages,ChatOptions?options=null,CancellationTokencancellationToken=default){varthreadId=options?.AdditionalProperties?.TryGetValue<string>("agui-thread-id",outvarvalue)==true?value:$"thread-{Guid.NewGuid()}";threadId??=$"thread-{Guid.NewGuid()}";varrunId=$"run-{Guid.NewGuid()}";varinput=newRunAgentInput{ThreadId=threadId,RunId=runId,Messages=messages.Select(AsAGUIMessages).ToList(),};return_client.InvokeAsync(input,cancellationToken).AsChatResponseUpdatesAsync(_jsonSerializerOptions,cancellationToken)}privateAGUIMessageAsAGUIMessages(ChatMessagemessage){varcontent=string.Join("\n\n",message.Contents.OfType<TextContent>().Select(it=>it.Text));varrole=message.Role;returnrole==ChatRole.System?newAGUISystemMessage{Content=content}:role==ChatRole.User?newAGUIUserMessage{Content=newAGUIUserContent(content)}:role==ChatRole.Assistant?newAGUIAssistantMessage{Content=content}:thrownewArgumentException($"ChatMessageType{message.GetType()}is not supported.");}}

我们调用如下定义的扩展方法AsChatResponseUpdatesAsyncAGUIClient对象InvokeAsync方法返回的IAsyncEnumerable<BaseEvent>转换成最终返回的IAsyncEnumerable<ChatResponseUpdate>对象。按照我们之前的假设,我们只考虑RunStartedEventRunFinishedEventRunErrorEventTextMessageStartEventTextMessageEndEvent这五种AG-UI事件。

internalstaticclassChatResponseUpdateAGUIExtensions{privatestaticreadonlyMediaTypeHeaderValue?s_jsonPatchMediaType=new("application/json-patch+json");privatestaticreadonlyMediaTypeHeaderValue?s_json=new("application/json");publicstaticasyncIAsyncEnumerable<ChatResponseUpdate>AsChatResponseUpdatesAsync(thisIAsyncEnumerable<BaseEvent>events,JsonSerializerOptionsjsonSerializerOptions,[EnumeratorCancellation]CancellationTokencancellationToken=default){string?conversationId=null;string?responseId=null;vartextMessageBuilder=newTextMessageBuilder();awaitforeach(varevtinevents.WithCancellation(cancellationToken).ConfigureAwait(false)){switch(evt){caseRunStartedEventrunStarted:conversationId=runStarted.ThreadId;responseId=runStarted.RunId;textMessageBuilder.SetConversationAndResponseIds(conversationId,responseId);yieldreturnnewChatResponseUpdate(ChatRole.Assistant,[]){ConversationId=runStarted.ThreadId,ResponseId=runStarted.RunId,CreatedAt=DateTimeOffset.UtcNow};;break;caseRunFinishedEventrunFinished:yieldreturnnewChatResponseUpdate(ChatRole.Assistant,runFinished.Result?.GetRawText()){ConversationId=conversationId,ResponseId=responseId,CreatedAt=DateTimeOffset.UtcNow};break;caseRunErrorEventrunError:yieldreturnnewChatResponseUpdate(ChatRole.Assistant,[(newErrorContent(runError.Message){ErrorCode=runError.Code})]);break;caseTextMessageStartEventtextStart:textMessageBuilder.AddTextStart(textStart);break;caseTextMessageContentEventtextContent:yieldreturntextMessageBuilder.EmitTextUpdate(textContent);break;caseTextMessageEndEventtextEnd:textMessageBuilder.EndCurrentMessage(textEnd);break;}}}privatesealedclassTextMessageBuilder(){privateChatRole_currentRole;privatestring?_currentMessageId;privatestring?_conversationId;privatestring?_responseId;publicvoidSetConversationAndResponseIds(string?conversationId,string?responseId){_conversationId=conversationId;_responseId=responseId;}publicvoidAddTextStart(TextMessageStartEventtextStart){if(_currentRole!=default||this._currentMessageId!=null){thrownewInvalidOperationException("Received TextMessageStartEvent while another message is being processed.");}_currentRole=AGUIChatMessageExtensions.MapChatRole(textStart.Role);_currentMessageId=textStart.MessageId;}internalChatResponseUpdateEmitTextUpdate(TextMessageContentEventtextContent){returnnewChatResponseUpdate(_currentRole,textContent.Delta){ConversationId=this._conversationId,ResponseId=this._responseId,MessageId=textContent.MessageId,CreatedAt=DateTimeOffset.UtcNow};}internalvoidEndCurrentMessage(TextMessageEndEventtextEnd){_currentRole=default;_currentMessageId=null;}}}

4. 利用AGUIChatClient构建聊天应用

我们将前面聊天应用使用的AGUIClient替换成AGUIChatClient,这样我们可以直接使用ChatMessage进行交流了。

varthreadId=$"thread-{Guid.NewGuid()}";varoptions=newChatOptions{AdditionalProperties=newAdditionalPropertiesDictionary([newKeyValuePair<string,object?>("agui-thread-id",threadId)])};varisFirstDialog=true;varsystemMessage=newChatMessage(ChatRole.System,""" 你是一个深谙中国古代历史的专家,善于根据正史,以公正客观的态度于人交流历史问题。 对于用户提出的问题,请以简介概括性的语言予以答复,字数尽量保持在200字以内。""");usingvarchatClient=newAGUIChatClient("http://localhost:5566");while(true){Console.Write("\n$ (:q or quit to exit): ");varmessage=Console.ReadLine();if(messageis":q"or"quit"){break;}varuserMessage=newChatMessage(ChatRole.User,message);List<ChatMessage>messages=isFirstDialog?[systemMessage,userMessage]:[userMessage];isFirstDialog=false;Console.WriteLine();awaitforeach(varupdateinchatClient.GetStreamingResponseAsync(messages,options)){foreach(AIContentcontentinupdate.Contents){if(contentisTextContenttextContent){Console.Write(textContent.Text);}}}}

这是我们运行程序后进行的一段对话。

$ (:q or quit to exit): 可否认为周公旦是传统中国文化的奠基人之一 可以这样认为,但需加限定。周公旦并非“传统中国文化”的唯一奠基人,却是早期核心塑造者之一。西周初年,他制礼作乐、确立宗法与封建秩序,并以“敬天保民”强化政治伦理,对后世儒家所重视的礼制、德治、名分影响极深。孔子尤其推崇周公,称“郁郁乎文哉,吾从周”,使周公在后世被视为礼乐文明的代表人物。不过,中国传统文化的形成还经历了春秋战国诸子、秦汉制度化等长期发展,因此更准确的说法是:周公旦是中华礼乐政治与儒家传统的重要奠基者之一。 $ (:q or quit to exit): 有没有可能因为周文化的强势,导致商王朝,尤其是帝辛这段历史包括他本人被错误评价? 有这种可能,而且学界普遍承认“胜者书写历史”对商亡周兴的叙述影响很大。现存关于帝辛(商纣王)的主要记载,多出自周人及后世儒家文献,带有“以暴君证明革命合理性”的政治目的,因此诸如“酒池肉林”等故事,很可能存在夸张和道德化加工。 但这不等于帝辛一定是“明君”。甲骨文与考古材料显示,商后期长期战争频繁、赋役沉重,政治压力确实存在。周人能够联合诸侯与部分商人反商,也说明商王朝内部并非毫无矛盾。 因此较稳妥的看法是:帝辛形象大概率被妖魔化了,但商末统治出现严重问题也并非完全虚构。 $ (:q or quit to exit): 但是如何理解“泰誓”记载的伐纣的理由无非是:今殷王纣乃用其妇人之言,自绝于天,毁坏其三正,离其王父母弟,乃断弃其先祖之乐,乃为淫声,用变乱正声,怡说妇人。作为战斗檄文,列举的这些罪行都仅限于此,后世史书记载的那些是否是欲加之罪呢? 这是研究商周之际时常被讨论的问题。《尚书·泰誓》确实很值得注意:其中对帝辛的指责,主要集中于“乱礼”“弃祖制”“亲妇人”“坏正声”等,并未出现后世最著名的炮烙、酒池肉林等极端暴政叙述。 这说明两点:第一,西周初年的政治宣传,核心是强调纣“失德失礼”,因为周人的合法性建立在“天命转移”与礼制正统上;第二,后世关于纣的暴虐形象,很可能是在长期儒家伦理化叙事中不断累积、强化的。 不过也不能据此完全否定商末问题。对古代王朝而言,“弃礼”“疏宗族”“重声色”本身就是严重政治指控,意味着统治集团离心。周人能迅速灭商,也说明商内部确有危机。 因此,更合理的理解是:早期文献中的纣,主要是“失德之君”;而后世则逐渐将其塑造成极端暴君,两者之间存在明显的历史层累。