Guide de démarrage rapide: Configurer l'API Document AI

Ce guide décrit toutes les étapes de configuration nécessaires pour commencer à utiliser Document AI.

À propos de la console Google Cloud

Google Cloud console est une interface utilisateur Web permettant de provisionner, configurer, gérer et surveiller les systèmes utilisant des produits Google Cloud . Vous utilisez la console Google Cloud pour configurer et gérer les ressources Document AI.

Créer un projet

Pour utiliser les services fournis par Google Cloud, vous devez créer un projet qui organise toutes vos ressources Google Cloud et qui se compose des éléments suivants :

  • Un ensemble de collaborateurs
  • Des API activées (et autres ressources)
  • Outils de surveillance
  • Informations bancaires
  • L'authentification et le contrôle des accès
  • Processeurs Document AI

Vous pouvez créer un projet ou en créer plusieurs. Vous pouvez utiliser vos projets pour organiser vos ressources Google Cloud dans une hiérarchie des ressources. Pour en savoir plus sur les projets, consultez la documentation concernant Resource Manager.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Activer l'API

Vous devez activer l'API Document AI pour votre projet. Pour en savoir plus sur l'activation des API, consultez la documentation concernant Service Usage.

Enable the Document AI API.

Enable the API

Activer la facturation

Un compte de facturation sert à déterminer qui assume les frais pour un ensemble de ressources donné. Il peut être associé à un ou plusieurs projets. Les frais d'utilisation du projet sont imputés au compte de facturation associé. Vous configurez la facturation lorsque vous créez un projet. Pour en savoir plus, consultez la documentation concernant la facturation.

Verify that billing is enabled for your Google Cloud project.

Emplacements

Document AI vous permet de contrôler où les ressources de votre projet sont stockées et traitées. En particulier, lorsque vous créez un processeur, vous devez choisir un emplacement pour stocker et traiter vos données. Par défaut, Document AI stocke et traite les ressources aux États-Unis. Si vous choisissez l'Union européenne comme emplacement, vos données et processus ne sont stockés que dans l'Union européenne.

Définir l'emplacement à l'aide de l'API

Vous devez spécifier l'emplacement de votre processeur chaque fois que vous envoyez une demande de traitement à l'aide de l'API. Par exemple, si votre processeur est configuré pour stocker et traiter vos données dans l'Union européenne, utilisez l'URI eu-documentai.googleapis.com comme suit :

Process
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
batchProcess
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess

Installer la bibliothèque cliente de l'API Document AI

Vous disposez de trois options pour appeler l'API Document AI :

Les bibliothèques clientes sont disponibles dans plusieurs langages courants. Pour plus d'informations sur l'installation des bibliothèques clientes, consultez la page Bibliothèques clientes de l'API Document AI.

Installer et initialiser Google Cloud CLI

La gcloud CLI fournit un ensemble d'outils que vous pouvez utiliser pour gérer les ressources et les applications hébergées sur Google Cloud.

Le lien suivant fournit les instructions correspondantes :

Installez Google Cloud CLI. Après l'installation, initialisez Google Cloud CLI en exécutant la commande suivante :

gcloud init

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Configurer l'authentification

Toute application cliente qui utilise l'API doit être authentifiée et se voir accorder l'accès aux ressources demandées. La façon dont vous configurez l'authentification dépend de l'environnement dans lequel vous travaillez : environnement de développement local ou environnement de production. Pour en savoir plus, consultez la page Configurer les identifiants par défaut de l'application.

Select the tab for how you plan to use the samples on this page:

gcloud

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

C#

Pour utiliser les exemples .NET de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

Go

Pour utiliser les exemples Go de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

Java

Pour utiliser les exemples Java de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

Node.js

Pour utiliser les exemples Node.js de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

PHP

Pour utiliser les exemples PHP de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

Python

Pour utiliser les exemples Python de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

Ruby

Pour utiliser les exemples Ruby de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez les Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

    If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local dans la documentation sur l'authentification Google Cloud .

REST

Pour utiliser les exemples d'API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à gcloud CLI.

    Installez Google Cloud CLI.

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l'authentification Google Cloud .

À propos des rôles

Lors de l'appel d'une API, Google Cloud exige que l'identité appelante (toute personne, entité ou processus applicable et ses attributs définis) dispose des autorisations appropriées. Vous pouvez accorder des autorisations en attribuant des rôles à un compte utilisateur ou à un compte de service. Pour en savoir plus, consultez la documentation sur Identity and Access Management (IAM).

Pour essayer l'API Document AI, vous pouvez utiliser le rôle Projet > Propriétaire dans les étapes ci-dessous. Le rôle Projet > Propriétaire accorde au compte de service un accès complet aux ressources de votre projet. Si votre demande ne nécessite pas d'autorisations complètes, vous pouvez spécifier un rôle plus restrictif à l'aide de la consoleGoogle Cloud . Pour obtenir la liste des autorisations et des rôles pour Document AI, consultez Autorisations Document AI et Rôles Document AI. Pour savoir comment gérer les autorisations à l'aide des rôles IAM, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Configurer l'accès aux fichiers entre projets

Lorsque vous configurez votre processeur Document AI dans un projet, vous pouvez souhaiter que ce projet accède aux fichiers d'entrée stockés dans un autre projet de la même organisation qui héberge les processeurs Document AI.

Pour autoriser l'accès inter-projets, vous devez attribuer le rôle de lecteur des objets de l'espace de stockage (roles/storage.objectViewer) au compte de service Document AI par défaut, comme illustré dans la figure suivante.

setup-1

Exemple

  • Supposons que le projet A héberge des processeurs Document AI et, éventuellement, un bucket dans lequel la sortie du processeur est écrite.
  • Le projet B est propriétaire du bucket contenant les fichiers d'entrée pour les processeurs Document AI.
  • Pour rendre les fichiers du projet B accessibles au projet A, vous devez attribuer le rôle Lecteur des objets Storage (roles/storage.objectViewer) pour le bucket d'entrée du projet B au compte de service Document AI du projet A.

    setup-2

Pour en savoir plus sur IAM et Storage Object Viewer, consultez Rôles IAM pour Cloud Storage.

Comptes de service intégrés

Un compte de service Document AI suit la convention d'attribution de noms suivante :

service-{project number}@gcp-sa-prod-dai-core.iam.gserviceaccount.com

Exemple : service-361747088407@gcp-sa-prod-dai-core.iam.gserviceaccount.com

setup-3

Étapes suivantes : cas d'utilisation

Une fois l'API Document AI activée, vous pouvez créer et utiliser des processeurs Document AI. Le type de processeur le plus adapté dépend de votre cas d'utilisation.