跳到主要内容

实验性运行流

通过 ID 执行指定的流，可包含可选的输入值、输出选择、调整和流式传输功能。

此端点支持使用缓存运行流，以提高性能和效率。

参数：​

  • flow_id (str): 要执行的流的唯一标识符。
  • inputs (List[InputValueRequest], optional): 指定流的输入值和组件的输入列表。每个输入都可以针对特定组件并提供自定义值。
  • outputs (List[str], optional): 要从执行的流中检索的输出名称列表。如果未提供，则返回所有输出。
  • tweaks (Optional[Tweaks], optional): 用于自定义流执行的调整字典。调整可用于修改流的参数和组件。调整可以被输入值覆盖。
  • stream (bool, optional): 指定结果是否应进行流式传输。默认为 False。
  • session_id (Union[None, str], optional): 一个可选的会话 ID，用于利用现有会话数据进行流执行。
  • api_key_user (User): 与当前 API 密钥关联的用户。自动从 API 密钥解析。

返回值：​

一个 RunResponse 对象，包含执行流的选定输出（如果未指定则为全部输出）和会话 ID。响应结构可容纳多个输入，为每个输入提供一个嵌套的输出列表。

引发：​

HTTPException: 表示查找指定流、输入格式无效或流执行期间发生内部错误的问题。

示例用法：​

POST /run/flow_id
x-api-key: YOUR_API_KEY
Payload:
{
    "inputs": [
        {"components": ["component1"], "input_value": "value1"},
        {"components": ["component3"], "input_value": "value2"}
    ],
    "outputs": ["Component Name", "component_id"],
    "tweaks": {"parameter_name": "value", "Component Name": {"parameter_name": "value"}, "component_id": {"parameter_name": "value"}}
    "stream": false
}

此端点通过自定义输入、输出和配置，方便地执行复杂的流，满足各种应用需求。

路径参数
flow_id uuid — 必需
请求体
inputs 输入
outputs 输出
tweaks
stream 流式传输
session_id 会话 ID
响应
200

成功响应

模式 — 可选
outputs 输出 — 可选
session_id 会话 ID — 可选
422

验证错误

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