AG-UI协议怎么同步状态

梦婷酱_1996

梦婷酱_1996

2026-11-17

399人浏览

原创

AG-UI 用 STATE_SNAPSHOT 发送完整共享状态,再用 STATE_DELTA 发送 JSON Patch。客户端收到快照时建立或替换本地基线,收到补丁时按顺序应用。这个示例会把 count 从 0 改为 1。

把业务状态和聊天文本分开看

用共享表单的时候,你可以直接在界面上编辑偏好设置,下一轮agent运行会自动把当前状态塞进输入里,agent也能主动发状态事件同步更新界面。下面的练习只演示服务端往客户端推送的逻辑:先下发count的初始值,再通过一次replace操作修改对应字段。

启动只发送一次状态变化的本地端点

新建一个空的练习目录,先创建Python虚拟环境,安装好用来处理补丁的jsonpatch库,下面的服务代码保存成server.py。

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

from fastapi import FastAPI
from fastapi.responses import StreamingResponse
from ag_ui.core import (
    RunAgentInput, RunStartedEvent, RunFinishedEvent,
    StateSnapshotEvent, StateDeltaEvent,
)
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("/state")
async def run_state(data: RunAgentInput):
    return stream(data, [
        StateSnapshotEvent(snapshot={"count": 0}),
        StateDeltaEvent(delta=[{"op": "replace", "path": "/count", "value": 1}]),
    ])
python -m uvicorn server:app --host 127.0.0.1 --port 8000

新开一个终端窗口,切到刚才的同一个目录下,新建run.json写入下面的内容,之后请求/state接口,确认两条状态事件都能被捕获到文件里。

{
  "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/state > state.sse
grep "STATE_" state.sse

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

实测 STATE_SNAPSHOT 和针对 count 的 STATE_DELTA

先替换基线,再按序应用 JSON Patch

把下面的代码保存为state_reader.py,直接在之前创建的虚拟环境里运行就行。如果新开的终端没激活虚拟环境,先执行source .venv/bin/activate,脚本会按响应文件里的事件顺序,完整处理一次Agent运行的全流程。

HitPaw
HitPaw

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

下载
import json
from pathlib import Path

import jsonpatch

state = None
for line in Path("state.sse").read_text().splitlines():
    if not line.startswith("data: "):
        continue
    event = json.loads(line[6:])
    if event["type"] == "STATE_SNAPSHOT":
        state = event["snapshot"]
        print("snapshot:", json.dumps(state))
    elif event["type"] == "STATE_DELTA":
        if state is None:
            raise SystemExit("No snapshot")
        try:
            state = jsonpatch.apply_patch(state, event["delta"])
        except jsonpatch.JsonPatchException as error:
            raise SystemExit(f"Invalid patch: {error}") from error
        print("patched: ", json.dumps(state))
python state_reader.py

客户端先读到 count 为 0 再补丁更新为 1

这个示例里的replace操作要求路径下的/count字段必须已经存在。想测试异常处理逻辑的话,可以先给state.sse做个备份,删掉快照对应的那行data再重跑脚本,就会触发缺失基线的退出逻辑。把原始SSE文件恢复之后,再确认两次状态输出是按预期顺序打印的。

补丁不匹配时如何恢复同步

实际业务场景里,要保证同一次运行下发的所有补丁按顺序全部生效。如果某条补丁无法正常应用,直接停止处理这批增量,按照之前约定的业务规则拉取一份新的完整快照重新同步就好。反复重试失败的旧补丁,很容易把不同时间点的数据混在一起。遇到并发运行的场景,还要提前明确哪些运行允许修改同一份状态,以及前端提交修改时的冲突检查规则。

相关文章

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万人学习