AG-UI协议怎么实现流式输出

冬静小哥_2485

冬静小哥_2485

2026-11-17

164人浏览

原创

AG-UI 的流式文本由 TEXT_MESSAGE_START、TEXT_MESSAGE_CONTENT 和 TEXT_MESSAGE_END 组成。客户端按 messageId 创建文本槽、依次追加 delta,再结束这条消息。运行是否成功结束,要另外检查 RUN_FINISHED。

用 POST 请求捕获 SSE 文本流

先准备好能返回ag-ui sse流的接口。下面例子用的是监听127.0.0.1:8000的固定返回演示服务,你要是已经有现成服务,直接替换对应url就行。

没有现成端点时,启动独立练习服务

先新建一个空目录装依赖,把后面的Python代码存成server.py,再启动服务就好。

python3 -m venv .venv
source .venv/bin/activate
python -m pip install ag-ui-protocol==1.0.0 fastapi uvicorn
import asyncio
from uuid import uuid4

from fastapi import FastAPI
from fastapi.responses import StreamingResponse
from ag_ui.core import (
    RunAgentInput, RunStartedEvent, RunFinishedEvent,
    TextMessageStartEvent, TextMessageContentEvent, TextMessageEndEvent,
)
from ag_ui.encoder import EventEncoder

app = FastAPI()

def stream(data, payloads):
    encoder = EventEncoder()
    identifiers = {"thread_id": data.thread_id, "run_id": data.run_id}
    async def events():
        yield encoder.encode(RunStartedEvent(**identifiers))
        for event in payloads:
            yield encoder.encode(event)
            await asyncio.sleep(0.3)
        yield encoder.encode(RunFinishedEvent(**identifiers))
    return StreamingResponse(events(), media_type=encoder.get_content_type())

@app.post("/")
async def run_text(data: RunAgentInput):
    mid = str(uuid4())
    return stream(data, [
        TextMessageStartEvent(message_id=mid, role="assistant"),
        *(TextMessageContentEvent(message_id=mid, delta=part)
          for part in ("Hello ", "from ", "AG-UI!")),
        TextMessageEndEvent(message_id=mid),
    ])
python -m uvicorn server:app --host 127.0.0.1 --port 8000

新开一个终端,进入刚才的目录,把下面的JSON内容存成run.json。同一个对话要发起新一轮运行的话,记得换个新的runId。

{
  "threadId": "demo-thread",
  "runId": "demo-run-01",
  "state": {},
  "messages": [{"id":"u1","role":"user","content":"Hello"}],
  "tools": [],
  "context": [],
  "forwardedProps": {}
}
curl -fsSN -H 'Accept: text/event-stream' \
  -H 'Content-Type: application/json' --data-binary @run.json \
  http://127.0.0.1:8000/

第一次运行直接看终端输出,能直观看到文本逐段出来的节奏,确认流是持续推送的。第二次可以先改个新的runId,把输出存到本地文件,方便逐一核对每个data帧和空行的边界。

curl -fsSN -H 'Accept: text/event-stream' \
  -H 'Content-Type: application/json' --data-binary @run.json \
  http://127.0.0.1:8000/ > text.sse

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

固定回复服务发出的三个文本增量帧

按 messageId 把 delta 拼成完整回答

下面的脚本适配刚才演示生成的、每条JSON单独占一行的SSE文件。把代码存成text_reader.py,和之前生成的text.sse放在同一个目录。逻辑很简单:收到START事件就初始化对应缓冲区,收到CONTENT就原样追加内容,所以千万不要给每段delta加strip处理,等收到END事件再取出整条完整消息。

HitPaw
HitPaw

HitPaw是一套覆盖视频编辑、图片增强、音视频转换和 AI 修复的多媒体工具。

下载
import json
from pathlib import Path

messages = {}
finished = False
for line in Path("text.sse").read_text().splitlines():
    if not line.startswith("data: "):
        continue
    event = json.loads(line[6:])
    kind = event["type"]
    if kind == "TEXT_MESSAGE_START":
        messages[event["messageId"]] = ""
    elif kind == "TEXT_MESSAGE_CONTENT":
        messages[event["messageId"]] += event["delta"]
    elif kind == "TEXT_MESSAGE_END":
        print(messages.pop(event["messageId"]))
    elif kind == "RUN_ERROR":
        raise SystemExit(event["message"])
    elif kind == "RUN_FINISHED":
        finished = True

if not finished or messages:
    raise SystemExit("Incomplete event stream")
print("RUN_FINISHED")
python3 text_reader.py

从 AG-UI 增量事件归并得到完整消息和运行结束

要是做网页端对接,内容事件一到就可以直接更新页面上的消息组件,等整条消息结束再执行保存、提交最终结果的逻辑就行。线上正式用的客户端一定要用完整的SSE解帧能力,兼容空行、多data行、注释这类情况。因为浏览器自带的EventSource接口默认发GET请求,对接POST类型的AG-UI端点,要么用官方协议SDK,要么自己通过fetch读取响应流,再交给专门的SSE解析器处理。

已收到部分文字,为什么仍可能失败

RUN_ERROR属于流内主动抛出的错误。要是连接中途断开,全程没收到运行终止事件,要把这次流判定为截断异常做好日志记录。界面上可以保留已经生成的文字,同时标注这条消息未完成。如果你发现直连接口时内容是逐段出来的,走代理之后所有内容才一次性返回,可以先同一个接口分别走直连、走代理两种方式,用curl的-N参数观察输出情况,再排查代理的缓冲设置,以及应用侧每次yield推送事件的时机。

当前HTTP+SSE的对接方案没有用Last-Event-ID做断流续传,重试请求相当于发起全新的运行,得用新的runId。如果这个运行会触发实际的业务写入操作,服务端一定要根据请求参数做幂等校验,判断对应逻辑有没有已经执行过,避免重跑的时候重复写入数据。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

80

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

120

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

120

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

100

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

120

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习