API de Tarea de Traducción
Consultar tarea de traducción
Consultar el estado y los detalles de una tarea de traducción.
- Dirección completa
- https://shangyiai.com/api/v1/translation/query
- Autenticación
- Debe incluirse la API Key en el encabezado de solicitud Authorization
- Content-Type
- application/json
- Formato incorrecto
- { "error": "Invalid API key." }
Precauciones
Se recomienda consultar esta interfaz cuando el estado de la tarea sea Waiting o Processing, y detener la consulta cuando el estado entre en Completed, Terminated o Cancelled.
El enlace de descarga es una dirección de acceso temporal, guarde el archivo según sea necesario del lado del negocio o vuelva a consultar para obtenerlo.
Ejemplo
1curl -X POST 'https://shangyiai.com/api/v1/translation/query' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5 "taskId": "[string]"
6}'Parámetros de Solicitud
| Parámetros | Tipo | Predeterminado | Descripción | Ejemplo |
|---|---|---|---|---|
| *taskId | String | - | ID de tarea de traducción | - |
Respuesta
| Parámetros | Tipo | Predeterminado | Descripción | Ejemplo |
|---|---|---|---|---|
| taskId | String | - | ID de tarea | - |
| model | String | - | Modelo utilizado para la traducción | - |
| fromLang | String | - | Idioma de origen | - |
| toLang | String | - | Idioma de destino | - |
| status | String | - | Estado: 'Inicializar' | 'En espera' | 'Procesando' | 'Completado' | 'Terminado' | 'Cancelado' | - |
| progress | Number | - | Progreso, 0~100 | - |
| errorMsg | String | - | Mensaje de error | - |
| fileTitle | String | - | Nombre del archivo original | - |
| fileUrl | String | - | Dirección de descarga del archivo original | - |
| translatedFileUrl | String | - | Dirección de descarga de la traducción | - |
| translatedBilingualFileUrl | String | - |
| - |
| translatedEditableFileUrl | String | - | Dirección de descarga del archivo de traducción editable. Solo se devuelve cuando se genera un resultado editable para el tipo de archivo correspondiente. | - |
| tokenCount | Integer | - |
| - |
| wordNums | Integer | - | Recuento de palabras del documento. Puede estar vacío según el tipo de archivo. | - |
| price | Integer | - | Número total de créditos necesarios para la traducción | - |
| usedCredits | Integer | - | Número de Credits utilizados por la tarea de traducción | - |
| glossary | String[] | - | Nombre del glosario de términos utilizado por la tarea de traducción | - |
| shouldTranslateImage | Boolean | - | ¿Traducir las imágenes del documento? | - |
| forceOCR | Boolean | - | Forzar el uso de OCR para reconocer el contenido del documento | - |
| createdAt | DateTime | - | Fecha de creación de la tarea de traducción | - |
| updatedAt | DateTime | - | Fecha de actualización de la tarea de traducción | - |
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.
400 Missing required parameter: taskId.
Provide the taskId returned by the create translation task API.
404 Task not found.
The task does not exist, has been deleted, does not belong to the current API account, or was not created through the API.