创建预配任务

为新引擎或现有引擎生成指导内容,并保存任务 ID,以便跟踪进度和恢复任务。

预配在后台运行,API 接受请求后便会启动。所有路由均使用 https://api.lingo.dev 和 API 身份验证。

创建并填充引擎 #

http
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
json
{
  "engine": { "name": "Acme support", "description": "Customer support content" },
  "kinds": {
    "glossary": { "name": "Product terminology" },
    "ruleset": { "name": "Support writing rules" },
    "brandVoice": { "name": "Support voice" }
  },
  "sources": [
    { "_tag": "Link", "url": "https://example.com/style-guide" },
    { "_tag": "Content", "text": "Use clear, direct sentences. Keep the product name Acme unchanged." }
  ]
}

将示例 URL 替换为包含指导内容且可访问的页面地址,或直接提供文本。

字段约定
engine必填的引擎创建对象。name 不能为空;description 为可选项。该对象还可包含模型配置、覆盖范围和流水线设置。
kinds必填对象,须至少选择 glossary、ruleset 或 brandVoice 中的一项。每个所选项的值为 {} 或 { "name": "Nonempty name" }。
sources必填的非空数组,最多包含十个链接或文本来源。

引擎设置遵循引擎创建约定。sourceCoverage 和 targetCoverage 是语言区域数组,[] 则涵盖所有语言区域。省略 modelConfigs 时,会填入平台默认的模型配置;[] 则不固定任何模型配置。使用引擎翻译前,请先配置其模型。

调用方需要拥有创建引擎及所请求指导内容的权限。引擎数量、套餐功能、账户余额和预配速率限制都可能导致请求被拒绝。

填充现有引擎 #

http
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/json

如需仅填充引擎尚未关联内容集的类型:

json
{
  "kinds": { "_tag": "Empty" },
  "sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}

如需请求特定的新内容集:

json
{
  "kinds": {
    "_tag": "Requested",
    "glossary": { "name": "Support terminology" },
    "ruleset": {}
  },
  "sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}

Requested 可以在保留现有术语表或规则集的同时,添加新的术语表或规则集。预配绝不会替换已关联的品牌语调。Empty 会跳过已关联内容集的类型,包括在任务运行期间关联的内容集。请查看各类型的处理结果,不要假定每次请求都会创建全部三种类型。

每个引擎同一时间只能运行一个预配任务。ProvisioningJobRunning(409)包含现有任务的 jobId;提交更多任务前,请先跟踪该任务。NothingToProvision(409)表示在引擎当前状态下,所请求的操作均无法填充该引擎。

保存响应 #

两个创建路由都会返回 HTTP 200 和一个预配任务。开始轮询前,请保存 id 和 engineId。初始状态通常为 status: { "_tag": "Running" }。

创建操作未声明幂等性标头。如果响应丢失,请先检查正在运行的任务和引擎列表,再重复提交新引擎请求,因为重复请求可能会创建另一个引擎。恢复介绍了这些检查方法,以及如何重试失败的类型。