浏览帮助中心

通过 API 本地化 Markdown 文档

Vitalii Vlasiuk 维护Co-founder

大多数文档、帮助文章和 CMS 内容本身就采用 Markdown 格式。您可以将其原样发送至 API,针对多种语言运行工作流,并获取结构完整、格式一致的各语言版本 Markdown。

本页内容

如何发送 Markdown 文档?

调用 POST /documents 接口,设置 content_type: "markdown" 并指定目标语言。Transept 会将文档拆分为区块,并为每个目标语言创建一个版本。

然后按照通过 API 自动化 Transept中的说明进行估算和运行;只需一次调用,即可同时处理所有语言版本。

# BASE="https://app.transept.ai/api/public/v1"; KEY from Settings → Developer
curl -s -X POST $BASE/documents \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"title": "Getting started", "content_type": "markdown", "source_language": "en",
       "target_languages": ["de", "fr"],
       "content": "# Getting started\n\nInstall the app, then…"}'
# → { document_id, language_group: [ {id, target_language}, … ] }

如何获取翻译结果?

对各语言版本调用 GET /documents/{id}/content?format=markdown 即可返回结构完整的 Markdown。其他格式(用于按区块读取的 json,以及 docxpdfxliffcsv)均列在通过 API 自动化 Transept的格式表中。

curl -s "$BASE/documents/<de-version-id>/content?format=markdown" \
  -H "Authorization: Bearer $KEY"

如何仅重新翻译发生变化的内容?

当源文档后续发生变更时,请使用重新对齐 (re-align) 而非重新导入:POST /documents/{id}/resync-source 会保留未改动的区块(及其译文),并将更改或新增的区块标记为过时 (stale),随后以“仅更新”模式运行将仅处理这些区块。它是 通过 API 本地化字符串目录 中键值增量 (keyed delta) 在文档文本 (prose) 领域的对应版本;其通用行为详见 仅运行已更改的内容

# the source changed? re-align, then run only what went stale
curl -s -X POST $BASE/documents/<master>/resync-source \
  -H "Authorization: Bearer $KEY"
常见问题

翻译后文档结构会保留吗?

是的。标题、列表、链接、强调格式以及行内代码在翻译过程中都会完整保留,并体现在导出的文件中。因此,翻译后的文件可以无缝接入与源文件相同的工作流。

重新运行未改动的文档需要再次付费吗?

不。在“仅更新”模式下,单次运行仅处理自上次运行以来源内容发生变化的区块。重新运行未改动的文档无需任何费用,而小幅修改也只需支付少量区块的费用。

仍有疑问?在应用内询问 Literess,或发送邮件至 [email protected]