Skip to content

Commit d90867d

Browse files
feat(eino): update adk hitl doc to exit alpha stage (#1465)
1 parent 69802e2 commit d90867d

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

content/zh/docs/eino/core_modules/eino_adk/agent_hitl.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,6 @@ weight: 8
1111

1212
本文档提供 Eino 的human-in-the-loop (Human-in-the-Loop, HITL) 框架架构的技术细节,重点介绍中断/恢复机制和底层的寻址系统。
1313

14-
## Alpha 版本发布公告
15-
16-
> **注意**:本文档中描述的human-in-the-loop框架是一个 **Alpha 功能**
17-
18-
- **发布标签**`v0.7.0-alpha.X`
19-
- **稳定性**:在正式发布前,API 和功能可能会发生变化。
20-
- **Alpha 阶段**:Alpha 阶段预计将在 2025 年 11 月底前结束。
21-
22-
我们欢迎在此阶段提供反馈和贡献,以帮助我们改进该框架。
23-
2414
## human-in-the-loop的需求
2515

2616
下图说明了在中断/恢复过程中,每个组件必须回答的关键问题。理解这些需求是掌握架构设计背后原因的关键。
@@ -191,22 +181,22 @@ if event.Action != nil && event.Action.Interrupted != nil {
191181

192182
### 3. 用于最终用户恢复的 API
193183

194-
#### `(*Runner).TargetedResume`
184+
#### `(*Runner).ResumeWithParams`
195185
使用“显式定向恢复”策略从检查点继续中断的执行。这是最常见和最强大的恢复方式,允许您定位特定的中断点并为其提供数据。
196186

197187
使用此方法时:
198-
- 地址在 `targets` 映射中的组件将是显式目标。
199-
- 地址不在 `targets` 映射中的被中断组件必须重新中断自己以保留其状态。
188+
- 地址在 `ResumeParams.Targets` 映射中的组件将是显式目标。
189+
- 地址不在 `ResumeParams.Targets` 映射中的被中断组件必须重新中断自己以保留其状态。
200190

201191
```go
202-
func (r *Runner) TargetedResume(ctx context.Context, checkPointID string,
203-
targets map[string]any, opts ...AgentRunOption) (*AsyncIterator[*AgentEvent], error)
192+
func (r *Runner) ResumeWithParams(ctx context.Context, checkPointID string,
193+
params *ResumeParams, opts ...AgentRunOption) (*AsyncIterator[*AgentEvent], error)
204194
```
205195

206196
**参数:**
207197
- `ctx`: 用于恢复的上下文。
208198
- `checkPointID`: 要从中恢复的检查点的标识符。
209-
- `targets`: 中断 ID 到恢复数据的映射。这些 ID 可以指向整个执行图中的任何可中断组件。
199+
- `params`: 中断参数,包含中断 ID 到恢复数据的映射。这些 ID 可以指向整个执行图中的任何可中断组件。
210200
- `opts`: 额外的运行选项。
211201

212202
**返回:** agent 事件的异步迭代器。
@@ -222,7 +212,7 @@ resumeData := map[string]any{
222212
}
223213

224214
// 使用目标数据恢复执行。
225-
resumeIterator, err := runner.TargetedResume(ctx, "my-checkpoint-id", resumeData)
215+
resumeIterator, err := runner.ResumeWithParams(ctx, "my-checkpoint-id", &ResumeParams{Targets: resumeData})
226216
if err != nil {
227217
// 处理错误
228218
}
@@ -251,7 +241,7 @@ type ResumeInfo struct {
251241
// InterruptState 持有通过 StatefulInterrupt 或 CompositeInterrupt 保存的状态。
252242
InterruptState any
253243

254-
// IsResumeTarget 指示此 agent 是否是 TargetedResume 的特定目标。
244+
// IsResumeTarget 指示此 agent 是否是 ResumeWithParams 的特定目标。
255245
IsResumeTarget bool
256246

257247
// ResumeData 持有用户为此 agent 提供的数据。

0 commit comments

Comments
 (0)