Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
GetDocumentAnalysis
Ruft die Ergebnisse für einen asynchronen Amazon Textract Textract-Vorgang ab, der Text in einem Dokument analysiert.
Sie starten die asynchrone Textanalyse durch AufrufenStartDocumentAnalysis, die eine Job-ID zurückgibt (JobId
) enthalten. Wenn der Textanalysevorgang abgeschlossen ist, veröffentlicht Amazon Textract einen Abschlussstatus für das Thema Amazon Simple Notification Service (Amazon SNS), das im ersten Aufruf von registriert istStartDocumentAnalysis
aus. Um die Ergebnisse des Texterkennungsvorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautetSUCCEEDED
aus. Wenn ja, ruf anGetDocumentAnalysis
und übergeben Sie die Job-ID (JobId
) vom ersten Anruf anStartDocumentAnalysis
aus.
GetDocumentAnalysis
gibt ein Array vonBlock-Objekte. Die folgenden Arten von Informationen werden zurückgegeben:
-
Formulardaten (Schlüssel-Wert-Paare). Die zugehörigen Informationen werden in zweiBlockObjekte, jeweils vom Typ
KEY_VALUE_SET
: Ein SCHLÜSSELBlock
Objekt und ein VALUEBlock
-Objekt. Beispiel,Name: Ana Silva Carolinaenthält einen Schlüssel und einen Wert. Name:ist der Schlüssel. Ana Silva Carolinaist der Wert. -
Tabellen- und Tabellenzellendaten. EIN TISCH
Block
-Objekt enthält Informationen über eine erkannte Tabelle. EINE ZELLEBlock
-Objekt wird für jede Zelle in einer Tabelle zurückgegeben. -
Textzeilen und Wörter. EINE ZEILE
Block
-Objekt enthält ein oder mehrere WORDBlock
-Objekte. Alle Zeilen und Wörter, die im Dokument erkannt werden, werden zurückgegeben (einschließlich Text, der keine Beziehung zum Wert desStartDocumentAnalysis
FeatureTypes
Eingabeparameter).
Auswahlelemente wie Kontrollkästchen und Optionsfelder (Optionsfelder) können in Formulardaten und in Tabellen erkannt werden. EIN SELECTION_ELEMENTBlock
-Objekt enthält Informationen über ein Selektionselement, einschließlich des Auswahlstatus.
Verwenden derMaxResults
Parameter, um die Anzahl der zurückgegebenen Blöcke einzuschränken. Wenn es mehr Ergebnisse gibt als angegeben inMaxResults
, der Wert vonNextToken
In der Operationsantwort enthält ein Paginierungs-Token für den Abruf des nächsten Ergebnissatzes. Um die nächste Ergebnisseite abzurufen, rufen SieGetDocumentAnalysis
und bevölkernNextToken
Anforderungsparameter mit dem Token-Wert, der vom vorherigen Aufruf anGetDocumentAnalysis
aus.
Weitere Informationen finden Sie unterTextanalyse für Dokumenteaus.
Anforderungssyntax
{
"JobId": "string
",
"MaxResults": number
,
"NextToken": "string
"
}
Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
- JobId
-
Ein eindeutiger Bezeichner für den Text-Erkennungs-Job. Die
JobId
wird von zurückgegebenStartDocumentAnalysis
aus. EINJobId
Der Wert ist nur 7 Tage lang gültig.Type: String (Zeichenfolge)
Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 64 Zeichen.
Pattern:
^[a-zA-Z0-9-_]+$
Erforderlich Ja
- MaxResults
-
Die maximale Anzahl der Ergebnisse, die pro paginierten Aufruf zurückgegeben werden sollen. Der größte Wert, den Sie angeben können, ist 1.000. Wenn Sie einen Wert größer als 1.000 angeben, werden maximal 1.000 Ergebnisse zurückgegeben. Der Standardwert lautet 1.000.
Type: Ganzzahl
Gültiger Bereich: Der Mindestwert ist 1.
Erforderlich Nein
- NextToken
-
Wenn die vorherige Antwort unvollständig war (da mehr Blöcke abgerufen werden müssen), gibt Amazon Textract ein Paginierungstoken in der Antwort zurück. Sie können dieses Paginierungs-Token verwenden, um den nächsten Satz von Blöcken abzurufen.
Type: String (Zeichenfolge)
Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 255 Zeichen.
Pattern:
.*\S.*
Erforderlich Nein
Antwortsyntax
{
"AnalyzeDocumentModelVersion": "string",
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"DocumentMetadata": {
"Pages": number
},
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"Warnings": [
{
"ErrorCode": "string",
"Pages": [ number ]
}
]
}
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.
- AnalyzeDocumentModelVersion
-
Type: String (Zeichenfolge)
- Blocks
-
Die Ergebnisse der Textanalyse-Operation.
Type: Array vonBlockObjekte
- DocumentMetadata
-
Informationen über ein Dokument, das Amazon Textract verarbeitet hat.
DocumentMetadata
wird auf jeder Seite mit paginierten Antworten eines Amazon Textract Textract-Videovorgangs zurückgegeben.Typ: DocumentMetadata Objekt
- JobStatus
-
Der aktuelle Status des Texterkennungsauftrags.
Type: String (Zeichenfolge)
Zulässige Werte:
IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS
- NextToken
-
Wenn die Antwort abgeschnitten wird, gibt Amazon Textract dieses Token zurück. Sie können dieses Token in der nachfolgenden Anforderung verwenden, um den nächsten Satz von Texterkennungsergebnissen abzurufen.
Type: String (Zeichenfolge)
Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 255 Zeichen.
Pattern:
.*\S.*
- StatusMessage
-
Gibt zurück, wenn der Erkennungsauftrag nicht abgeschlossen werden konnte. Enthält eine Erklärung dafür, welcher Fehler aufgetreten ist.
Type: String (Zeichenfolge)
- Warnings
-
Eine Liste der Warnungen, die während des Dokumentenanalysevorgangs aufgetreten sind.
Type: Array vonWarningObjekte
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
- InternalServerError
-
Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.
HTTP-Statuscode: 500
- InvalidJobIdException
-
Eine ungültige Job-ID wurde übergeben anGetDocumentAnalysisoder zuGetDocumentAnalysisaus.
HTTP-Statuscode: 400
- 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 ein
InvalidParameterException
Ausnahme tritt auf, wenn keiner derS3Object
oderBytes
Werte werden imDocument
Anforderungsparameter. Validieren Sie den Parameter, bevor Sie den API-Vorgang erneut aufrufen.HTTP-Statuscode: 400
- InvalidS3ObjectException
-
Amazon Textract kann auf das in der Anforderung angegebene S3-Objekt nicht zugreifen. für weitere Informationen,Konfigurieren des Zugriffs auf Amazon S3Informationen zur Problembehebung finden Sie unterFehlerbehebung für Amazon S3
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
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: