Переглянути довідковий центр

Локалізація markdown-документа через API

Підтримує Vitalii VlasiukCo-founder

Markdown — це формат, у якому зазвичай створюються документи, довідкові статті та контент у CMS. Надсилайте його до API «як є», запускайте робочий процес для перекладу на потрібні мови та отримуйте такий самий markdown для кожної з них зі збереженою структурою.

На цій сторінці

Як надіслати markdown?

POST /documents із параметром content_type: "markdown" та переліком цільових мов. Transept розділяє документ на блоки та створює окрему мовну версію для кожної з них.

Потім виконайте оцінку та запуск, як описано в розділі Автоматизація Transept через API; запуск охоплює всі мовні версії за один виклик.

# 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 для поблокового зчитування, docx, pdf, xliff, csv) наведені в таблиці форматів у розділі Автоматизація Transept через API.

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

Як перекласти лише те, що змінилося?

Якщо згодом вихідний текст зміниться, замість повторного імпорту скористайтеся синхронізацією: POST /documents/{id}/resync-source зберігає незмінені блоки (разом із перекладами) та позначає змінені або додані блоки як застарілі, а запуск у режимі «лише оновлення» опрацьовує тільки їх. Це текстовий аналог методу «дельти за ключами» з розділу Локалізація каталогу рядків через API; загальний принцип роботи описано в статті Запуск лише для зміненого контенту.

# 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].