Traduire

Aperçu

Le message Traduire convertit le contenu dans les langues spécifiées tout en préservant le formatage original. Le formatage Markdown est recommandé pour des résultats optimaux.

Référence API

Point de Terminaison

• URL WebSocket : wss://ws-{{tenant}}.oco.optave.{{tld}}
• Point de Terminaison REST (POST) : https://{{tenant}}.oco.optave.{{tld}}/message/translate

Pour pouvoir envoyer des messages, il est nécessaire de s'authentifier d'abord.

Charge Utile de Requête

Le message translate requiert un payload contenant l'historique de conversation (conversations), connections.threadId, et context.organizationId (l'identifiant d'organisation spécifique à votre client). Le texte à traduire est implicite dans les messages fournis. Les autres champs sont optionnels.

REST

{
  session: {
    sessionId: "a1b2c3d4-e5f6-7890-abcd-123456789012",
    channel: { language: "en-US" },
    interface: { type: "chat" }
  },
  request: {
    requestId: "a1b2c3d4-e5f6-7890-1234-56789ab2345",
    attributes: {
      variant: "A"
    },
    connections: {
      threadId: "9e8d7c6b-5a49-3827-1605-948372615abc" // REQUIS
    },
    context: { // généré par optave
      organizationId: "f7e8d9c0-b1a2-3456-7890-123456789abc" // REQUIS
    },
    scope: {
      conversations: [ // REQUIS
        {
          conversationId: "",
          participants: [
            {
              participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
              role: "user",
              displayName: "John Doe"
            },
            {
              participantId: "5b8c9d0e-2f4a-6b1c-9d8e-123456789abc",
              role: "operator",
              displayName: "Sarah Smith"
            }
          ],
          messages: [
            {
              content: "Hola, ¿me puede ayudar con mi consulta?",
              participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
              timestamp: "2024-01-15T10:30:00.000Z"
            },
            {
              content: "¡Por supuesto! Estaré encantada de ayudarle con su consulta.",
              participantId: "5b8c9d0e-2f4a-6b1c-9d8e-123456789abc",
              timestamp: "2024-01-15T10:30:15.000Z"
            }
          ],
          metadata: {}
        }
      ]
    }
  }
}

WebSocket

{
  headers: {
    correlationId: "20e35101-61e8-46e0-926d-6af84b378d95",
    tenantId: "6e3j5hdgemmjmoqih5u9b4mmqhrr",
    traceId: "405101-61e8-46e0-926d-6af84b378d95",
    idempotencyKey: "30e35101-61e8-46e0-926d-6af84b378d95",
    identifier: "message",
    action: "translate",
    schemaRef: "optave.message.v3",
    sdkVersion: "3.2.1",
    timestamp: "2025-09-05T16:30:00.000Z"
  },
  payload: {
    session: {
      sessionId: "a1b2c3d4-e5f6-7890-abcd-123456789012",
      channel: { language: "en-US" },
      interface: { type: "chat" }
    },
    request: {
      requestId: "a1b2c3d4-e5f6-7890-1234-56789ab2345",
      attributes: {
        variant: "A"
      },
      connections: {
        threadId: "9e8d7c6b-5a49-3827-1605-948372615abc" // REQUIS
      },
      context: { // généré par optave
        organizationId: "f7e8d9c0-b1a2-3456-7890-123456789abc" // REQUIS
      },
      scope: {
        conversations: [ // REQUIS
          {
            conversationId: "",
            participants: [
              {
                participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
                role: "user",
                displayName: "John Doe"
              },
              {
                participantId: "5b8c9d0e-2f4a-6b1c-9d8e-123456789abc",
                role: "operator",
                displayName: "Sarah Smith"
              }
            ],
            messages: [
              {
                content: "Hola, ¿me puede ayudar con mi consulta?",
                participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
                timestamp: "2024-01-15T10:30:00.000Z"
              },
              {
                content: "¡Por supuesto! Estaré encantada de ayudarle con su consulta.",
                participantId: "5b8c9d0e-2f4a-6b1c-9d8e-123456789abc",
                timestamp: "2024-01-15T10:30:15.000Z"
              }
            ],
            metadata: {}
          }
        ]
      }
    }
  },
  action: "message"
}

Réponses

🟢 Succès (200-201)

La réponse consiste en un superpouvoir translate.

{
  action: "superpower",
  actionType: "translate",
  state: "completed",
  message: {
    results: [
      {
        response: [
          {
            content: "¡Bienvenido a nuestro servicio! ¿Cómo puedo ayudarte hoy?"
          }
        ]
      }
    ]
  }
}

La réponse inclut le contenu traduit tout en maintenant le formatage présent dans le texte original.

🔴 Erreur

Les messages d'erreur sont similaires en format aux messages de succès, mais contiennent un état d'erreur et un objet JSON "response" :

{
  action: "superpower",
  actionType: "<superpower-name>",
  state: "error",
  message: {
    results: [
      {
        response: [
          {
            content: 'Error while fetching results'
          }
        ]
      }
    ]
  }
}