跳转到主要内容
POST
/
datasets
/
{dataset_id}
/
pipeline
/
run
A valid request URL is required to generate request examples
"<string>"

授权

Authorization
string
header
必填

API Key 认证。对于所有 API 请求,请在 Authorization HTTP 头中包含您的 API Key,并加上 Bearer 前缀。示例:Authorization: Bearer {API_KEY}强烈建议将 API Key 存储在服务端,不要在客户端共享或存储,以避免 API Key 泄漏导致严重后果。

路径参数

dataset_id
string<uuid>
必填

知识库 ID。

请求体

application/json
inputs
object
必填

流水线输入变量的键值对,对应工作流中定义的流水线变量。如果流水线没有输入变量,传 {}

datasource_type
enum<string>
必填

数据源类型。决定 datasource_info_list 中条目所需的字段。

可用选项:
local_file,
online_document,
website_crawl,
online_drive
datasource_info_list
(Local File · object | Online Document · object | Website Crawl · object | Online Drive · object)[]
必填

待处理的数据源对象列表。条目结构取决于 datasource_type

start_node_id
string
必填

流水线开始执行的数据源节点 ID。

is_published
boolean
必填

运行流水线的已发布版本还是草稿版本。true 运行最新已发布版本;false 运行当前草稿(适用于测试未发布的更改)。

response_mode
enum<string>
必填

流水线执行的响应模式。streaming 返回服务器发送事件流,blocking 等待并返回完整结果。

可用选项:
streaming,
blocking

响应

流水线执行结果。格式取决于 response_mode:流式返回 text/event-stream,阻塞返回完整的 JSON 结果。

服务器发送事件流。每行格式为 data: {JSON}\n\n。主要事件:workflow_started(执行开始)、node_started / node_finished(逐节点进度,包含 node_idnode_typestatusinputsoutputs)、workflow_finished(最终结果,包含 statusoutputstotal_tokenselapsed_time)、ping(心跳保活)。