Aller au contenu principal

Créer une analyse avec un fichier EML

Introduction​

Dans ce guide, nous allons voir comment analyser un fichier EML avec l'API v2 de Golem.ai.

Vous devez avoir votre clé d'accès API et votre environment ID. Dans le reste de ce guide, nous allons les représenter de la manière suivante :

  • <YOUR-SECRET-KEY> pour la clé d'accès API
  • <YOUR-APP-ID> pour l'app ID
  • <YOUR-ENVIRONMENT-ID> pour l'environment ID

Référez vous aux prérequis pour plus de détails.

Example d'appel API par curl​

En considérant que le fichier EML se trouve dans le répertoire courant sous le nom my_file.eml, voici la commande curl correspondante :

curl --request POST \
      --url https://api.console.golem.ai/environment/<YOUR-ENVIRONMENT-ID>/analyses?appId=<YOUR-APP-ID> \
      --header 'accept: application/json' \
      --header 'authorization: <YOUR-SECRET-KEY>' \
      --header 'content-type: multipart/form-data' \
      --form 'payload={"inputs":[{"type":"BODY","contentType":"file","file_key": "file1"}],"metadata":{}}' \
      --form 'file1=@./my_file.eml'

Explication de la commande curl​

Vous devez téléverser un corps multipart/form-data, avec un champ appelé par exemple file1 et contenant le fichier que vous voulez téléverser.

Vous devez également fournir un champ payload dans votre corps multipart/form-data. Ce champ est un objet JSON (mais encodé en texte et défini comme un champ dans le corps de la requête).

À l'intérieur, vous pouvez définir certaines options, comme metadata ou name (expliquées plus en détail ci-dessous), mais c'est aussi là que vous décrivez les fichiers que vous téléchargez.

Pour décrire les entrées, vous devez créer un tableau appelé inputs, où chaque entrée décrit une entrée. Ici, il n'y en a qu'une seule, votre fichier EML.

// l'objet payload
{
  "inputs": [
    {
      "type": "BODY", // le type de l'entrée, doit être "BODY"
      "contentType": "file", // le type de contenu de l'entrée, doit être "file"
      "file_key": "file1" // le nom du champ dans le corps `multipart/form-data` où se trouve le fichier
    }
  ]
}

Vous pouvez aussi intégrer des métadonnées, comme metadata ou name, vous pouvez les trouver dans la section "Les options de la requête" du guide de démarrage.

La métadonnée la plus importante est le champ inbox, qui permet d'afficher des tableaux de bord et des statistiques basés sur la boîte de réception, et d'autres fonctionnalités.