docs: update agent and UI protocol documentation
- Update api-endpoints.md with new agent endpoints - Update run-agent-input.md with new input schemas - Update sse-events.md with new event types - Update ui-schema.md with schema changes
This commit is contained in:
@@ -185,12 +185,13 @@ interface Context {
|
||||
|
||||
---
|
||||
|
||||
## forwardedProps Schema(当前仅支持 client_time)
|
||||
## forwardedProps Schema(支持 agent_type + client_time)
|
||||
|
||||
`RunAgentInput.forwardedProps` 支持透传客户端时间上下文。日历相关能力必须使用以下结构:
|
||||
`RunAgentInput.forwardedProps` 支持透传运行模式与客户端时间上下文。日历相关能力必须使用以下结构:
|
||||
|
||||
```typescript
|
||||
interface ForwardedProps {
|
||||
agent_type: string; // 必填,运行模式(如 "worker" / "memory")
|
||||
client_time?: {
|
||||
device_timezone: string; // IANA 时区,例如 "America/Los_Angeles"
|
||||
client_now_iso: string; // RFC3339 带偏移时间,例如 "2026-03-16T09:12:33-07:00"
|
||||
@@ -213,7 +214,9 @@ interface ForwardedProps {
|
||||
- `device_timezone` 必须是有效 IANA 时区。
|
||||
- `client_now_iso` 必须是 RFC3339 且包含时区偏移。
|
||||
- `client_epoch_ms` 必须是整数毫秒时间戳。
|
||||
- `forwardedProps` 当前仅允许 `client_time`,额外字段会触发 `422 invalid RunAgentInput.forwardedProps`。
|
||||
- `forwardedProps.agent_type` 必填,且必须匹配后端已注册的 agent type。
|
||||
- `agent_type=memory` 为自动化任务内部模式,HTTP `/agent/runs` 入口不接受该值。
|
||||
- `forwardedProps` 仅允许 `agent_type` 与 `client_time`,额外字段会触发 `422 invalid RunAgentInput.forwardedProps`。
|
||||
- 业务代码不得使用服务器本地时区作为事件语义时区。
|
||||
|
||||
### 说明
|
||||
@@ -235,6 +238,7 @@ Backend 实现了以下验证规则:
|
||||
| runId 最大 128 字符 | `runId exceeds length limit` |
|
||||
| messages ≤ 200 条 | `RunAgentInput.messages exceeds limit` |
|
||||
| user text ≤ 10,000 字符 | `RunAgentInput user message text exceeds limit` |
|
||||
| forwardedProps.agent_type 必填 | `invalid RunAgentInput.forwardedProps` |
|
||||
| **恰好 1 条 user message** | `RunAgentInput.messages must contain exactly one user message` |
|
||||
| user message 必须在第一条 | `RunAgentInput.messages[0].role must be user` |
|
||||
| binary 必须是 image/* | `binary content requires image mimeType` |
|
||||
@@ -272,7 +276,9 @@ Backend 实现了以下验证规则:
|
||||
],
|
||||
"tools": [],
|
||||
"context": [],
|
||||
"forwardedProps": {}
|
||||
"forwardedProps": {
|
||||
"agent_type": "worker"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -302,7 +308,9 @@ Backend 实现了以下验证规则:
|
||||
],
|
||||
"tools": [],
|
||||
"context": [],
|
||||
"forwardedProps": {}
|
||||
"forwardedProps": {
|
||||
"agent_type": "worker"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -337,7 +345,9 @@ Backend 实现了以下验证规则:
|
||||
}
|
||||
],
|
||||
"context": [],
|
||||
"forwardedProps": {}
|
||||
"forwardedProps": {
|
||||
"agent_type": "worker"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -358,6 +368,7 @@ Backend 实现了以下验证规则:
|
||||
"tools": [],
|
||||
"context": [],
|
||||
"forwardedProps": {
|
||||
"agent_type": "worker",
|
||||
"client_time": {
|
||||
"device_timezone": "America/Los_Angeles",
|
||||
"client_now_iso": "2026-03-16T09:12:33-07:00",
|
||||
@@ -520,5 +531,5 @@ interface UiSchemaRenderer {
|
||||
- `tools` 是前端工具通道字段;当前后端运行时不基于该字段构造后端工具 prompt
|
||||
- `RunAgentInput` 同时接受 camelCase 与 snake_case 别名输入(推荐统一使用 camelCase)
|
||||
- 日历能力依赖 `forwardedProps.client_time` 透传设备时间上下文;缺失时回退用户 profile 时区
|
||||
- `forwardedProps` 不支持业务私有控制字段(例如 `system_agent_mode`)
|
||||
- `forwardedProps.agent_type` 是受控路由字段,必须由调用方显式传入;后端 task 不做默认赋值
|
||||
- tool 消息在存储层用于运行时上下文续接,不在 `/history` 对外返回
|
||||
|
||||
Reference in New Issue
Block a user