Kurzanleitung: Document AI API einrichten

Diese Anleitung enthält alle erforderlichen Einrichtungsschritte für die Verwendung von Document AI.

Über die Google Cloud -Konsole

Die Google Cloud console ist eine Web-UI zur Bereitstellung, Konfiguration, Verwaltung und Überwachung von Systemen, die Google Cloud -Produkte verwenden. Sie verwenden die Google Cloud Console, um Document AI-Ressourcen einzurichten und zu verwalten.

Projekt erstellen

Wenn Sie Dienste von Google Cloudnutzen möchten, müssen Sie ein Projekt erstellen, in dem alle Ihre Google Cloud -Ressourcen organisiert sind. Ein Projekt besteht aus den folgenden Komponenten:

  • einer Gruppe von Mitarbeitern
  • aktivierten APIs und anderen Ressourcen
  • Monitoring-Tools
  • Zahlungsinformationen
  • Authentifizierungs- und Zugriffssteuerungen
  • Document AI-Prozessoren

Sie können ein Projekt oder mehrere Projekte erstellen. Sie können mit Ihren Projekten Ihre Google Cloud -Ressourcen in einer Ressourcenhierarchie organisieren. Weitere Informationen zu Projekten finden Sie in der Dokumentation zu Resource Manager.

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

Go to project selector

API aktivieren

Sie müssen die Document AI API für Ihr Projekt aktivieren. Weitere Informationen zur Aktivierung von APIs finden Sie in der Dokumentation zu Service Usage.

Enable the Document AI API.

Enable the API

Abrechnung aktivieren

In Rechnungskonten ist festgelegt, wer für eine bestimmte Gruppe von Ressourcen bezahlt. Abrechnungskonten können mit einem oder mehreren Projekten verknüpft werden. Die Gebühren für die Projektnutzung werden dem verknüpften Rechnungskonto belastet. Sie konfigurieren die Abrechnung, wenn Sie ein Projekt erstellen. Weitere Informationen finden Sie in der Dokumentation zur Abrechnung.

Verify that billing is enabled for your Google Cloud project.

Standorte

Mit Document AI können Sie steuern, wo die Ressourcen für Ihr Projekt gespeichert und verarbeitet werden. Insbesondere beim Erstellen eines Prozessors müssen Sie einen Speicherort für Ihre Daten auswählen. Standardmäßig speichert und verarbeitet Document AI Ressourcen an einem Standort in den USA. Wenn Sie den Standort „Europäische Union“ auswählen, werden Ihre Daten und Prozesse nur in der Europäischen Union gespeichert.

Standort mithilfe der API festlegen

Sie müssen den Standort Ihres Prozessors angeben, wenn Sie eine Verarbeitungsanfrage über die API senden. Wenn Ihr Auftragsverarbeiter beispielsweise so konfiguriert ist, dass Ihre Daten in der Europäischen Union gespeichert und verarbeitet werden, verwenden Sie den URI eu-documentai.googleapis.com wie folgt:

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

Document AI API-Clientbibliothek installieren

Zum Aufrufen der Document AI API haben Sie drei Möglichkeiten:

Die Clientbibliotheken sind für verschiedene gängige Sprachen verfügbar. Informationen zum Installieren der Clientbibliotheken finden Sie unter Document AI API-Clientbibliotheken.

Installieren und initialisieren Sie die Google Cloud CLI.

Die gcloud CLI bietet eine Reihe von Tools, mit denen Sie Ressourcen und Anwendungen verwalten können, die auf Google Cloudgehostet werden.

Unter folgendem Link finden Sie eine Anleitung:

Installieren Sie die Google Cloud CLI. Initialisieren Sie die Google Cloud CLI nach der Installation mit dem folgenden Befehl:

gcloud init

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Authentifizierung einrichten

Jede Clientanwendung, die die API verwendet, muss authentifiziert sein und Zugriff auf die angeforderten Ressourcen haben. Wie Sie die Authentifizierung einrichten, hängt davon ab, ob Sie in einer lokalen Entwicklungsumgebung arbeiten oder eine Produktionsumgebung einrichten. Weitere Informationen finden Sie unter Standardanmeldedaten für Anwendungen einrichten.

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#

Wenn Sie die .NET -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

Go

Wenn Sie die Go -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

Java

Wenn Sie die Java -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

Node.js

Wenn Sie die Node.js -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

PHP

Wenn Sie die PHP -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

Python

Wenn Sie die Python -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

Ruby

Wenn Sie die Ruby -Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten Sie dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

    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.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter ADC für eine lokale Entwicklungsumgebung einrichten.

REST

Wenn Sie die REST API-Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, nutzen Sie die Anmeldedaten, die Sie der gcloud CLI bereitstellen.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter Für die Verwendung von REST authentifizieren.

Informationen zu Rollen

Wenn Sie eine API aufrufen, muss die aufrufende Identität (alle anwendbaren Personen, Entitäten oder Prozesse und ihre definierten Attribute) die entsprechenden Berechtigungen haben. Google Cloud Sie können Berechtigungen gewähren, indem Sie einem Nutzerkonto oder Dienstkonto Rollen zuweisen. Weitere Informationen finden Sie in der Dokumentation zur Identitäts- und Zugriffsverwaltung (IAM).

Zum Testen der Document AI API können Sie die Rolle Projekt > Inhaber in den folgenden Schritten verwenden. Die Rolle Projekt > Inhaber gewährt dem Dienstkonto vollständige Berechtigung für Ressourcen in Ihrem Projekt. Wenn für Ihre Anfrage keine vollständigen Berechtigungen erforderlich sind, können Sie mit der Google Cloud Console eine restriktivere Rolle angeben. Eine Liste der Berechtigungen und Rollen für Document AI finden Sie unter Document AI-Berechtigungen und Document AI-Rollen. Informationen zum Verwalten von Berechtigungen mit IAM-Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Projektübergreifenden Dateizugriff einrichten

Wenn Sie Ihren Document AI-Prozessor in einem Projekt einrichten, möchten Sie möglicherweise, dass dieses Projekt auf Eingabedateien zugreift, die in einem anderen Projekt in derselben Organisation gespeichert sind, in der Document AI-Prozessoren gehostet werden.

Damit projektübergreifender Zugriff möglich ist, müssen Sie dem Standarddienstkonto für Document AI die Rolle „Storage-Objekt-Betrachter“ (roles/storage.objectViewer) zuweisen, wie in der folgenden Abbildung dargestellt.

setup-1

Beispiel

  • Angenommen, in Projekt A werden Document AI-Prozessoren gehostet und optional auch ein Bucket, in den die Prozessorausgabe geschrieben wird.
  • Projekt B gehört der Bucket, die Eingabedateien für Document AI-Prozessoren enthält.
  • Damit Dateien in Projekt B für Projekt A zugänglich sind, müssen Sie dem Document AI-Dienstkonto von Projekt A die Rolle „Storage-Objekt-Betrachter“ (roles/storage.objectViewer) für den Eingabe-Bucket in Projekt B zuweisen.

    setup-2

Weitere Informationen zu IAM und Storage Object Viewer finden Sie unter IAM-Rollen für Cloud Storage.

Integrierte Dienstkonten

Ein Document AI-Dienstkonto folgt dieser Namenskonvention:

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

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

setup-3

Nächste Schritte: Anwendungsfälle

Nachdem die Document AI API aktiviert wurde, können Document AI-Prozessoren erstellt und verwendet werden. Welcher Prozessortyp am besten geeignet ist, hängt von Ihrem Anwendungsfall ab.