Translation Task API
Vertaaltaak aanmaken
Maak een nieuwe vertaaltaak aan voor document-/bestandsvertaling.
- Volledig adres
- https://shangyiai.com/api/v1/translation/create
- Authenticatie
- De API Key moet doorgegeven worden in de Authorization-verzoekheader
- Content-Type
- multipart/form-data
- Onjuist formaat
- { "error": "Invalid API key." }
Aandachtspunten
Het aanmaken van een taak wordt direct toegevoegd aan de wachtrij en retourneert een taskId. Vervolgens kunnen de voortgang, kosten en downloadlink via de taakinterface worden opgehaald.
Het creditsaldo van de account moet minimaal 2 credits bedragen om een taak te creëren. Wanneer preview op true staat, wordt alleen een voorvertoning gegenereerd en worden voorvertoningscredits betaald.
De glossary parameter komt overeen op basis van de naam van de woordenlijst en kan meerdere malen worden meegegeven met gelijknamige velden om meerdere woordenlijsten te specificeren.
Voorbeeld
1curl -X POST 'https://shangyiai.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' Verzoekparameters
| Parameters | Type | Standaard | Beschrijving | Voorbeeld |
|---|---|---|---|---|
| *file | binary | - |
| bitcoin.pdf |
| *fromLang | String | - |
| English |
| *toLang | String | - |
| Simplified Chinese |
| model | String | - |
| - |
| fileDescription | String | - | Documentbeschrijving: verbeter de vertaalkwaliteit door aanvullende informatie te verstrekken, zoals het toevoegen van extra documentachtergrond en andere vertaalvereisten | - |
| glossary | String | - | Naam van de terminologielijst gebruikt voor vertaling | - |
| preview | Boolean | false | Uitsluitend voorvertoning genereren. Bij uitsluitend voorvertoning genereren: betaal 2 credits om een voorvertoning van de documentvertaling te genereren | - |
| shouldTranslateImage | Boolean | false |
| - |
| forceOCR | Boolean | false | OCR geforceerd gebruiken voor herkenning van documentinhoud. Na inschakeling wordt afbeeldingenvertaling ook geactiveerd. | - |
| shouldTranslateFileName | Boolean | true | Of bestandsnamen vertaald moeten worden | - |
| strictSourceLanguageCheck | Boolean | false | Alleen tekst vertalen die als brontaal wordt herkend?Wanneer ingeschakeld wordt niet-brontaalinhoud strenger gefilterd en wordt er ook een strengere coëfficiënt gebruikt voor de kostenberekening. | - |
| outputFormat | String | - | Uitvoerformaat. Bij invoer van MD wordt er geprobeerd een Markdown-vertaling te genereren. | MD |
| bilingualMode | String | Horizontal | Lay-outrichting van tweetalig bestand. Horizontal betekent naast elkaar weergeven, Vertical betekent onder elkaar weergeven. | Horizontal |
| password | String | - | Wachtwoord voor het openen van PDF-bestanden | - |
| ignoreComments | Boolean | false | Of opmerkingen in DOCX, PPTX en XLSX genegeerd moeten worden | - |
| ignoreNotes | Boolean | false | Of notities van PPTX genegeerd moeten worden | - |
| ignoreHeadersAndFooters | Boolean | false | Of voetteksten en kopteksten van DOCX genegeerd moeten worden | - |
| ignoreHidden | Boolean | false | Of verborgen dia's van PPTX genegeerd moeten worden | - |
| ignoreMasters | Boolean | false | Of hoofdsjabloontekst van PPTX genegeerd moet worden | - |
| ignoreSheetNames | Boolean | false | Of XLSX-bladnamen niet vertaald moeten worden | - |
| extractTextRegExpPattern | String | - |
| - |
| extractTextRegExpFlags | String | - |
| - |
| allowFlip | Boolean | true | Of het omdraaien van pagina-indeling voor rechts-naar-links talen is toegestaan. Bij false wordt ook het omdraaien van afbeeldingen uitgeschakeld. | - |
| allowFlipImage | Boolean | true | Of het omdraaien van afbeeldingsinhoud voor rechts-naar-links talen is toegestaan. | - |
| webhookUrl | String | - | Callback-URL bij statusupdates, de callback-inhoud omvat: {taskId, progress, status} | - |
Reactie
| Parameters | Type | Standaard | Beschrijving | Voorbeeld |
|---|---|---|---|---|
| taskId | String | - | Taak-ID | - |
Veelvoorkomende fouten
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.