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 consola de Google Cloud es una IU web que se usa para aprovisionar, configurar, administrar y supervisar los sistemas que usan productos de Google Cloud . Usa la consola de Google Cloud 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 Google Cloud y consta de los siguientes componentes:

  • 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 Google Cloud recursos en unajerarquí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 encargado del tratamiento de datos, 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 esa ubicación.

Cómo configurar la ubicación con la API

Debes especificar la ubicación del procesador cada vez que envíes una solicitud de procesamiento con la API. Por ejemplo, si tu encargado del tratamiento de datos 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:

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

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 depende de si trabajas en un entorno de desarrollo local o si 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

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

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. To initialize the gcloud CLI, run the following command:

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

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

REST

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

    Install the Google Cloud CLI, then initialize it by running the following command:

    gcloud init

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

Si quieres obtener información sobre cómo 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 asignándole roles a una cuenta de usuario o 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 una función más restrictiva con la consola de Google 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 de acceso a archivos entre proyectos

Cuando configuras tu procesador de Document AI en un proyecto, es posible que desees que este proyecto acceda a archivos de entrada almacenados en un proyecto diferente 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 almacenamiento (roles/storage.objectViewer) a la cuenta de servicio predeterminada de Document AI, como se muestra en la siguiente imagen.

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 el proyecto A pueda acceder a los archivos del proyecto B, debes otorgar el rol de visualizador de objetos de almacenamiento (roles/storage.objectViewer) para el bucket de entrada del proyecto B a la cuenta de servicio de Document AI del proyecto A.

    setup-2

Para 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 los procesadores de Document AI. El tipo de procesador que sea mejor depende de tu caso de uso.