跳到主要内容

简化运行流程

根据 ID 执行指定的流程,支持流式传输和遥测。

此端点根据 ID 或名称执行流程,支持流式传输响应和跟踪执行指标。它处理流式和非流式执行模式。

参数: background_tasks (BackgroundTasks): FastAPI 后台任务管理器 flow (FlowRead | None): 要执行的流程,通过依赖项加载 input_request (SimplifiedAPIRequest | None): 流程的输入参数 stream (bool): 是否流式传输响应 api_key_user (UserRead): 来自 API 密钥请求的认证用户 request (Request): 传入的 HTTP 请求

返回值: Union[StreamingResponse, RunResponse]: 实时结果的流式响应,或包含完整执行结果的 RunResponse

抛出: HTTPException: 流程未找到 (404) 或输入无效 (400) APIException: 内部执行错误 (500)

备注

  • 支持流式和非流式执行模式
  • 通过遥测跟踪执行时间及成功/失败状态
  • 在流式模式下处理客户端的优雅断开
  • 提供详细的错误处理及相应的 HTTP 状态码
  • 在流式模式下,使用 EventManager 处理事件
    • "add_message": 执行期间的新消息
    • "token": 流式传输期间的单个令牌
    • "end": 最终执行结果
路径参数
flow_id_or_name 流程 ID 或名称 必需
查询参数
stream 流式传输
user_id 用户 ID
请求体
未定义
响应
200

成功响应

模式 可选
未定义
422

验证错误

模式 可选
detail object[] 可选
loc undefined[]
msg 消息
type 错误类型
Search