Guía de inicio rápido: Configura la API de Document AI

En esta guía, se proporcionan todos los pasos de configuración necesarios para comenzar a usar Document AI.

Acerca de la consola de Google Cloud

La Google Cloud console es una IU web que se usa para aprovisionar, configurar, administrar y supervisar sistemas que usan productos de Google Cloud . La consola de Google Cloud se usa para configurar y administrar los recursos de Document AI.

Crea un proyecto

Para usar los servicios que proporciona Google Cloud, debes crear un proyecto, que organiza todos tus recursos de Google Cloudy consta de los siguientes componentes: Google Cloud

  • un conjunto de colaboradores
  • API habilitadas (y otros recursos)
  • Herramientas de supervisión
  • Información de facturación
  • controles de autenticación y acceso
  • Procesadores de Document AI

Puedes crear uno o varios proyectos Puedes usar tus proyectos para organizar tus recursos de Google Cloud en una jerarquía de recursos. Para obtener más información sobre los proyectos, consulta la documentación de Resource Manager.

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

Go to project selector

Habilita la API

Debes habilitar la API de Document AI para tu proyecto. Para obtener más información sobre cómo habilitar las API, consulta Cómo habilitar e inhabilitar servicios.

Enable the Document AI API.

Enable the API

Habilitar facturación

Una cuenta de facturación define quién paga un determinado conjunto de recursos. Las cuentas de facturación se pueden vincular a uno o más proyectos. El uso del proyecto se cobra a la cuenta de facturación vinculada. La facturación se configura cuando creas un proyecto. Para obtener más información, consulta la documentación de la facturación.

Make sure that billing is enabled for your Google Cloud project.

Ubicaciones

Document AI te ofrece cierto control sobre dónde se almacenan y procesan los recursos de tu proyecto. En particular, cuando creas un procesador, debes elegir una ubicación para almacenar y procesar tus datos. De forma predeterminada, Document AI almacena y procesa recursos en una ubicación de EE.UU. Si eliges la ubicación de la Unión Europea, tus datos y procesos solo se almacenarán en la Unión Europea.

Cómo configurar la ubicación con la API

Debes especificar la ubicación de tu procesador cada vez que envíes una solicitud de procesamiento a través de la API. Por ejemplo, si tu procesador está configurado para almacenar y procesar tus datos en la Unión Europea, usa el URI eu-documentai.googleapis.com de la siguiente manera:

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

Instala la biblioteca cliente de la API de Document AI

Tienes tres opciones para llamar a la API de Document AI:

Las bibliotecas cliente están disponibles para varios lenguajes populares. Para obtener información sobre la instalación de las bibliotecas cliente, consulta Bibliotecas cliente de la API de Document AI.

Instala y, luego, inicializa el SDK de Google Cloud.

La CLI de gcloud proporciona un conjunto de herramientas que puedes usar para administrar recursos y aplicaciones alojados en Google Cloud.

En el siguiente vínculo, se proporcionan instrucciones:

After installing the Google Cloud CLI, initialize it by running the following command:

gcloud init

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Configura la autenticación

Cualquier aplicación cliente que use la API debe estar autenticada y tener acceso a los recursos solicitados. La forma de configurar la autenticación dependerá de si trabajas en un entorno de desarrollo local o configuras un entorno de producción. Para obtener más información, consulta Configura credenciales predeterminadas de la aplicación.

Select the tabs for how you plan to access the API:

gcloud

    After installing the Google Cloud CLI, initialize it by running the following command:

    gcloud init

    If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    Bibliotecas cliente

    Para usar bibliotecas cliente en un entorno de desarrollo local, instala e inicializa gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

    1. Install the Google Cloud CLI.

    2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    3. To initialize the gcloud CLI, run the following command:

      gcloud init
    4. 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.

    Si deseas obtener más información, consulta Configura ADC para un entorno de desarrollo local en la Google Cloud documentación de autenticación.

    REST

    Para usar la API de REST en un entorno de desarrollo local, debes usar las credenciales que proporcionas a gcloud CLI.

      After installing the Google Cloud CLI, initialize it by running the following command:

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    Si deseas obtener más información, consulta Autentica para usar REST en la Google Cloud documentación de autenticación.

    Si deseas obtener información para configurar la autenticación para un entorno de producción, consulta Set up Application Default Credentials for code running on Google Cloud en la Google Cloud documentación de autenticación.

    Acerca de las funciones

    Cuando se llama a una API, Google Cloud requiere que la identidad de llamada (cualquier persona, entidad o proceso aplicable y sus atributos definidos) tenga los permisos correspondientes. Puedes otorgar permisos asignando roles a una cuenta de usuario o a una cuenta de servicio. Para obtener más información, consulta la documentación de administración de identidades y accesos (IAM).

    Para probar la API de Document AI, puedes usar el rol Proyecto > Propietario en los pasos que se indican a continuación. La función Proyecto > Propietario otorga a la cuenta de servicio permiso total para los recursos de tu proyecto. Si tu solicitud no requiere permisos completos, puedes especificar un rol más restrictivo con la consola deGoogle Cloud . Para obtener una lista de los permisos y roles de Document AI, consulta Permisos de Document AI y Roles de Document AI. Para obtener información sobre cómo administrar permisos con roles de IAM, consulta Administra el acceso a proyectos, carpetas y organizaciones.

    Configuración del acceso a archivos entre proyectos

    Cuando configures tu procesador de Document AI en un proyecto, es posible que desees que este proyecto acceda a los archivos de entrada almacenados en otro proyecto de la misma organización que aloja los procesadores de Document AI.

    Para permitir el acceso entre proyectos, debes otorgar el rol de visualizador de objetos de Storage (roles/storage.objectViewer) a la cuenta de servicio predeterminada de Document AI, como se muestra en la siguiente figura.

    setup-1

    Ejemplo

    • Supongamos que el proyecto A aloja procesadores de Document AI y, de manera opcional, aloja un bucket en el que se escribe el resultado del procesador.
    • El proyecto B es propietario del bucket que contiene los archivos de entrada para los procesadores de Document AI.
    • Para que los archivos del proyecto B sean accesibles para el proyecto A, debes otorgar el rol de visualizador de objetos de Storage (roles/storage.objectViewer) para el bucket de entrada en el proyecto B a la cuenta de servicio de Document AI del proyecto A.

      setup-2

    Si deseas obtener más información sobre IAM y Storage Object Viewer, consulta Funciones de IAM para Cloud Storage.

    Cuentas de servicio integradas

    Una cuenta de servicio de Document AI sigue esta convención de nombres:

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

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

    setup-3

    Próximos pasos: Casos de uso

    Una vez que se habilita la API de Document AI, se pueden crear y usar procesadores de Document AI. El mejor tipo de procesador depende de tu caso de uso.