API Attività di Traduzione

Crea attività di traduzione

POST/v1/translation/create

Crea una nuova attività di traduzione per documenti/file.

Indirizzo completo: https://shangyiai.com/api/v1/translation/create
Autenticazione: È necessario passare la API Key nell'intestazione della richiesta Authorization
Content-Type: multipart/form-data
Formato errato: { "error": "Invalid API key." }

Note importanti

Creare un task entra immediatamente nella coda di attesa e restituisce il taskId. Successivamente è possibile ottenere il progresso, il costo e il link di download tramite l'interfaccia di query del task.

Il saldo crediti dell'account richiede almeno 2 credits per creare un'attività. Quando preview è true viene generata solo l'anteprima e vengono pagati i crediti per l'anteprima.

Il parametro glossary corrisponde per nome del glossario e può essere inserito più volte con campi dello stesso nome per specificare più glossari.

Esempio

curl

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'

Parametri della Richiesta

Parametri	Tipo	Predefinito	Descrizione	Esempio
*file	binary	-	File da tradurre Tipi di file supportati: consulta	bitcoin.pdf
*fromLang	String	-	Lingua di origine, la lingua di origine non può essere identica alla lingua di destinazione Lingue supportate: consulta	English
*toLang	String	-	Lingua di destinazione, la lingua di destinazione non può essere identica alla lingua di origine Lingue supportate: consulta	Simplified Chinese
model	String	-	Modello AI per la traduzione Modelli supportati: consulta	-
fileDescription	String	-	Descrizione documento: migliora la qualità della traduzione fornendo informazioni aggiuntive, come l'inserimento di ulteriori informazioni di contesto del documento e altri requisiti di traduzione, ecc.	-
glossary	String	-	Nome del glossario utilizzato per la traduzione	-
preview	Boolean	false	Generare solo anteprima. Nella modalità solo anteprima, pagare 2 credits per generare l'anteprima della traduzione del documento	-
shouldTranslateImage	Boolean	false	Indica se tradurre le immagini contenute nel documento Supporta esclusivamente PDF / DOCX / PPTX / EPUB / ODS / ODT / ODF	-
forceOCR	Boolean	false	Forza l'uso dell'OCR per riconoscere il contenuto del documento. Se attivato, verrà abilitata anche la traduzione delle immagini.	-
shouldTranslateFileName	Boolean	true	Se tradurre il nome del file	-
strictSourceLanguageCheck	Boolean	false	Se tradurre solo il testo riconosciuto come lingua originale. Una volta attivato, il contenuto non nella lingua di origine verrà filtrato in modo più rigoroso e anche il calcolo dei costi utilizzerà coefficienti più rigorosi.	-
outputFormat	String	-	Formato di output. Passando MD si tenterà di generare una traduzione Markdown.	MD
bilingualMode	String	Horizontal	Direzione di impaginazione del file bilingue. Horizontal indica il confronto sinistra-destra, Vertical indica il confronto alto-basso.	Horizontal
password	String	-	Password di apertura del file PDF	-
ignoreComments	Boolean	false	Ignorare i commenti nei file DOCX, PPTX e XLSX	-
ignoreNotes	Boolean	false	Ignorare le note dei file PPTX	-
ignoreHeadersAndFooters	Boolean	false	Ignorare intestazioni e piè di pagina nei file DOCX	-
ignoreHidden	Boolean	false	Ignorare le diapositive nascoste dei file PPTX	-
ignoreMasters	Boolean	false	Ignorare il testo master dei file PPTX	-
ignoreSheetNames	Boolean	false	Se non tradurre i nomi delle tabelle XLSX	-
extractTextRegExpPattern	String	-	Traduce esclusivamente il contenuto che corrisponde all'espressione regolare e lo sostituisce con la traduzione Supporta unicamente txmsg	-
extractTextRegExpFlags	String	-	Flag delle espressioni regolari: g, s, m, u, y Supporta solo txmsg	-
allowFlip	Boolean	true	Consente il capovolgimento del layout della pagina per le lingue da destra a sinistra. Impostando false verrà disabilitato anche il capovolgimento delle immagini.	-
allowFlipImage	Boolean	true	Consente il capovolgimento del contenuto delle immagini per le lingue da destra a sinistra.	-
webhookUrl	String	-	URL di callback per gli aggiornamenti di stato, il contenuto del callback comprende: {taskId, progress, status}	-

Risposta

Parametri	Tipo	Predefinito	Descrizione	Esempio
taskId	String	-	ID attività	-

Errori comuni

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.