StartDocumentTextDetection

Startet die asynchrone Erkennung von Text in einem Dokument. Amazon Textract kann Textzeilen und Wörter erkennen, aus denen eine Textzeile besteht.

StartDocumentTextDetectionkann Text in Dokumenten analysieren, die im JPEG-, PNG-, TIFF- und PDF-Format vorliegen. Die Dokumente werden in einem Amazon S3 S3-Bucket gespeichert. Verwenden vonDocumentLocationum den -Bucket-Namen und den Dateinamen des Dokuments anzugeben.

StartTextDetectiongibt eine Job-ID zurück (JobId), die Sie verwenden, um die Ergebnisse der Operation zu erhalten. Wenn die Texterkennung abgeschlossen ist, veröffentlicht Amazon Textract einen Abschlussstatus im Amazon Simple Notification Service (Amazon SNS) -Thema, das Sie inNotificationChannelaus. Um die Ergebnisse des Texterkennungsvorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautetSUCCEEDEDaus. Wenn ja, ruf anGetDocumentTextDetectionund übergeben Sie die Job-ID (JobId) vom ersten Anruf anStartDocumentTextDetectionaus.

Weitere Informationen finden Sie unterTexterkennung von Dokumentenaus.

Anforderungssyntax

{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ClientRequestToken

Das idempotente Token, das verwendet wird, um die Startanfrage zu identifizieren. Wenn Sie dasselbe Token mit mehreren verwendenStartDocumentTextDetectionAnfragen, das gleicheJobIdwird zurückgegeben. Verwenden vonClientRequestTokenum zu verhindern, dass derselbe Job versehentlich mehr als einmal gestartet wird. Weitere Informationen finden Sie unterAsynchrone Operationen von Amazon Textract aufrufenaus.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.

Pattern: ^[a-zA-Z0-9-_]+$

: Erforderlich Nein

DocumentLocation

Der Speicherort des zu verarbeitenden Dokuments.

Typ: DocumentLocation Objekt

: Erforderlich Ja

JobTag

Eine Kennung, die Sie angeben, die in der zum Amazon SNS SNS-Thema veröffentlichten Abschlussbenachrichtigung enthalten ist. Sie können beispielsweise die Datei verwendenJobTagum die Art des Dokuments anzugeben, dem die Abschlussmitteilung entspricht (z. B. ein Steuerformular oder eine Quittung).

Type: String (Zeichenfolge)

Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.

Pattern: [a-zA-Z0-9_.\-:]+

: Erforderlich Nein

KMSKeyId

Der KMS-Schlüssel, der zum Verschlüsseln der Inferenzergebnisse verwendet wird. Dies kann entweder im Key ID- oder Key Alias Format vorliegen. Wenn ein KMS-Schlüssel bereitgestellt wird, wird der KMS-Schlüssel zur serverseitigen Verschlüsselung der Objekte im Kunden-Bucket verwendet. Wenn dieser Parameter nicht aktiviert ist, wird das Ergebnis serverseitig mit SSE-S3 verschlüsselt.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Mindestlänge 1. Maximale Länge beträgt 2048 Zeichen.

Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

: Erforderlich Nein

NotificationChannel

Das Amazon SNS SNS-Thema ARN, in dem Amazon Textract den Abschlussstatus des Vorgangs veröffentlichen soll.

Typ: NotificationChannel Objekt

: Erforderlich Nein

OutputConfig

Legt fest, ob die Ausgabe an einen vom Kunden definierten Bucket gesendet wird. Standardmäßig speichert Amazon Textract die Ergebnisse intern, auf die mit dem GetDocumentTextDetection -Vorgang zugegriffen werden soll.

Typ: OutputConfig Objekt

: Erforderlich Nein

Antwortsyntax

{
   "JobId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

JobId

Die Kennung des Texterkennungsauftrags für das Dokument. Verwenden vonJobIdum den Job in einem nachfolgenden Aufruf zu identifizierenGetDocumentTextDetectionaus. EINJobIdWert ist nur 7 Tage lang gültig.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.

Pattern: ^[a-zA-Z0-9-_]+$

Fehler

AccessDeniedException

Sie sind nicht berechtigt, die Aktion auszuführen. Verwenden Sie den Amazon-Ressourcennamen (ARN) der IAM-Rolle oder eines autorisierten Benutzers, um den Vorgang auszuführen.

HTTP-Statuscode: 400

BadDocumentException

Amazon Textract kann das Dokument nicht lesen. Weitere Informationen zu den Beleglimits in Amazon Textract finden Sie unterHard Limits in Amazon Textractaus.

HTTP-Statuscode: 400

DocumentTooLargeException

Das Dokument kann nicht verarbeitet werden, da es zu groß ist. Die maximale Dokumentgröße für synchrone Operationen 10 MB. Die maximale Dokumentgröße für asynchrone Vorgänge beträgt 500 MB für PDF-Dateien.

HTTP-Statuscode: 400

IdempotentParameterMismatchException

EINClientRequestTokenDer Eingabeparameter wurde mit einer Operation wiederverwendet, aber mindestens eine der anderen Eingabeparameter ist anders als im vorherigen Aufruf der Operation.

HTTP-Statuscode: 400

InternalServerError

Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.

HTTP-Statuscode: 500

InvalidKMSKeyException

Zeigt an, dass Sie keine Entschlüsselungsberechtigungen mit dem eingegebenen KMS-Schlüssel haben oder der KMS-Schlüssel falsch eingegeben wurde.

HTTP-Statuscode: 400

InvalidParameterException

Ein Eingabeparameter verletzt eine Beschränkung. Zum Beispiel wird bei synchronen Operationen einInvalidParameterExceptionAusnahme tritt auf, wenn keiner derS3ObjectoderBytesWerte werden imDocumentAnforderungsparameter. Validieren Sie den Parameter, bevor Sie die API-Operation erneut aufrufen.

HTTP-Statuscode: 400

InvalidS3ObjectException

Amazon Textract kann auf das in der Anforderung angegebene S3-Objekt nicht zugreifen.Konfigurieren des Zugriffs auf Amazon S3Informationen zur Problembehebung finden Sie unterFehlerbehebung für Amazon S3

HTTP-Statuscode: 400

LimitExceededException

Ein Amazon Textract Textract-Service-Limit wurde überschritten. Wenn Sie beispielsweise zu viele asynchrone Jobs gleichzeitig starten, rufen Sie den Betrieb auf (StartDocumentTextDetectionlösen beispielsweise eine LimitExcedeException-Ausnahme (HTTP-Statuscode: 400) aus, bis die Anzahl der gleichzeitig ausgeführten Aufträge unter dem Amazon Textract Textract-Service-Limit liegt.

HTTP-Statuscode: 400

ProvisionedThroughputExceededException

Die Anzahl der Anforderungen hat das Durchsatzlimit überschritten. Wenn Sie dieses Limit erhöhen müssen, wenden Sie sich an Amazon Textract.

HTTP-Statuscode: 400

ThrottlingException

Amazon Textract kann die Anforderung vorübergehend nicht verarbeiten. Wiederholen Sie den Aufruf.

HTTP-Statuscode: 500

UnsupportedDocumentException

Das Format des Eingabedokuments wird nicht unterstützt. Dokumente für Operationen können im PNG-, JPEG-, PDF- oder TIFF-Format vorliegen.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter:

• AWS-Befehlszeilenschnittstelle

• AWS-SDK für .NET

• AWS-SDK für C++

• AWS-SDK for Go

• AWSSDK for Java V2

• AWS-SDK für JavaScript

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3