English mirror
This English page is generated from the current Chinese documentation so every route, anchor, code sample, and language switch stays available on agently.tech. Human-edited English copy can replace this generated body page by page.
术语表
这不是按字母排序的名词索引。Agently 的术语最好按学习顺序看:先理解 Agent 定义和一次执行,再理解外部能力、长期证据、工作流、动态任务和兼容迁移。
每个词条都回答三件事:它是什么,什么时候需要关心,继续读哪里。
请求与输出
Agent
Agent 是 Agently 里保存可复用行为的主要入口,例如模型设置、固定 prompt、Actions、Skills、Workspace 和 policy。
当应用从“一段 prompt 调模型”变成“有配置、有输出契约、有能力挂载”的代码时,用 Agent 管长期定义,用 AgentExecution 管本轮执行。
继续读:快速开始
Agent definition / define
agent.define(...) 是推荐的 Agent 定义入口,用来声明长期可复用的行为,而不是把每个用户请求都写进共享 prompt 状态。
当服务里复用同一个 Agent 实例,或者需要把角色、固定规则、Actions、Skills、Workspace 和 policy 放在一起时,需要它。
继续读:Agent 自动编排
AgentExecution
AgentExecution 是一次 Agent run 的推荐 owner。.input(...)、.goal(...)、.success_criteria(...)、.output(...) 等本轮信息进入 execution draft,执行后通过 AgentExecutionResult 读取数据、文本、流、状态和诊断。
当你需要把长期 Agent 定义和本轮输入隔离,或者需要观察一次执行的 route、stream、meta、task refs 时,需要理解它。
继续读:Agent 自动编排
Model Request
Model Request 是一次模型调用的请求对象,包含 input、prompt、output schema、settings、streaming 等信息。
当你需要把 prompt、输出格式、校验或流式消费拆开控制时,需要理解它。日常代码通常通过 agent.input(...).output(...) 创建。
继续读:Requests 概览
Output Schema
Output Schema 描述模型应该返回什么结构。Agently 常用嵌套 dict、list 和 (type, description, ensure) 叶子来写。
当下游代码要稳定读取字段,而不是解析一段自由文本时,就需要它。
继续读:Schema as Prompt、输出控制
ensure
ensure 是 output 叶子第三槽里的必填标记,例如 (str, "客户回复", True)。置为 True 后,该字段缺失、为空或不符合要求时会进入校验和 retry。
它不是默认值。旧文档里“第三槽等于 default value”的理解不适用于当前推荐写法。
继续读:输出控制
Model Response / Result
Result 是一次模型响应的读取入口。它可以从同一次调用里读 text、data、meta,也可以消费 delta 或 instant stream。
非一次性脚本建议先拿 get_result(),再按需要读取不同视图,这样不会为了读 text 和 data 重复发请求。
继续读:模型响应
Streaming / Instant
delta 是原始 token 流;instant 是结构化字段流,带 path、delta、value 和 is_complete。
如果只是终端打字效果,用 delta。如果 UI 要按字段实时更新,比如先显示 status_summary,再显示 risk_flags,用 instant。
外部能力
Action
Action 是模型在一次请求里可以调用的外部能力,可以是本地函数、MCP tool、搜索、浏览、沙箱命令或业务系统 adapter。
当模型不只是回答,而是需要查询、计算、执行或写入外部系统时,需要 Action。
继续读:Actions 概览
Action Runtime
Action Runtime 负责把模型提出的 action call 归一化、分发给执行器,并留下调用记录。
当项目不再只是挂一个函数,而是要管理多种能力、日志和兼容 tools 时,需要理解它。
继续读:Action Runtime
Action Executor
Action Executor 是真正执行一次能力调用的后端,比如函数执行器、MCP 执行器、Python/Bash/Node/SQLite 执行器。
应用开发者通常先用内置能力;只有在写自定义执行后端时,才需要深入它。
MCP
MCP 是把外部工具服务接入模型应用的一种协议。Agently 可以把 MCP tool 装进 Action surface,让模型在请求期调用。
当能力已经以 MCP server 形式存在,或者团队希望工具协议与应用代码分离时,需要它。
继续读:MCP
Execution Environment
Execution Environment 负责在 action 调用前准备和复用外部资源,例如 MCP server、浏览器、SQLite、Node.js、Docker 或沙箱。
当外部能力不是一个纯函数,而是有启动、健康检查、资源复用或 policy 约束时,需要它。
Skills Executor
Skills Executor 是运行时读取、选择、挂载能力说明和执行路线的机制,适合 coding-agent guidance 或企业内部能力包。
它不是简单的 prompt 片段,也不是第二套执行器。需要把可发现的能力说明和实际执行路线放在一起时,再使用它;具体执行仍应映射回 Prompt、Actions、ExecutionEnvironment 或 TriggerFlow。
继续读:Skills Executor
工作流
TriggerFlow
TriggerFlow 是 Agently 的工作流执行生命周期层,负责分支、并发、事件、execution stream、暂停恢复、保存恢复和子流组合。
当应用代码已经知道流程拓扑,并且流程需要生命周期管理时,使用 TriggerFlow。单次请求或 2-3 步简单 async 管道通常不需要它。
继续读:TriggerFlow 概览
Execution
Execution 是某个 TriggerFlow 定义的一次运行。一个 flow 可以有多个并发 execution。
当流程需要开始、暂停、恢复、关闭、保存或查询运行状态时,需要理解 execution。
继续读:Lifecycle
State
State 是 execution-local、可序列化、可进入 close snapshot 的数据面。
当流程里的多个步骤要共享业务状态,或者需要保存恢复时,把数据放进 state。
Runtime Resources
Runtime Resources 是当前 TriggerFlow API 里 execution-local 活对象存储的兼容名,比如数据库 client、socket、回调函数或 cache 句柄。它不进入 snapshot,也不参与 save/load。
新架构语言优先说 execution-local resources。流程需要临时使用不可序列化对象时,使用这类资源,并在恢复后重新注入。
Runtime Stream
Runtime Stream 是当前 API 里 execution 向外推送 live item 的流;新文档会逐步把架构语言收束到 execution stream。
当 UI、SSE、WebSocket 或 worker 需要看到流程进度,而不是只等最终 snapshot 时,需要它。
继续读:事件与流
Pause / Resume
Pause / Resume 让流程暂停等待人工审批、外部事件或业务系统回调,再从指定位置恢复。
当流程中间不能自动走完,或者要等人/系统确认时,需要它。
继续读:Pause 与 Resume
任务与自动编排
Agent Auto-Orchestration
Agent Auto-Orchestration 是 AgentExecution 的路线选择能力:在普通模型请求、Actions、Skills、Dynamic Task 或 task strategy 候选中选择合适路径。
当应用希望交给 agent 在明确开放的候选能力里判断路线,而不是强制走某个显式 API 时,才使用它。
继续读:Agent 自动编排
Dynamic Task
Dynamic Task 面向模型生成或应用提交的 DAG。它是 TaskDAG 的便利 facade:先校验任务图,再编译到底层 TriggerFlow 执行。
当“计划本身”是输入数据,而不是应用代码里已经写死的流程拓扑时,用它。普通 Agent prompt、外层长任务生命周期或固定工作流不应该默认从 Dynamic Task 开始。
继续读:Dynamic Task
TaskDAG
TaskDAG 是 Agently 的有向无环任务图基础结构。它描述节点、依赖、输入输出和执行约束,Dynamic Task 是面向应用开发的便利入口之一。
当你要让模型生成计划、让应用提交计划,或检查计划是否合法时,需要它。
继续读:Dynamic Task
AgentTaskLoop
AgentTaskLoop 是 AgentExecution 背后的有边界长任务 strategy,用于计划、执行一个 bounded step、写入 Workspace 证据、验证和必要时 replan。
它不是第二个推荐公开生命周期。新代码应优先创建或消费 AgentExecution / AgentExecutionResult;只有需要 2 到 5 轮、有明确成功标准的单 Agent 任务时,才显式选择 task strategy。
继续读:Agent 自动编排
服务与观测
FastAPI Helper
FastAPI Helper 把 Agently request、agent 或 TriggerFlow 暴露成 HTTP、SSE 或 WebSocket 形态。
当原型脚本要进入服务端工程,或者前端要消费流式结果时,需要它。
继续读:FastAPI 服务封装
Event Center
Event Center 承载 Agently 的 RuntimeEvent,让请求、Action、ExecutionEnvironment 和流程事件能被外部观察。DevTools 使用的是从 RuntimeEvent 投影出来的 ObservationEvent payload。
当团队需要调试、记录或接入 DevTools 时,需要它。
继续读:Event Center
DevTools
DevTools 是 Agently 的可视化观察和调试入口。
当项目进入多人协作、复杂流程或服务化阶段,DevTools 能帮助检查一次执行里发生了什么。
继续读:DevTools
迁移与兼容
get_response()
get_response() 是旧代码里的读取入口。当前推荐用 get_result(),再按需要读 get_text()、get_data() 或 get_meta()。
维护旧项目时需要认识它;新代码不要把它当第一入口。
继续读:模型响应
.end() / set_result()
.end() 和 set_result() 是旧 TriggerFlow 结果写入方式。当前推荐让 execution close snapshot 直接承载最终 state。
迁移旧 flow 时需要关注;新 flow 应直接更新 state 并读取 close snapshot。
继续读:TriggerFlow 兼容
$final_result
$final_result 是兼容旧 .end() / set_result() 时出现在 close snapshot 里的保留 key。
看到它通常说明项目里还有旧结果写法。新代码不要依赖它设计业务数据结构。
继续读:TriggerFlow 兼容
legacy tools
旧 tools API 仍可用于兼容,但新项目应优先使用 Agently.action、agent.use_actions(...)、内置 action packages 和 Agent Component helpers。
迁移时先确认旧 tools 做的是请求期能力调用,还是其实应该升级成 TriggerFlow 工作流。
继续读:工具兼容、Actions 概览