Crear una tarea de aprovisionamiento
Genera directrices para un motor nuevo o existente y guarda el ID de la tarea para seguir su progreso y recuperarla.
El aprovisionamiento se ejecuta en segundo plano y comienza cuando la API acepta la solicitud. Todas las rutas utilizan https://api.lingo.dev y autenticación de API.
Crear y completar un motor #
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY{
"engine": { "name": "Acme support", "description": "Customer support content" },
"kinds": {
"glossary": { "name": "Product terminology" },
"ruleset": { "name": "Support writing rules" },
"brandVoice": { "name": "Support voice" }
},
"sources": [
{ "_tag": "Link", "url": "https://example.com/style-guide" },
{ "_tag": "Content", "text": "Use clear, direct sentences. Keep the product name Acme unchanged." }
]
}Sustituye la URL de ejemplo por la de una página accesible que contenga tus directrices, o proporciona texto en su lugar.
| Campo | Contrato |
|---|---|
engine | Objeto obligatorio para crear el motor. name no puede estar vacío; description es opcional. También puede incluir configuraciones de modelos, cobertura y ajustes del flujo de procesamiento. |
kinds | Objeto obligatorio que selecciona al menos uno de estos elementos: glossary, ruleset o brandVoice. Cada valor seleccionado es {} o { "name": "Nonempty name" }. |
sources | Array obligatorio que no puede estar vacío, con un máximo de diez enlaces o fuentes de texto. |
Los ajustes del motor siguen el contrato de creación de motores. sourceCoverage y targetCoverage son arrays de idiomas, y [] abarca todos los idiomas. Si omites modelConfigs, se aplican las configuraciones predeterminadas de los modelos de la plataforma; con [], no queda ninguna configuración de modelo fijada. Configura los modelos del motor antes de usarlo para traducir.
Quien realiza la llamada necesita permiso para crear motores y para crear las directrices solicitadas. La solicitud puede rechazarse por el número de motores, las funciones del plan, el crédito de la cuenta o los límites de frecuencia del aprovisionamiento.
Completar un motor existente #
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/jsonPara completar solo los tipos para los que el motor aún no tiene ningún conjunto asociado:
{
"kinds": { "_tag": "Empty" },
"sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}Para solicitar nuevos conjuntos específicos:
{
"kinds": {
"_tag": "Requested",
"glossary": { "name": "Support terminology" },
"ruleset": {}
},
"sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}Requested puede añadir un glosario o un conjunto de reglas junto a los existentes. El aprovisionamiento nunca sustituye una voz de marca asociada. Empty omite los tipos que ya tienen un conjunto asociado, incluidos los conjuntos que se asocien mientras la tarea está en ejecución. Revisa los resultados de cada tipo en lugar de dar por hecho que cada solicitud crea los tres tipos.
Solo puede ejecutarse una tarea de aprovisionamiento a la vez en un motor. ProvisioningJobRunning (409) incluye el jobId existente; sigue su progreso antes de enviar más trabajo. NothingToProvision (409) significa que ninguna de las operaciones solicitadas puede completar el motor en su estado actual.
Guardar la respuesta #
Ambas rutas de creación devuelven HTTP 200 con una tarea de aprovisionamiento. Guarda id y engineId antes de iniciar las consultas periódicas. El estado inicial suele ser status: { "_tag": "Running" }.
La operación de creación no declara ninguna cabecera de idempotencia. Si se pierde una respuesta, comprueba las tareas en ejecución y la lista de motores antes de repetir una solicitud de creación de un nuevo motor, ya que podría crear otro. Recuperación explica estas comprobaciones y cómo reintentar los tipos que han fallado.