API за преводна задача
Създаване на задача за превод
Създайте нова задача за превод на документ/файл.
- Пълен адрес
- https://otranslator.com/api/v1/translation/create
- Удостоверяване
- Необходимо е API Key да се предаде в заглавката Authorization на заявката
- Content-Type
- multipart/form-data
- Грешен формат
- { "error": "Invalid API key." }
Забележки
Създаването на задача незабавно влиза в чакащата опашка и връща taskId. Впоследствие можете да получите прогреса, разходите и връзката за изтегляне чрез интерфейса за запитване на задачата.
Балансът на точки в акаунта трябва да е поне 2 credits, за да се създаде задача. Когато preview е true, се генерира само преглед и се заплащат точки за преглед.
Параметърът glossary се съпоставя по име на терминологичен речник и може многократно да се предават множество полета със същото име, за да се определят няколко терминологични речника.
Пример
1curl -X POST 'https://otranslator.com/api/v1/translation/create' \
2--header 'Authorization: [yourSecretKey]' \
3--form 'file=@bitcoin.pdf' \
4--form 'fromLang=English' \
5--form 'toLang=Simplified Chinese' \
6--form 'outputFormat=MD' \
7--form 'bilingualMode=Horizontal' Параметри на заявката
| Параметри | Тип | По подразбиране | Описание | Пример |
|---|---|---|---|---|
| *file | binary | - |
| bitcoin.pdf |
| *fromLang | String | - |
| English |
| *toLang | String | - |
| Simplified Chinese |
| model | String | - |
| - |
| fileDescription | String | - | Описание на документа - чрез предоставяне на допълнителна информация се подобрява качеството на превода, например добавяне на контекстова информация за документа и други изисквания за превод | - |
| glossary | String | - | Име на терминологичния речник, използван при превода | - |
| preview | Boolean | false | Дали да се генерира само визуализация. При генериране само на визуализация се заплащат 2 credits за генериране на визуализация на превода на документа | - |
| shouldTranslateImage | Boolean | false |
| - |
| forceOCR | Boolean | false | Дали да се използва принудително OCR за разпознаване на съдържанието на документа. При активиране ще се включи също и превод на изображения. | - |
| shouldTranslateFileName | Boolean | true | Дали да се превежда името на файла | - |
| strictSourceLanguageCheck | Boolean | false | Да се превежда ли само текст, разпознат като на изходния език. При включване ще се филтрира по-строго съдържание, което не е на изходния език, а изчисляването на разходите също ще използва по-строг коефициент. | - |
| outputFormat | String | - | Изходен формат. При подаване на MD ще се опита да генерира Markdown превод. | MD |
| bilingualMode | String | Horizontal | Посока на оформление на двуезичния файл. Horizontal означава съпоставяне ляво-дясно, Vertical означава съпоставяне отгоре-отдолу. | Horizontal |
| password | String | - | Парола за отваряне на PDF файла | - |
| ignoreComments | Boolean | false | Дали да се игнорират коментарите в DOCX, PPTX и XLSX | - |
| ignoreNotes | Boolean | false | Дали да се игнорират бележките в PPTX | - |
| ignoreHeadersAndFooters | Boolean | false | Дали да се игнорират горните и долните колонтитули в DOCX | - |
| ignoreHidden | Boolean | false | Дали да се игнорират скритите страници в PPTX | - |
| ignoreMasters | Boolean | false | Дали да се игнорира текстът на шаблона в PPTX | - |
| ignoreSheetNames | Boolean | false | Дали да не се превеждат имената на листовете в XLSX файлове | - |
| extractTextRegExpPattern | String | - |
| - |
| extractTextRegExpFlags | String | - |
| - |
| allowFlip | Boolean | true | Дали да се позволява обръщане на оформлението на страница за езици отдясно наляво. При подаване на false ще се изключи и обръщането на изображенията. | - |
| allowFlipImage | Boolean | true | Дали да се позволява обръщане на съдържанието на изображения за езици отдясно наляво. | - |
| webhookUrl | String | - | URL за обратна връзка при актуализация на статуса, съдържанието на обратната връзка включва: {taskId, progress, status} | - |
Отговор
| Параметри | Тип | По подразбиране | Описание | Пример |
|---|---|---|---|---|
| taskId | String | - | ID на задачата | - |
Чести грешки
401 Missing API key.
The Authorization request header is required.
401 Invalid API key.
The API key does not exist, has been deleted, or is no longer valid.
402 Insufficient credits balance.
The account does not have enough credits to create the task.
400 Missing required parameter: fromLang.
Provide fromLang using a language returned by /api/v1/languages.
400 Missing required parameter: toLang.
Provide toLang using a language returned by /api/v1/languages.
400 Invalid fromLang: [language]. Use a language returned by /api/v1/languages.
The provided source language is not supported.
400 Invalid toLang: [language]. Use a language returned by /api/v1/languages.
The provided target language is not supported.
400 Missing required file upload: file.
Upload the source document in the file form field.
404 Glossary "[name]" not found.
The specified glossary does not exist or does not belong to the current API account.