读取预配结果
查看作业、生成的集合、跳过的工作及部分失败情况。
使用创建时返回的 ID 读取预配作业:
http
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEY作业字段 #
| 字段 | 含义 |
|---|---|
id, organizationId, engineId | 作业标识,以及作业所属的组织和引擎。 |
status | 以 Running、Completed 或 Failed 标记的状态。Failed 包含 message。 |
kinds | 请求执行的 glossary、ruleset 和 brandVoice 工作的结果。未请求的类型可能不包含在内。 |
sources | 可选的来源读取进度或报告。 |
website | 提供的第一个网站 URL;仅输入文本时不包含此字段。 |
createdAt | ISO 格式的创建时间戳。 |
finishedAt | ISO 格式的完成时间戳,处理结束后才会出现。 |
各类型的状态 #
即使顶层作业处于 Completed 状态,也要检查每个请求的类型:
kinds.<kind>._tag | 字段及含义 |
|---|---|
Pending | 仍在处理中。可选字段 step 的值为 reading、generating 或 saving;startedAt 表示该步骤的开始时间。 |
Done | setId 标识已附加的集合;itemCount 表示生成的条目数量。 |
Skipped | reason 说明该类型保持不变的原因。 |
Failed | message 说明无法填充该类型的原因。 |
例如,以下结果片段包含一个已生成的术语表和一个生成失败的规则集:
json
{
"glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
"ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}各类型的结果独立保存。即使某个类型生成失败,其他类型成功生成的指导内容仍然可用。生成过程中,引擎也可能新增附加内容,导致仅填充空类型的操作或品牌语调填充被跳过。
检查生成的记录 #
在 Studio 中打开引擎,然后查看已附加的术语表、规则集或品牌语调。如需通过 API 读取,请使用:
GET /v2/glossaries/:id/terms,用于读取术语表条目。GET /v2/rulesets/:id/rules,用于读取规则。GET /v2/brand-voices/:id/variations,用于读取品牌语调变体。
使用对应的 setId,并按各列表的分页逐页读取。检查术语、在各语言中的适用性、不可翻译的名称,以及模型添加的任何假设。条目数量仅表示创建的记录数,并不代表记录的正确性。
对于失败的类型,请参阅重试与恢复。保留已完成的集合,不要另建引擎来重复执行所有工作。