Envoyer une demande de traitement

Après avoir configuré votre compteGoogle Cloud et créé un processeur, vous pouvez envoyer une requête à votre processeur Document AI.

Le code utilisé pour envoyer la requête est le même pour tous les processeurs. Vous constaterez des différences dans le fonctionnement des processeurs en fonction des informations qu'ils génèrent.

En utilisant la version v1 de l'API Document AI ou la console Google Cloud , vous pouvez envoyer des requêtes de traitement à cette version spécifique du processeur. Si vous ne spécifiez pas de version de processeur, la version par défaut est utilisée. Pour en savoir plus, consultez Gérer les versions de l'outil de traitement.

Traitement en ligne

Les requêtes en ligne (synchrones) vous permettent d'envoyer un seul document à traiter. Document AI traite immédiatement la requête et renvoie un document.

Envoyer une demande à un sous-traitant

Les exemples de code suivants montrent comment envoyer une requête à un processeur.

REST

Cet exemple vous montre comment fournir le contenu d'un document (contenu brut du document en octets via une chaîne encodée en base64) dans l'objet rawDocument.

Vous pouvez également spécifier inlineDocument, qui correspond au même format JSON Document renvoyé par Document AI. Cela vous permet d'enchaîner les requêtes en transmettant le même format dans les deux sens (par exemple, si vous classifiez un document, puis que vous en extrayez le contenu).

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • LOCATION : emplacement de votre processeur, par exemple :
    • us : États-Unis
    • eu : Union européenne
  • PROJECT_ID : ID de votre projet Google Cloud .
  • PROCESSOR_ID : ID de votre processeur personnalisé.
  • skipHumanReview : booléen permettant de désactiver l'examen manuel (compatible uniquement avec les processeurs Human-in-the-Loop).
    • true : l'examen manuel est ignoré.
    • false : active l'examen manuel (valeur par défaut)
  • MIME_TYPE† : l'une des options de type MIME valides.
  • IMAGE_CONTENT† : contenu de document intégré valide, représenté sous forme de flux d'octets. Pour les représentations JSON, l'encodage en base64 (chaîne ASCII) de vos données d'image binaires. Cette chaîne doit ressembler à la chaîne suivante :
    • /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==
    Pour en savoir plus, consultez la section Encodage Base64.
  • FIELD_MASK : spécifie les champs à inclure dans le résultat Document. Il s'agit d'une liste de noms de champs complets séparés par une virgule au format FieldMask.
    • Exemple : text,entities,pages.pageNumber
  • INDIVIDUAL_PAGES : liste des pages individuelles à traiter.
    • Vous pouvez également fournir les champs fromStart ou fromEnd pour traiter un nombre spécifique de pages au début ou à la fin du document.

† Ce contenu peut également être spécifié à l'aide de contenu encodé en base64 dans l'objet inlineDocument.

Méthode HTTP et URL : 

POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process

Corps JSON de la requête : 

{
  "skipHumanReview": skipHumanReview,
  "rawDocument": {
    "mimeType": "MIME_TYPE",
    "content": "IMAGE_CONTENT"
  },
  "fieldMask": "FIELD_MASK",
  "processOptions": {
    "individualPageSelector" {
      "pages": [INDIVIDUAL_PAGES]
    }
  }
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process" | Select-Object -Expand Content

Si la requête aboutit, le serveur renvoie un code d'état HTTP 200 OK et la réponse au format JSON. Le corps de la réponse contient une instance de Document.

Envoyer une requête à une version du processeur

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

  • LOCATION : emplacement de votre processeur, par exemple :
    • us : États-Unis
    • eu : Union européenne
  • PROJECT_ID : ID de votre projet Google Cloud .
  • PROCESSOR_ID : ID de votre processeur personnalisé.
  • PROCESSOR_VERSION : identifiant de la version du processeur. Pour en savoir plus, consultez Sélectionner une version de l'outil de traitement. Par exemple :
      .
    • pretrained-TYPE-vX.X-YYYY-MM-DD
    • stable
    • rc
  • skipHumanReview : booléen permettant de désactiver l'examen manuel (compatible uniquement avec les processeurs Human-in-the-Loop).
    • true : l'examen manuel est ignoré.
    • false : active l'examen manuel (valeur par défaut)
  • MIME_TYPE† : l'une des options de type MIME valides.
  • IMAGE_CONTENT† : contenu de document intégré valide, représenté sous forme de flux d'octets. Pour les représentations JSON, l'encodage en base64 (chaîne ASCII) de vos données d'image binaires. Cette chaîne doit ressembler à la chaîne suivante :
    • /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==
    Pour en savoir plus, consultez la section Encodage Base64.
  • FIELD_MASK : spécifie les champs à inclure dans le résultat Document. Il s'agit d'une liste de noms de champs complets séparés par une virgule au format FieldMask.
    • Exemple : text,entities,pages.pageNumber

† Ce contenu peut également être spécifié à l'aide de contenu encodé en base64 dans l'objet inlineDocument.

Méthode HTTP et URL : 

POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/PROCESSOR_VERSION:process

Corps JSON de la requête : 

{
  "skipHumanReview": skipHumanReview,
  "rawDocument": {
    "mimeType": "MIME_TYPE",
    "content": "IMAGE_CONTENT"
  },
  "fieldMask": "FIELD_MASK"
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/PROCESSOR_VERSION:process"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/PROCESSOR_VERSION:process" | Select-Object -Expand Content

Si la requête aboutit, le serveur renvoie un code d'état HTTP 200 OK et la réponse au format JSON. Le corps de la réponse contient une instance de Document.

C#

Pour en savoir plus, consultez la documentation de référence de l'API Document AI C#.

Pour vous authentifier auprès de Document AI, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local. 


using Google.Cloud.DocumentAI.V1;
using Google.Protobuf;
using System;
using System.IO;

public class QuickstartSample
{
    public Document Quickstart(
        string