Text in Dateien erkennen

Der OCR-Dienst (Optical Character Recognition) von Vertex AI in Google Distributed Cloud (GDC) mit Air Gap erkennt und extrahiert Text aus PDF- und TIFF-Dateien. Sie können lokale Dateien in Inline-Anfragen an die API-Methode BatchAnnotateFiles senden oder in Buckets gespeicherte Dateien asynchron mit der API-Methode AsyncBatchAnnotateFiles verarbeiten. Die API-Methode BatchAnnotateFiles unterstützt eine einzelne Anfrage pro Batchaufruf.

Hinweis

Wenn Sie Text in Dateien erkennen möchten, wenden Sie sich an Ihren IAM-Projektadministrator, um die Rolle AI OCR Developer (ai-ocr-developer) in Ihrem Projekt-Namespace anzufordern.

Weitere Informationen zu dieser Rolle finden Sie unter IAM-Berechtigungen vorbereiten.

Für die Verwendung der OCR API benötigen Sie ein Projekt, für das die OCR API aktiviert ist. Außerdem benötigen Sie die entsprechenden Anmeldedaten. Sie können auch Clientbibliotheken installieren, um Aufrufe an die API zu ermöglichen. Weitere Informationen finden Sie unter Projekt zur Zeichenerkennung einrichten.

Text mit Inline-Anfragen erkennen

Die Methode BatchAnnotateFiles erkennt Text aus einem Batch von PDF- oder TIFF-Dateien. Sie senden die Datei, in der Sie Text erkennen möchten, direkt als Inhalt in der API-Anfrage. Das System gibt den erkannten Text im JSON-Format in der API-Antwort zurück.

Sie müssen Werte für die Felder im JSON-Text Ihrer API-Anfrage angeben. Die folgende Tabelle enthält eine Beschreibung der Felder im Anfragetext, die Sie angeben müssen, wenn Sie die API-Methode BatchAnnotateFiles für Ihre Texterkennungsanfragen verwenden:

Anfragetextfelder Feldbeschreibung
content Die Dateien mit Text, der erkannt werden soll. Sie stellen die Base64-Darstellung (ASCII-String) des Inhalts Ihrer Binärdatei bereit.
mime_type Der Quelldateityp. Sie müssen einen der folgenden Werte festlegen:
  • application/pdf für PDF-Dateien
  • image/tiff für TIFF-Dateien
type Die Art der Texterkennung, die Sie für die Datei benötigen.

Geben Sie eines der beiden Annotationsfeatures an:
  • TEXT_DETECTION erkennt und extrahiert Text aus jeder Datei. Die JSON-Antwort enthält den extrahierten String, einzelne Wörter und ihre Begrenzungsrahmen.
  • DOCUMENT_TEXT_DETECTION extrahiert ebenfalls Text aus einer Datei, optimiert die Antwort jedoch für Fließtext und Dokumente. Die JSON-Datei enthält Informationen zu Seite, Block, Absatz, Wort und Worttrennung.
Weitere Informationen zu diesen Annotationsfunktionen finden Sie unter Funktionen zur optischen Zeichenerkennung.
language_hints Optional. Liste der Sprachen, die für die Texterkennung verwendet werden sollen.

Das System interpretiert einen leeren Wert für dieses Feld als automatische Spracherkennung.

Bei Sprachen, die auf dem lateinischen Alphabet basieren, ist die Einstellung language_hints nicht erforderlich.

Wenn Sie die Sprache des Textes in der Datei kennen, können Sie die Ergebnisse durch Festlegen eines Hinweises verbessern.
pages Optional. Die Anzahl der Seiten aus der Datei, die für die Texterkennung verarbeitet werden sollen.

Sie können maximal fünf Seiten angeben. Wenn Sie die Anzahl der Seiten nicht angeben, verarbeitet der Dienst die ersten fünf Seiten der Datei.

Informationen zur vollständigen JSON-Darstellung finden Sie unter AnnotateFileRequest.

Inline-API-Anfrage stellen

Stellen Sie eine Anfrage an die vortrainierte OCR API mit der REST API-Methode. Andernfalls können Sie über ein Python-Script mit der vortrainierten OCR API interagieren, um Text aus PDF- oder TIFF-Dateien zu erkennen.

Die folgenden Beispiele zeigen, wie Sie Text in einer Datei mithilfe von OCR erkennen:

REST

So erkennen Sie Text in Dateien mit der REST API-Methode:

  1. Speichern Sie die folgende request.json-Datei für den Anfragetext:

    cat <<- EOF > request.json
{
  "requests": [
    {
      "input_config": {
        "content": BASE64_ENCODED_FILE,
        "mime_type": "application/pdf"
      },
      "features": [
        {
          "type": "FEATURE_TYPE"
        }
      ],
      "image_context": {
        "language_hints": [
          "LANGUAGE_HINT_1",
          "LANGUAGE_HINT_2",
          ...
        ]
      },
      "pages": []
    }
  ]
}
EOF

    Ersetzen Sie Folgendes:

    • BASE64_ENCODED_FILE: Die Base64-Darstellung (ASCII-String) des Inhalts Ihrer Binärdatei. Dieser String beginnt mit Zeichen, die in etwa so aussehen: /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==.
    • FEATURE_TYPE: die Art der Texterkennung, die Sie für die Datei benötigen. Zulässige Werte sind TEXT_DETECTION und DOCUMENT_TEXT_DETECTION.
    • LANGUAGE_HINT: die BCP 47-Sprach-Tags, die als Sprachhinweise für die Texterkennung verwendet werden sollen, z. B. en-t-i0-handwrit. Dieses Feld ist optional. Ein leerer Wert wird vom System als automatische Spracherkennung interpretiert.

  2. Authentifizierungstoken abrufen

  3. Stellen Sie die Anfrage:

    curl

    curl -X POST \
  -H "Authorization: Bearer TOKEN" \
  -H "x-goog-user-project: projects/PROJECT_ID" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d @request.json \
  https://ENDPOINT/v1/files:annotate

    Ersetzen Sie Folgendes:

    PowerShell

    $headers = @{
  "Authorization" = "Bearer TOKEN"
  "x-goog-user-project" = "projects/PROJECT_ID"
}

Invoke-WebRequest
  -Method POST
  -Headers $headers
  -ContentType: "application/json; charset=utf-8"
  -InFile request.json
  -Uri "ENDPOINT/v1/files:annotate" | Select-Object -Expand Content

    Ersetzen Sie Folgendes:

Python

So verwenden Sie den OCR-Dienst aus einem Python-Skript, um Text in einer Datei zu erkennen:

  1. Installieren Sie die aktuelle Version der OCR-Clientbibliothek.

  2. Legen Sie die erforderlichen Umgebungsvariablen in einem Python-Skript fest.

  3. Authentifizieren Sie Ihre API-Anfrage.

  4. Fügen Sie dem von Ihnen erstellten Python-Script den folgenden Code hinzu:

    from google.cloud import vision
import google.auth
from google.auth.transport import requests
from google.api_core.client_options import ClientOptions

audience = "https://ENDPOINT:443"
api_endpoint="ENDPOINT:443"

def vision_client(creds):
  opts = ClientOptions(api_endpoint=api_endpoint)
  return vision.ImageAnnotatorClient(credentials=creds, client_options=opts)

def main():
  creds = None
  try:
    creds, project_id = google.auth.default()
    creds = creds.with_gdch_audience(audience)
    req = requests.Request()
    creds.refresh(req)
  except Exception as e:
    print("Caught exception" + str(e))
    raise e
  return creds

def vision_func(creds):
  vc = vision_client(creds)
  input_config = {"content": "BASE64_ENCODED_FILE"}
  features = [{"type_": vision.Feature.Type.FEATURE_TYPE}]
  # Each requests element corresponds to a single file. To annotate more
  # files, create a request element for each file and add it to
  # the array of requests
  req = {"input_config": input_config, "features": features}

  metadata = [("x-goog-user-project", "projects/PROJECT_ID")]

  resp = vc.annotate_file(req,metadata=metadata)

  print(resp)

if __name__=="__main__":
  creds = main()
  vision_func(creds)

    Ersetzen Sie Folgendes:

    • ENDPOINT: der OCR-Endpunkt, den Sie für Ihre Organisation verwenden. Weitere Informationen finden Sie unter Dienststatus und Endpunkte ansehen.
    • BASE64_ENCODED_FILE: Die Base64-Darstellung (ASCII-String) des Dateiinhalts. Dieser String beginnt mit Zeichen, die in etwa so aussehen: /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==.
    • FEATURE_TYPE: die Art der Texterkennung, die Sie für die Datei benötigen. Zulässige Werte sind TEXT_DETECTION und DOCUMENT_TEXT_DETECTION.
    • PROJECT_ID: Ihre Projekt-ID.

  5. Speichern Sie das Python-Script.

  6. Führen Sie das Python-Skript aus, um Text in der Datei zu erkennen:

    python SCRIPT_NAME

    Ersetzen Sie SCRIPT_NAME durch den Namen, den Sie Ihrem Python-Skript gegeben haben, z. B. vision.py.

Text mit Offlineanfragen erkennen

Die Methode AsyncBatchAnnotateFiles erkennt Text in einem Batch von PDF- oder TIFF-Dateien, indem sie eine (asynchrone) Offline-Anfrage ausführt. Die Dateien können mehrere Seiten und mehrere Bilder pro Seite enthalten. Die Quelldateien müssen sich in einem Storage-Bucket Ihres Distributed Cloud-Projekts befinden. Das System speichert den resultierenden erkannten Text im JSON-Format in einem Storage-Bucket.

Der OCR-Dienst initiiert die Offlineverarbeitung und gibt die ID des Vorgangs mit langer Ausführungszeit zurück, der die Texterkennung für die Datei ausführt. Mit der zurückgegebenen ID können Sie den Status der Offlineverarbeitung verfolgen. Wenn zu viele Vorgänge gleichzeitig ausgeführt werden, wird die Offlineverarbeitung möglicherweise nicht sofort gestartet.

Sie müssen Werte für die Felder im JSON-Text Ihrer API-Anfrage angeben. Die folgende Tabelle enthält eine Beschreibung der Felder im Anfragetext, die Sie angeben müssen, wenn Sie die API-Methode AsyncBatchAnnotateFiles für Ihre Texterkennungsanfragen verwenden:

Anfragetextfelder Feldbeschreibung
gcs_source.uri Der URI-Pfad zu einer gültigen Quelldatei (PDF oder TIFF) in einem Storage-Bucket Ihres Distributed Cloud-Projekts.

Diese Datei enthält den Text, den Sie erkennen möchten.

Der anfragende Nutzer oder das anfragende Dienstkonto muss mindestens Leseberechtigungen für die Datei haben.
mime_type Der Quelldateityp. Sie müssen einen der folgenden Werte festlegen:
  • application/pdf für PDF-Dateien
  • image/tiff für TIFF-Dateien
type Die Art der Texterkennung, die Sie für die Datei benötigen.

Geben Sie eines der beiden Annotationsfeatures an:
  • TEXT_DETECTION erkennt und extrahiert Text aus jeder Datei. Die JSON-Antwort enthält den extrahierten String, einzelne Wörter und ihre Begrenzungsrahmen.
  • DOCUMENT_TEXT_DETECTION extrahiert ebenfalls Text aus einer Datei, optimiert die Antwort jedoch für Fließtext und Dokumente. Die JSON-Datei enthält Informationen zu Seite, Block, Absatz, Wort und Worttrennung.
Weitere Informationen zu diesen Annotationsfunktionen finden Sie unter Funktionen zur optischen Zeichenerkennung.
gcs_destination.uri Der URI-Pfad zu einem Storage-Bucket Ihres Distributed Cloud-Projekts, in dem Ausgabedateien gespeichert werden sollen.

An diesem Speicherort werden die Erkennungsergebnisse gespeichert.

Der anfragende Nutzer oder das anfragende Dienstkonto muss Schreibberechtigungen für den Bucket haben.

Quelldatei in einem Storage-Bucket speichern

Bevor Sie eine Anfrage senden, müssen Sie dafür sorgen, dass das OCR-Dienstkonto Leseberechtigungen für Ihren Eingabe-Bucket und Schreibberechtigungen für Ihren Ausgabe-Bucket hat.

Die Eingabe- und Ausgabe-Buckets können unterschiedlich sein und sich in verschiedenen Projekt-Namespaces befinden. Wir empfehlen, dieselben Eingabe- und Ausgabe-Buckets zu verwenden, um Fehler zu vermeiden, z. B. das Speichern der Ergebnisse in falschen Buckets.

So speichern Sie die Datei, aus der Sie Text erkennen möchten, in einem Storage-Bucket:

  1. gdcloud CLI für Objektspeicher konfigurieren

  2. Erstellen Sie einen Storage-Bucket im Namespace Ihres Projekts.Verwenden Sie eine Standard-Speicherklasse.

    Sie können den Storage-Bucket erstellen, indem Sie eine Bucket-Ressource im Projekt-Namespace bereitstellen:

    apiVersion: object.gdc.goog/v1
kind: Bucket
metadata:
  name: ocr-async-bucket
  namespace: PROJECT_NAMESPACE
spec:
  description: bucket for async ocr
  storageClass: Standard
  bucketPolicy:
    lockingPolicy:
      defaultObjectRetentionDays: 90

  3. Gewähren Sie dem vom OCR-Dienst verwendeten Dienstkonto (g-vai-ocr-sie-sa) die Berechtigungen read und write für den Bucket.

    So erstellen Sie die Rolle und die Rollenbindung mithilfe von benutzerdefinierten Ressourcen:

    1. Erstellen Sie die Rolle, indem Sie eine Role-Ressource im Projekt-Namespace bereitstellen:

        apiVersion: rbac.authorization.k8s.io/v1
  kind: Role
  metadata:
    name: ocr-async-reader-writer
    namespace: PROJECT_NAMESPACE
  rules:
    -
      apiGroups:
        - object.gdc.goog
      resources:
        - buckets
      verbs:
        - read-object
        - write-object

    2. Erstellen Sie die Rollenbindung, indem Sie eine RoleBinding-Ressource im Projekt-Namespace bereitstellen:

        apiVersion: rbac.authorization.k8s.io/v1
  kind: RoleBinding

  metadata:
    name: ocr-async-reader-writer-rolebinding
    namespace: PROJECT_NAMESPACE
  roleRef:
    apiGroup: rbac.authorization.k8s.io
    kind: Role
    name: ocr-async-reader-writer
  subjects:
    -
      kind: ServiceAccount
      name: g-vai-ocr-sie-sa
      namespace: g-vai-ocr-sie

  4. Laden Sie die Datei in den erstellten Storage-Bucket hoch. Weitere Informationen finden Sie unter Speicherobjekte in Projekten hoch- und herunterladen.

Offline-API-Anfrage stellen

Stellen Sie eine Anfrage an die vortrainierte OCR API mit der REST API-Methode. Andernfalls können Sie über ein Python-Script mit der vortrainierten OCR API interagieren, um Text aus PDF- oder TIFF-Dateien zu erkennen.

Die folgenden Beispiele zeigen, wie Sie Text in einer Datei mithilfe von OCR erkennen:

REST

So erkennen Sie Text in Dateien mit der REST API-Methode:

  1. Speichern Sie die folgende request.json-Datei für den Anfragetext:

    cat <<- EOF > request.json
{
  "parent": PROJECT_ID,
  "requests":[
    {
      "input_config": {
        "gcs_source": {
          "uri": "SOURCE_FILE"
        },
        "mime_type": "application/pdf"
      },
      "features": [
        {
          "type": "FEATURE_TYPE"
        }
      ],
      "output_config": {
        "gcs_destination": {
          "uri": "DESTINATION_BUCKET"
        }
      }
    }
  ]
}
EOF

    Ersetzen Sie Folgendes:

    • PROJECT_ID: Ihre Projekt-ID.
    • SOURCE_FILE: der URI-Pfad zu einer gültigen Quelldatei (PDF oder TIFF) in einem Storage-Bucket Ihres Distributed Cloud-Projekts.
    • FEATURE_TYPE: die Art der Texterkennung, die Sie für die Datei benötigen. Zulässige Werte sind TEXT_DETECTION und DOCUMENT_TEXT_DETECTION.
    • DESTINATION_BUCKET: Der URI-Pfad zu einem Storage-Bucket Ihres Distributed Cloud-Projekts, in dem Ausgabedateien gespeichert werden sollen.

  2. Authentifizierungstoken abrufen

  3. Stellen Sie die Anfrage:

    curl

    curl -X POST \
  -H "Authorization: Bearer TOKEN" \
  -H "x-goog-user-project: projects/PROJECT_ID" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d @request.json \
  https://ENDPOINT/v1/files:asyncBatchAnnotate

    Ersetzen Sie Folgendes:

    PowerShell

    $headers = @{
  "Authorization" = "Bearer TOKEN"
  "x-goog-user-project" = "projects/PROJECT_ID"
}

Invoke-WebRequest
  -Method POST
  -Headers $headers
  -ContentType: "application/json; charset=utf-8"
  -InFile request.json
  -Uri "ENDPOINT/v1/files:asyncBatchAnnotate" | Select-Object -Expand Content

    Ersetzen Sie Folgendes:

Python

So verwenden Sie den OCR-Dienst aus einem Python-Skript, um Text in einer Datei zu erkennen:

  1. Installieren Sie die aktuelle Version der OCR-Clientbibliothek.

  2. Legen Sie die erforderlichen Umgebungsvariablen in einem Python-Skript fest.

  3. Authentifizieren Sie Ihre API-Anfrage.

  4. Fügen Sie dem von Ihnen erstellten Python-Script den folgenden Code hinzu:

    from google.cloud import vision
import google.auth
from google.auth.transport import requests
from google.api_core.client_options import ClientOptions

audience = "https://ENDPOINT:443"
api_endpoint="ENDPOINT:443"

def vision_client(creds):
  opts = ClientOptions(api_endpoint=api_endpoint)
  return vision.ImageAnnotatorClient(credentials=creds, client_options=opts)

def vision_func_async(creds):
  vc = vision_client(creds)
  features = [{"type_": vision.Feature.Type.FEATURE_TYPE}]
  input_config = {"gcs_source":{"uri":"SOURCE_FILE"},"mime_type": "application/pdf"}
  output_config = {"gcs_destination": {"uri": "DESTINATION_BUCKET"}}
  req = {"input_config": input_config, "output_config": output_config, "features":features}
  reqs = {"requests":[req],"parent":"PROJECT_ID"}

  metadata = [("x-goog-user-project", "projects/PROJECT_ID")]

  operation = vc.async_batch_annotate_files(request=reqs, metadata=metadata)
  lro = operation.operation
  resp = operation.result()

def main():
  creds = None
  try:
    creds, project_id = google.auth.default()
    creds = creds.with_gdch_audience(audience)
    req = requests.Request()
    creds.refresh(req)
  except Exception as e:
    print("Caught exception" + str(e))
    raise e
  return creds

if __name__=="__main__":
  creds = main()
  vision_func_async(creds)

    Ersetzen Sie Folgendes:

    • ENDPOINT: der OCR-Endpunkt, den Sie für Ihre Organisation verwenden. Weitere Informationen finden Sie unter Dienststatus und Endpunkte ansehen.
    • FEATURE_TYPE: die Art der Texterkennung, die Sie für die Datei benötigen. Zulässige Werte sind TEXT_DETECTION und DOCUMENT_TEXT_DETECTION.
    • SOURCE_FILE: der URI-Pfad zu einer gültigen Quelldatei (PDF oder TIFF) in einem Storage-Bucket Ihres Distributed Cloud-Projekts.
    • DESTINATION_BUCKET: Der URI-Pfad zu einem Storage-Bucket Ihres Distributed Cloud-Projekts, in dem Ausgabedateien gespeichert werden sollen.
    • PROJECT_ID: Ihre Projekt-ID.

  5. Speichern Sie das Python-Script.

  6. Führen Sie das Python-Skript aus, um Text in der Datei zu erkennen:

    python SCRIPT_NAME

    Ersetzen Sie SCRIPT_NAME durch den Namen, den Sie Ihrem Python-Skript gegeben haben, z. B. vision.py.

Sie können den von der Methode AsyncBatchAnnotateFiles zurückgegebenen Vorgangsnamen verwenden, um den Status des Vorgangs zu prüfen.

Status des Vorgangs abrufen

Die Methode get gibt den neuesten Status eines Vorgangs mit langer Ausführungszeit zurück, z. B. die Offlineanfrage zur Texterkennung. Mit dieser Methode können Sie den Vorgangsstatus prüfen, wie im folgenden Beispiel gezeigt:

curl -X GET "http://ENDPOINT/v1/OPERATION_NAME"

Ersetzen Sie OPERATION_NAME durch den Vorgangsnamen, den die Methode AsyncBatchAnnotateFiles zurückgegeben hat, als Sie die Offlineanfrage gestellt haben.

Vorgänge auflisten

Die Methode list gibt eine Liste der Vorgänge zurück, die einem angegebenen Filter in der Anfrage entsprechen. Die Methode kann Vorgänge aus einem bestimmten Projekt zurückgeben. Geben Sie zum Aufrufen der Listenmethode Ihre Projekt-ID und den OCR-Endpunkt an, wie im folgenden Beispiel gezeigt:

curl -X GET "http://ENDPOINT/v1/PROJECT_ID?page_size=10"