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 Google Cloud consola

La Google Cloud console es una IU web que sirve para aprovisionar, configurar, administrar, y supervisar los sistemas que usan Google Cloud productos. La Google Cloud consola de 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 Google Cloud recursos 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 una jerarquía de recursos. Para obtener más información sobre los proyectos, consulta la documentación de Resource Manager.

En la Google Cloud consola de, en la página del selector de proyectos, selecciona o crea un Google Cloud proyecto de.

Roles necesarios para seleccionar o crear un proyecto

• Seleccionar un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
• Crear un proyecto: Para crear un proyecto, necesitas el rol de creador de proyectos (roles/resourcemanager.projectCreator), que contiene el resourcemanager.projects.create permiso. Obtén más información para otorgar roles.

Ir al selector de proyectos

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 la documentación de Service Usage.

Habilitar la API de Document AI

Roles necesarios para habilitar las APIs

Para habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin), que contiene el permiso serviceusage.services.enable. Obtén más información para otorgar roles.

Habilitar la 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.

Verifica que la facturación esté habilitada para tu Google Cloud proyecto.

Obtén los roles necesarios

Para obtener los permisos que necesitas para otorgar a una entidad acceso a los archivos en Cloud Storage, pídele a tu administrador que te otorgue el rol de IAM de administrador de almacenamiento (roles/storage.admin) en el bucket. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

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.

Nota: Tú y tus usuarios pueden acceder a los datos desde cualquier ubicación.

Configura la ubicación con la API

Debes especificar la ubicación de tu procesador cada vez que envíes una solicitud de procesamiento con 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 las siguientes tres opciones para llamar a la API de Document AI:

• Bibliotecas cliente compatibles con Google (recomendado)
• REST
• gRPC

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 la Google Cloud CLI.

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:

Instala la Google Cloud CLI. Después de la instalación, inicializa Google Cloud CLI con el siguiente comando:

gcloud init

Si usas un proveedor de identidad (IdP) externo, primero debes acceder a la gcloud CLI con tu identidad federada.

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.

Selecciona las pestañas según la forma en que planeas acceder a la API:

gcloud

Instala la Google Cloud CLI. Después de la instalación, inicializa Google Cloud CLI con el siguiente comando:

gcloud init

Si usas un proveedor de identidad (IdP) externo, primero debes acceder a la gcloud CLI con tu identidad federada.

Bibliotecas cliente

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

1. Instala la Google Cloud CLI.

2. Si usas un proveedor de identidad (IdP) externo, primero debes acceder a la gcloud CLI con tu identidad federada.

3. Si usas un shell local, crea credenciales de autenticación locales para tu cuenta de usuario:

   gcloud auth application-default login

   No es necesario que lo hagas si usas Cloud Shell.

   Si se muestra un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.

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

REST

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

Instala la Google Cloud CLI.

Si usas un proveedor de identidad (IdP) externo, primero debes acceder a la gcloud CLI con tu identidad federada.

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

Para obtener información sobre cómo configurar la autenticación de un entorno de producción, consulta Configura credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la Google Cloud documentación de autenticación de.

Acerca de las funciones

Cuando una principal autenticada intenta acceder a un Google Cloud recurso, IAM verifica si la principal tiene los permisos necesarios. Para otorgar permisos a las principales, debes asignar roles en las políticas de permisos de IAM. Para obtener más información sobre las principales, los roles, los recursos y las políticas de permisos, consulta la descripción general de IAM.

Sigue el principio de privilegio mínimo cuando otorgues roles en Google Cloud los recursos a las principales. No le otorgues a una principal más permisos de los que necesita para completar la solicitud. Para obtener más información sobre las prácticas recomendadas para el control de acceso, consulta Usa IAM de forma segura.

Para acceder a los recursos en Document AI, usa un rol que tenga los permisos específicos que necesitas. Para obtener más información, consulta Permisos de Document AI y Roles de Document AI.

Configuración del acceso a archivos entre proyectos

Cuando configuras tu procesador de Document AI en un proyecto, es posible que desees que este proyecto acceda a los 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) al agente de servicio de Document AI, como se muestra en la siguiente figura.

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 almacenamiento (roles/storage.objectViewer) para el bucket de entrada en el proyecto B al agente de servicio de Document AI del proyecto A.

  

Para obtener más información sobre IAM y el rol de visualizador de objetos de almacenamiento, consulta Funciones de IAM para Cloud Storage.

Cuentas de servicio integradas

Un agente de servicio de Document AI sigue esta convención de nombres:

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

Ejemplo: [e-mail]

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 es mejor depende de tu caso de uso.