API de Tarea de Traducción

Crear tarea de traducción

POST/v1/translation/create

Crear una nueva tarea de traducción para la traducción de documentos/archivos.

Dirección completa: https://shangyiai.com/api/v1/translation/create
Autenticación: Debe incluirse la API Key en el encabezado de solicitud Authorization
Content-Type: multipart/form-data
Formato incorrecto: { "error": "Invalid API key." }

Precauciones

La creación de una tarea entrará inmediatamente en la cola de espera y devolverá el taskId. Posteriormente se puede obtener el progreso, el coste y el enlace de descarga a través de la interfaz de consulta de tareas.

El saldo de créditos de la cuenta necesita al menos 2 credits para crear una tarea. Cuando preview es true solo se genera la vista previa y se pagan los créditos de vista previa.

El parámetro glossary coincide por nombre de glosario, puede repetirse con múltiples campos del mismo nombre para especificar varios glosarios.

Ejemplo

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'

Parámetros de Solicitud

Parámetros	Tipo	Predeterminado	Descripción	Ejemplo
*file	binary	-	Archivo que necesita ser traducido Tipos de archivo compatibles: consultar	bitcoin.pdf
*fromLang	String	-	Idioma de origen; el idioma de origen no puede ser el mismo que el idioma de destino Idiomas compatibles: consultar	English
*toLang	String	-	Idioma de destino, el idioma de destino no puede ser el mismo que el idioma original Idiomas compatibles: consultar	Simplified Chinese
model	String	-	Modelo de IA para traducción Modelos compatibles: consultar	-
fileDescription	String	-	Descripción del documento: mejore la calidad de la traducción proporcionando información adicional, como añadir información de contexto adicional del documento y otros requisitos de traducción, etc.	-
glossary	String	-	Nombre del glosario de términos utilizado para la traducción	-
preview	Boolean	false	Si generar únicamente vista previa. Al generar únicamente vista previa, pague 2 créditos para generar la vista previa de la traducción del documento	-
shouldTranslateImage	Boolean	false	Si se traducen las imágenes del documento Solo es compatible con PDF / DOCX / PPTX / EPUB / ODS / ODT / ODF	-
forceOCR	Boolean	false	Forzar el uso de OCR para reconocer el contenido del documento. Al activarlo se habilitará también la traducción de imágenes.	-
shouldTranslateFileName	Boolean	true	¿Traducir nombres de archivo?	-
strictSourceLanguageCheck	Boolean	false	¿Traducir solo el texto identificado como idioma de origen?Una vez activado, filtrará más estrictamente el contenido que no sea del idioma de origen, y el cálculo de costes también utilizará un coeficiente más estricto.	-
outputFormat	String	-	Formato de salida. Cuando se pasa MD se intentará generar una traducción en Markdown.	MD
bilingualMode	String	Horizontal	Dirección de maquetación del archivo bilingüe. Horizontal significa comparación izquierda-derecha, Vertical significa comparación arriba-abajo.	Horizontal
password	String	-	Contraseña de apertura del archivo PDF	-
ignoreComments	Boolean	false	¿Omitir comentarios de DOCX, PPTX y XLSX?	-
ignoreNotes	Boolean	false	¿Omitir notas de PPTX?	-
ignoreHeadersAndFooters	Boolean	false	¿Omitir encabezados y pies de página de DOCX?	-
ignoreHidden	Boolean	false	¿Omitir diapositivas ocultas de PPTX?	-
ignoreMasters	Boolean	false	¿Omitir texto de patrón principal de PPTX?	-
ignoreSheetNames	Boolean	false	Si no traducir los nombres de las hojas de XLSX	-
extractTextRegExpPattern	String	-	Solo traduce el contenido que coincida con la expresión regular y lo sustituye por la traducción Solo es compatible con txmsg	-
extractTextRegExpFlags	String	-	Flags de expresiones regulares: g, s, m, u, y Solo compatible con txmsg	-
allowFlip	Boolean	true	Si se permite voltear el diseño de la página para idiomas de derecha a izquierda. Al establecer false, también se desactivará el volteo de imágenes.	-
allowFlipImage	Boolean	true	Si se permite voltear el contenido de las imágenes para idiomas de derecha a izquierda.	-
webhookUrl	String	-	URL de callback para actualizaciones de estado, el contenido del callback incluye: {taskId, progress, status}	-

Respuesta

Parámetros	Tipo	Predeterminado	Descripción	Ejemplo
taskId	String	-	ID de tarea	-

Errores comunes

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.