Aller au contenu principal

Payload de résultat d'une analyse

info

Golem.ai devient Miralia.ai !​

L'API est désormais disponible sur le domaine api.console.miralia.ai au lieu de api.console.golem.ai, mais vous pouvez continuer à utiliser le domaine api.console.golem.ai pour les requêtes API.

Le décomissionnement de l'URL historique api.console.golem.ai est planifié pour Décembre 2026.

Introduction​

Quand une analyse est terminée, Miralia.ai vous envoie un payload JSON :

Ce guide décrit tous les champs que ce payload peut contenir. La présence des champs optionnels dépend de la configuration de votre environnement (réglée avec les équipes Miralia.ai). Si un champ documenté ici est absent de votre payload, il est généralement désactivé dans la configuration de sortie (Output).

La référence OpenAPI complète est disponible ici : result.

Exemple complet​

Exemple d'une analyse terminée avec la plupart des champs activés. Chez vous, certains champs optionnels peuvent être absents selon la configuration de l'environnement.

Réponse HTTP (GET /analyses/{analysisId}/result)​

{
  "status": "FINISHED",
  "result": {
    "analysisId": "25e625ab-7d91-1234-8a4b-09f52c07ecb9",
    "filename": "mail-0123456.eml",
    "feedbackURL": "https://api.console.miralia.ai/analyses/25e625ab-7d91-1234-8a4b-09f52c07ecb9/feedback",
    "rpaActions": {
      "InboxCareConsolidation": ["CloseTicket", "AssignAgent"]
    },
    "metadata": {
      "inbox": "support@example.com",
      "ticket_id": "123456"
    },
    "categories": ["Convocation"],
    "attachmentsCategories": {
      "file.txt": ["Autre"],
      "facture.pdf": ["Facture"]
    },
    "extractedData": {
      "message": {
        "date_rdv": { "jour": "24", "mois": "05", "annee": "2025" },
        "heure_rdv": { "heure": "15", "minute": "00" },
        "reference": "6754679"
      },
      "attachments": {
        "facture.pdf": { "amount": "120.00" }
      }
    },
    "messageHeader": {
      "From": "patient@example.com",
      "To": "support@example.com",
      "Subject": "Confirmation de rendez-vous",
      "Date": "Mon, 20 Jul 2026 10:00:00 +0000"
    },
    "messageHTMLBodies": [
      "<!DOCTYPE html><html><body><p>Bonjour, je confirme mon rendez-vous.</p></body></html>"
    ],
    "attachments": [
      {
        "name": "facture.pdf",
        "data": "JVBERi0xLjQKJc..."
      }
    ],
    "replyTemplate": "Bonjour,\n\nNous confirmons votre rendez-vous du 24/05/2025 à 15h00.\n\nCordialement",
    "visionEngine": [
      {
        "status": "Success",
        "documentName": "facture.pdf",
        "results": {
          "documentType": "invoice",
          "currency": "EUR"
        }
      }
    ]
  }
}

Corps du webhook​

Le webhook envoie directement l'objet contenu dans result (sans l'enveloppe status) :

{
  "analysisId": "25e625ab-7d91-1234-8a4b-09f52c07ecb9",
  "filename": "mail-0123456.eml",
  "feedbackURL": "https://api.console.miralia.ai/analyses/25e625ab-7d91-1234-8a4b-09f52c07ecb9/feedback",
  "rpaActions": {
    "InboxCareConsolidation": ["CloseTicket", "AssignAgent"]
  },
  "metadata": {
    "inbox": "support@example.com",
    "ticket_id": "123456"
  },
  "categories": ["Convocation"],
  "attachmentsCategories": {
    "file.txt": ["Autre"],
    "facture.pdf": ["Facture"]
  },
  "extractedData": {
    "message": {
      "date_rdv": { "jour": "24", "mois": "05", "annee": "2025" },
      "heure_rdv": { "heure": "15", "minute": "00" },
      "reference": "6754679"
    },
    "attachments": {
      "facture.pdf": { "amount": "120.00" }
    }
  }
}

Champs toujours présents​

ChampTypeDescription
analysisIdstring (UUID)Identifiant de l'analyse
feedbackURLstring (URI)URL pour envoyer un feedback / une correction sur cette analyse
rpaActionsobjectActions RPA déclenchées, groupées par moteur. Peut être {}

rpaActions​

{
  "MonMoteurConsolidation": ["CloseTicket", "AssignAgent"]
}

Forme : { "<nomDuMoteur>": ["<nomAction>", ...] }.

Champs optionnels​

filename​

Nom du fichier / email principal analysé.

"filename": "mail-0123456.eml"

metadata​

Métadonnées associées à l'analyse (celles envoyées à la création, éventuellement enrichies). Objet plat : clés → scalaires (string, number, boolean, ou null). Pas d'objets / tableaux imbriqués.

"metadata": {
  "inbox": "support@example.com",
  "ticket_id": "123456"
}

categories​

Catégories détectées sur le corps du message. Souvent vide ou un seul élément.

"categories": ["Convocation"]

attachmentsCategories​

Catégories par nom de pièce jointe.

"attachmentsCategories": {
  "file.txt": ["Autre"],
  "image.jpg": ["Facture"]
}

extractedData​

Données structurées extraites. Les clés exactes dépendent de votre configuration d'extraction. Forme courante :

"extractedData": {
  "message": {
    "reference": "6754679",
    "date_rdv": { "jour": "24", "mois": "05", "annee": "2025" }
  },
  "attachments": {
    "invoice.pdf": { "amount": "120.00" }
  }
}

messageHTMLBodies​

Corps HTML du message (si activé).

"messageHTMLBodies": ["<!DOCTYPE html><html>...</html>"]

messageHeader​

En-têtes email (si activés). Clés fréquentes : From, To, Cc, Bcc, Subject, Date (RFC 2822), Message-ID, In-Reply-To. D'autres en-têtes source peuvent apparaître.

"messageHeader": {
  "From": "sender@example.com",
  "To": "recipient@example.com",
  "Subject": "Confirmation de rendez-vous",
  "Date": "Mon, 20 Jul 2026 10:00:00 +0000"
}

attachments​

Pièces jointes (si activé). Dans les webhooks, chaque entrée contient généralement name et data (contenu en base64).

"attachments": [
  {
    "name": "invoice.pdf",
    "data": "JVBERi0xLjQKJc..."
  }
]

replyTemplate​

Brouillon de réponse généré (si la génération de réponse est activée).

"replyTemplate": "Bonjour,\n\nNous confirmons votre rendez-vous..."

visionEngine​

Résultats d'analyse d'images / documents, par fichier (si activé).

"visionEngine": [
  {
    "status": "Success",
    "documentName": "scan.jpg",
    "results": { "documentType": "id_card" }
  }
]

Valeurs possibles de status : Error, Processing, Timeout, Success, Anonymized.

Sortie NLU​

Si la sortie NLU est activée, le payload contient l'un des deux formats suivants (jamais les deux).

Format actuel (results)​

"results": {
  "...": "structure dépendante de votre configuration NLU"
}

Format historique (interactions / labels / usedLanguage)​

{
  "interactions": [
    {
      "idInteraction": "...",
      "idContext": "...",
      "parameters": [{ "name": "reference", "value": "6754679" }],
      "parametersDetail": {},
      "incomplete": false,
      "postProcessors": {}
    }
  ],
  "labels": [
    {
      "type": "...",
      "expression": "...",
      "archetype": "...",
      "used_parameter": "...",
      "interaction_id": "...",
      "call_idx": 0
    }
  ],
  "usedLanguage": "fr"
}

Envoyer un feedback​

Utilisez feedbackURL pour corriger le résultat. Le corps attendu reprend la même forme que le payload de résultat (champs corrigés). Voir Send feedback on an analysis.