Encodage Base64

Lorsque vous envoyez des fichiers de document à l'API Document AI, vous pouvez envoyer des données directement dans le champ RawDocument.content avec le traitement en ligne uniquement si votre fichier est inférieur ou égal à 20 Mo. Le fichier d'entrée sera au format binaire et devra être encodé avant d'être envoyé à Document AI.

Si votre fichier d'entrée dépasse les limites de traitement en ligne, il doit être stocké dans un bucket Cloud Storage pour être envoyé au traitement, qui ne nécessite pas d'encodage. Pour en savoir plus, consultez la documentation sur le traitement par lot.

Utiliser la ligne de commande

Dans une requête gRPC, vous pouvez écrire directement les données binaires. Cependant, une requête REST utilise JSON. JSON est un format de texte qui n'est pas directement compatible avec les données binaires. Vous devez donc convertir ces données binaires en texte en utilisant l'encodage base64.

La plupart des environnements de développement contiennent un utilitaire natif base64 permettant d'encoder un fichier binaire en données texte ASCII. Pour encoder un fichier, procédez comme suit :

Linux

Encodez le fichier vidéo à l'aide de l'outil de ligne de commande base64, en veillant à empêcher tout retour à la ligne grâce à l'indicateur -w 0 :

base64 INPUT_FILE -w 0 > OUTPUT_FILE

macOS

Encodez le fichier à l'aide de l'outil de ligne de commande base64 :

base64 -i INPUT_FILE -o OUTPUT_FILE

Windows

Encodez le fichier à l'aide de l'outil Base64.exe :

Base64.exe -e INPUT_FILE > OUTPUT_FILE

PowerShell

Encodez le fichier à l'aide de la méthode Convert.ToBase64String :

[Convert]::ToBase64String([IO.File]::ReadAllBytes("./INPUT_FILE")) > OUTPUT_FILE

Créez un fichier de requête JSON en intégrant les données encodées en base64 :

JSON

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

Utiliser les bibliothèques clientes

L'intégration de données binaires dans des requêtes via des éditeurs de texte n'est pas plus souhaitable qu'elle n'est pratique. Concrètement, vous allez incorporer des fichiers encodés en base64 dans le code client. Tous les langages de programmation compatibles intègrent des mécanismes d'encodage de contenu en base64.

Python

# Import the base64 encoding library.
import base64

# Pass the image data to an encoding function.
def encode_image(image):
    with open(image, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read())
    return encoded_string

Node.js

// Read the file into memory.
var fs = require('fs');
var imageFile = fs.readFileSync('/path/to/file');

// Convert the image data to a Buffer and base64 encode it.
var encoded = Buffer.from(imageFile).toString('base64');

Java

// Import the Base64 encoding library.
import org.apache.commons.codec.binary.Base64;

// Encode the image.
String encodedString = Base64.getEncoder().encodeToString(imageFile.getBytes());

Go

import (
    "bufio"
    "encoding/base64"
    "io"
    "os"
)

// Open image file.
f, _ := os.Open("image.jpg")

// Read entire image into byte slice.
reader := bufio.NewReader(f)
content, _ := io.ReadAll(reader)

// Encode image as base64.
base64.StdEncoding.EncodeToString(content)