Analyser un ou plusieurs fichiers

Introduction

Dans ce guide, nous allons voir comment analyser un ou plusieurs fichiers 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 les fichiers se trouvent dans le répertoire courant sous le nom main_file.pdf, attachment_1.txt et attachment_2.png, 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":"file_1"},{"type":"ATTACHMENT","contentType":"file","file_key":"attachment_1"},{"type":"ATTACHMENT","contentType":"file","file_key":"attachment_2"}],"manualFinalStatusUpdate":false,"metadata":{}}' \
      --form 'file_1=@./main_file.pdf' \
      --form 'attachment_1=@./attachment_1.txt' \
      --form 'attachment_2=@./attachment_2.png'

Explication de la commande curl

Vous devez téléverser un corps multipart/form-data, avec un champ payload décrivant ce que vous voulez envoyer à Golem.ai. Il y a aussi des champs pour chaque fichier à téléverser, leurs noms sont spécifiés dans le tableau inputs du champ payload.

Le tableau des inputs décrit les entrées de l'analyse. Ici, nous avons un fichier principal et deux pièces jointes :

[
  {
    "type": "BODY", // le type de l'entrée, doit être "BODY" pour le fichier principal
    "contentType": "file",
    "file_key": "file_1" // le nom du champ dans le corps `multipart/form-data` où se trouve le fichier
  },
  {
    "type": "ATTACHMENT", // le type de l'entrée, doit être "ATTACHMENT" pour une pièce jointe
    "contentType": "file",
    "file_key": "attachment_1"
  },
  {
    "type": "ATTACHMENT", // le type de l'entrée, doit être "ATTACHMENT" pour une pièce jointe
    "contentType": "file",
    "file_key": "attachment_2"
  }
]

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. Étant donné qu'il n'y a pas de nom de fichier principal, nous vous conseillons fortement de nommer vos analyses.