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.
# Aktionen
Folgende Aktionen werden unterstützt:
+ [AnalyzeDocument](API_AnalyzeDocument.md)
+ [AnalyzeExpense](API_AnalyzeExpense.md)
+ [AnalyzeID](API_AnalyzeID.md)
+ [DetectDocumentText](API_DetectDocumentText.md)
+ [GetDocumentAnalysis](API_GetDocumentAnalysis.md)
+ [GetDocumentTextDetection](API_GetDocumentTextDetection.md)
+ [GetExpenseAnalysis](API_GetExpenseAnalysis.md)
+ [StartDocumentAnalysis](API_StartDocumentAnalysis.md)
+ [StartDocumentTextDetection](API_StartDocumentTextDetection.md)
+ [StartExpenseAnalysis](API_StartExpenseAnalysis.md)
# AnalyzeDocument
Analysiert ein Eingabedokument auf Beziehungen zwischen erkannten Elementen.
Die Arten der zurückgegebenen Informationen lauten wie folgt:
+ Formulardaten (Schlüssel-Wert-Paare). Die zugehörigen Informationen werden in zwei[Block](API_Block.md)Objekte, jeweils vom Typ`KEY_VALUE_SET`: Ein SCHLÜSSEL`Block`Objekt und ein VALUE`Block`-Objekt. Beispiel,*Name: Ana Silva Carolina*enthält einen Schlüssel und einen Wert. *Name:*ist der Schlüssel. *Ana Silva Carolina*ist der Wert.
+ Tabellen- und Tabellenzellendaten. EIN TISCH`Block`-Objekt enthält Informationen über eine erkannte Tabelle. EINE ZELLE`Block`-Objekt wird für jede Zelle in einer Tabelle zurückgegeben.
+ Textzeilen und Wörter. EINE ZEILE`Block`Objekt enthält ein oder mehrere`Block`Objekte. Alle Zeilen und Wörter, die im Dokument erkannt werden, werden zurückgegeben (einschließlich Text, der keine Beziehung zum Wert von`FeatureTypes`) enthalten.
Auswahlelemente wie Kontrollkästchen und Optionsfelder (Optionsfelder) können in Formulardaten und in Tabellen erkannt werden. EIN SELECTION\$1ELEMENT`Block`-Objekt enthält Informationen über ein Selektionselement, einschließlich des Auswahlstatus.
Sie können auswählen, welche Art von Analyse durchgeführt werden soll, indem Sie die`FeatureTypes`-Liste.
Die Ausgabe wird in einer Liste von`Block`Objekte.
`AnalyzeDocument`ist ein synchroner Vorgang. Um Dokumente asynchron zu analysieren, verwenden Sie[StartDocumentAnalysis](API_StartDocumentAnalysis.md)aus.
Weitere Informationen finden Sie unter[Textanalyse von Dokumenten](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)aus.
## Anforderungssyntax
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "string" ],
"HumanLoopConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"FlowDefinitionArn": "string",
"HumanLoopName": "string"
}
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [Document](#API_AnalyzeDocument_RequestSyntax) **
Das Eingabedokument als Base64-codierte Bytes oder ein Amazon S3 S3-Objekt. Wenn Sie die AWS CLI verwenden, um Amazon Textract Textract-Vorgänge aufzurufen, können Sie keine Bildbytes übergeben. Das Dokument muss ein Bild im JPEG-, PNG-, PDF- oder TIFF-Format sein.
Wenn Sie ein AWS SDK zum Aufrufen von Amazon Textract verwenden, müssen Sie möglicherweise keine Base64-Codierungsbytes codieren, die mit der`Bytes`field.
Typ: [Document](API_Document.md) Objekt
Erforderlich Ja
** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **
Eine Liste der durchzuführenden Analysetypen. Fügen Sie TABLES zur Liste hinzu, um Informationen zu den Tabellen zurückzugeben, die im Eingabedokument erkannt werden. Fügen Sie FORMS hinzu, um erkannte Formulardaten zurückzugeben Um beide Analysetypen durchzuführen, fügen Sie TABLES und FORMS hinzu`FeatureTypes`aus. Alle im Dokument erkannten Zeilen und Wörter sind in der Antwort enthalten (einschließlich Text, der nicht mit dem Wert von`FeatureTypes`) enthalten.
Type: Zeichenfolgen-Array
Zulässige Werte:` TABLES | FORMS`
Erforderlich Ja
** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **
Legt die Konfiguration für den Menschen im Loop-Workflow zur Analyse von Dokumenten fest.
Typ: [HumanLoopConfig](API_HumanLoopConfig.md) Objekt
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
},
"HumanLoopActivationOutput": {
"HumanLoopActivationConditionsEvaluationResults": "string",
"HumanLoopActivationReasons": [ "string" ],
"HumanLoopArn": "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.
** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **
Die Version des für die Analyse des Dokuments verwendeten Modells.
Type: String (Zeichenfolge)
** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **
Die Elemente, die erkannt und analysiert werden von`AnalyzeDocument`aus.
Type: Array von[Block](API_Block.md)Objekte
** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **
Metadaten über das analysierte Dokument. Ein Beispiel ist die Anzahl der Seiten.
Typ: [DocumentMetadata](API_DocumentMetadata.md) Objekt
** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **
Zeigt die Ergebnisse des Menschen in der Schleifenauswertung an.
Typ: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) Objekt
## 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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
** HumanLoopQuotaExceededException **
Zeigt an, dass Sie die maximal zulässige Anzahl an aktiven Menschen in den verfügbaren Loop-Workflows überschritten haben
HTTP-Statuscode: 400
** InternalServerError **
Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.
HTTP-Statuscode: 500
** InvalidParameterException **
Ein Eingabeparameter verletzt eine Beschränkung. Zum Beispiel wird bei synchronen Operationen ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument)
# AnalyzeExpense
`AnalyzeExpense`analysiert synchron ein Eingabedokument auf finanziell verwandte Beziehungen zwischen Text.
Informationen werden zurückgegeben als`ExpenseDocuments`und zerstreut sich wie folgt.
+ `LineItemGroups`- Ein Datensatz mit`LineItems`welche Informationen über die Textzeilen speichern, z. B. einen gekauften Artikel und seinen Preis auf einer Quittung.
+ `SummaryFields`- Enthält alle anderen Informationen einer Quittung, wie Kopfdaten oder den Namen des Lieferanten.
## Anforderungssyntax
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [Document](#API_AnalyzeExpense_RequestSyntax) **
Das Eingabedokument, entweder als Byte oder als S3-Objekt.
Sie übergeben Bild-Bytes an eine Amazon Textract Textract-API-Operation, indem Sie die`Bytes`eigentum. Verwenden Sie zum Beispiel die`Bytes`-Eigenschaft, um ein aus einem lokalen Dateisystem geladenes Dokument zu übergeben. Bildbytes, die mit dem`Bytes`Die Eigenschaft muss base64-codiert werden. Ihr Code muss möglicherweise keine Dokumentdateibytes codieren, wenn Sie ein AWS SDK zum Aufrufen von Amazon Textract Textract-API-Operationen verwenden.
Sie übergeben Bilder, die in einem S3-Bucket Amazon Textract, indem Sie die`S3Object`eigentum. Dokumente, die in einem S3-Bucket gespeichert sind, müssen nicht base64-codiert werden.
Die AWS-Region für den S3-Bucket, der das S3-Objekt enthält, muss mit der von Ihnen für Amazon Textract Textract-Operationen verwendeten AWS-Region übereinstimmen.
Wenn Sie Amazon Textract Textract-Operationen mithilfe der AWS CLI aufrufen, wird die Weitergabe von Bild-Bytes mit der Bytes -Eigenschaft nicht unterstützt. Sie müssen zuerst das Dokument auf einen Amazon-S3-Bucket hochladen und anschließend die Operation mithilfe der S3Object-Eigenschaft aufrufen.
Damit Amazon Textract ein S3-Objekt verarbeiten kann, muss der Benutzer über die Berechtigung für den Zugriff auf das S3-Objekt verfügen.
Typ: [Document](API_Document.md) Objekt
Erforderlich: Ja
## Antwortsyntax
```
{
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "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.
** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **
Informationen über das Eingabedokument.
Typ: [DocumentMetadata](API_DocumentMetadata.md) Objekt
** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **
Die von Amazon Textract festgestellten Kosten.
Type: Array von[ExpenseDocument](API_ExpenseDocument.md)Objekte
## 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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
** InternalServerError **
Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.
HTTP-Statuscode: 500
** InvalidParameterException **
Ein Eingabeparameter verletzt eine Beschränkung. Zum Beispiel wird bei synchronen Operationen ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense)
# AnalyzeID
Analysiert Ausweisdokumente auf relevante Informationen. Diese Informationen werden extrahiert und als`IdentityDocumentFields`, das sowohl das normalisierte Feld als auch den Wert des extrahierten Textes aufzeichnet. Im Gegensatz zu anderen Amazon Textract Textract-Vorgängen`AnalyzeID`gibt keine Geometrie-Daten zurück.
## Anforderungssyntax
```
{
"DocumentPages": [
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
]
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [DocumentPages](#API_AnalyzeID_RequestSyntax) **
Das Dokument wird an AnalyeID übergeben.
Type: Array-Reihe[Document](API_Document.md)Objekte
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl von 2 Elementen.
Erforderlich: Ja
## Antwortsyntax
```
{
"AnalyzeIDModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"IdentityDocuments": [
{
"DocumentIndex": number,
"IdentityDocumentFields": [
{
"Type": {
"Confidence": number,
"NormalizedValue": {
"Value": "string",
"ValueType": "string"
},
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"NormalizedValue": {
"Value": "string",
"ValueType": "string"
},
"Text": "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.
** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **
Die Version der AnalyeIdentity API, die zur Verarbeitung von Dokumenten verwendet wird.
Type: String (Zeichenfolge)
** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **
Informationen über das Eingabedokument.
Typ: [DocumentMetadata](API_DocumentMetadata.md) Objekt
** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **
Die Liste der von AnalyeID verarbeiteten Dokumente. Schließt eine Zahl ein, die ihren Platz in der Liste und die Antwortstruktur für das Dokument angibt.
Type: Array-Reihe[IdentityDocument](API_IdentityDocument.md)Objekte
## 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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
** InternalServerError **
Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.
HTTP-Statuscode: 500
** InvalidParameterException **
Ein Eingabeparameter verletzt eine Beschränkung. Zum Beispiel wird bei synchronen Operationen ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID)
# DetectDocumentText
Erkennt Text im Eingabedokument. Amazon Textract kann Textzeilen und Wörter erkennen, aus denen eine Textzeile besteht. Das Eingabedokument muss ein Bild im JPEG-, PNG-, PDF- oder TIFF-Format sein.`DetectDocumentText`gibt den erkannten Text in einem Array von[Block](API_Block.md)-Objekte.
Jede Dokumentseite ist als verknüpft`Block`vom Typ PAGE. Jede SEITE`Block`object ist das übergeordnete Element von LINE`Block`-Objekte, die die Zeilen des erkannten Textes auf einer Seite darstellen. EINE ZEILE`Block`object ist ein übergeordnetes Element für jedes Wort, aus dem die Zeile besteht. Wörter werden dargestellt durch`Block`Objekte des Typs WORD.
`DetectDocumentText`ist ein synchroner Vorgang. Um Dokumente asynchron zu analysieren, verwenden Sie[StartDocumentTextDetection](API_StartDocumentTextDetection.md)aus.
Weitere Informationen finden Sie unter[Texterkennung von Dokumenten](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)aus.
## Anforderungssyntax
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [Document](#API_DetectDocumentText_RequestSyntax) **
Das Eingabedokument als Base64-codierte Bytes oder ein Amazon S3 S3-Objekt. Wenn Sie die AWS CLI verwenden, um Amazon Textract Textract-Vorgänge aufzurufen, können Sie keine Bildbytes übergeben. Das Dokument muss ein Bild im JPEG- oder PNG-Format sein.
Wenn Sie ein AWS SDK zum Aufrufen von Amazon Textract verwenden, müssen Sie möglicherweise keine Base64-Codierung von Image-Bytes, die mit dem`Bytes`field.
Typ: [Document](API_Document.md) Objekt
Erforderlich: Ja
## Antwortsyntax
```
{
"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"
}
],
"DetectDocumentTextModelVersion": "string",
"DocumentMetadata": {
"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.
** [Blocks](#API_DetectDocumentText_ResponseSyntax) **
Ein Array von`Block`-Objekte, die den Text enthalten, der im Dokument erkannt wurde.
Type: Array-Reihe[Block](API_Block.md)Objekte
** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **
Type: String (Zeichenfolge)
** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **
Metadaten über das Dokument. Es enthält die Anzahl der Seiten, die im Dokument erkannt werden.
Typ: [DocumentMetadata](API_DocumentMetadata.md) Objekt
## 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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
** InternalServerError **
Amazon Textract hat ein Service-Problem festgestellt. Wiederholen Sie den Aufruf.
HTTP-Statuscode: 500
** InvalidParameterException **
Ein Eingabeparameter verletzt eine Beschränkung. Zum Beispiel wird bei synchronen Operationen ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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. für weitere Informationen,[Konfigurieren des Zugriffs auf Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText)
# 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 Aufrufen[StartDocumentAnalysis](API_StartDocumentAnalysis.md), 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 ist`StartDocumentAnalysis`aus. Um die Ergebnisse des Texterkennungsvorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautet`SUCCEEDED`aus. Wenn ja, ruf an`GetDocumentAnalysis`und übergeben Sie die Job-ID (`JobId`) vom ersten Anruf an`StartDocumentAnalysis`aus.
`GetDocumentAnalysis`gibt ein Array von[Block](API_Block.md)-Objekte. Die folgenden Arten von Informationen werden zurückgegeben:
+ Formulardaten (Schlüssel-Wert-Paare). Die zugehörigen Informationen werden in zwei[Block](API_Block.md)Objekte, jeweils vom Typ`KEY_VALUE_SET`: Ein SCHLÜSSEL`Block`Objekt und ein VALUE`Block`-Objekt. Beispiel,*Name: Ana Silva Carolina*enthält einen Schlüssel und einen Wert. *Name:*ist der Schlüssel. *Ana Silva Carolina*ist der Wert.
+ Tabellen- und Tabellenzellendaten. EIN TISCH`Block`-Objekt enthält Informationen über eine erkannte Tabelle. EINE ZELLE`Block`-Objekt wird für jede Zelle in einer Tabelle zurückgegeben.
+ Textzeilen und Wörter. EINE ZEILE`Block`-Objekt enthält ein oder mehrere WORD`Block`-Objekte. Alle Zeilen und Wörter, die im Dokument erkannt werden, werden zurückgegeben (einschließlich Text, der keine Beziehung zum Wert des`StartDocumentAnalysis` `FeatureTypes`Eingabeparameter).
Auswahlelemente wie Kontrollkästchen und Optionsfelder (Optionsfelder) können in Formulardaten und in Tabellen erkannt werden. EIN SELECTION\$1ELEMENT`Block`-Objekt enthält Informationen über ein Selektionselement, einschließlich des Auswahlstatus.
Verwenden der`MaxResults`Parameter, um die Anzahl der zurückgegebenen Blöcke einzuschränken. Wenn es mehr Ergebnisse gibt als angegeben in`MaxResults`, der Wert von`NextToken`In der Operationsantwort enthält ein Paginierungs-Token für den Abruf des nächsten Ergebnissatzes. Um die nächste Ergebnisseite abzurufen, rufen Sie`GetDocumentAnalysis`und bevölkern`NextToken`Anforderungsparameter mit dem Token-Wert, der vom vorherigen Aufruf an`GetDocumentAnalysis`aus.
Weitere Informationen finden Sie unter[Textanalyse für Dokumente](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)aus.
## Anforderungssyntax
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **
Ein eindeutiger Bezeichner für den Text-Erkennungs-Job. Die`JobId`wird von zurückgegeben`StartDocumentAnalysis`aus. EIN`JobId`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](#API_GetDocumentAnalysis_RequestSyntax) **
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](#API_GetDocumentAnalysis_RequestSyntax) **
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](#API_GetDocumentAnalysis_ResponseSyntax) **
Type: String (Zeichenfolge)
** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **
Die Ergebnisse der Textanalyse-Operation.
Type: Array von[Block](API_Block.md)Objekte
** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **
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](API_DocumentMetadata.md) Objekt
** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **
Der aktuelle Status des Texterkennungsauftrags.
Type: String (Zeichenfolge)
Zulässige Werte:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **
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](#API_GetDocumentAnalysis_ResponseSyntax) **
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](#API_GetDocumentAnalysis_ResponseSyntax) **
Eine Liste der Warnungen, die während des Dokumentenanalysevorgangs aufgetreten sind.
Type: Array von[Warning](API_Warning.md)Objekte
## 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 an[GetDocumentAnalysis](#API_GetDocumentAnalysis)oder zu[GetDocumentAnalysis](#API_GetDocumentAnalysis)aus.
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 der`S3Object`oder`Bytes`Werte werden im`Document`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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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:
+ [AWS-Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis)
# GetDocumentTextDetection
Ruft die Ergebnisse für einen asynchronen Amazon Textract Textract-Vorgang ab, der Text in einem Dokument erkennt. Amazon Textract kann Textzeilen und Wörter erkennen, aus denen eine Textzeile besteht.
Sie starten die asynchrone Texterkennung durch Aufrufen[StartDocumentTextDetection](API_StartDocumentTextDetection.md), die eine Job-ID zurückgibt (`JobId`) enthalten. Wenn der Vorgang zur Texterkennung abgeschlossen ist, veröffentlicht Amazon Textract einen Abschlussstatus für das Thema Amazon Simple Notification Service (Amazon SNS), das im ersten Aufruf von registriert ist`StartDocumentTextDetection`aus. Um die Ergebnisse des Texterkennungsvorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautet`SUCCEEDED`aus. Wenn ja, ruf an`GetDocumentTextDetection`und übergeben Sie die Job-ID (`JobId`) vom ersten Anruf an`StartDocumentTextDetection`aus.
`GetDocumentTextDetection`gibt ein Array von[Block](API_Block.md)-Objekte.
Jede Dokumentseite ist als verknüpft`Block`vom Typ PAGE. Jede SEITE`Block`Objekt ist das übergeordnete Element von LINE`Block`-Objekte, die die Zeilen des erkannten Textes auf einer Seite darstellen. EINE ZEILE`Block`object ist ein übergeordnetes Element für jedes Wort, aus dem die Zeile besteht. Wörter werden dargestellt durch`Block`Objekte vom Typ WORD.
Verwenden Sie den MaxResults-Parameter, um die Anzahl der zurückgegebenen Blöcke einzuschränken. Wenn es mehr Ergebnisse gibt als in angegeben`MaxResults`, der Wert von`NextToken`In der Betriebsantwort enthält ein Paginierungs-Token für den Abruf des nächsten Ergebnissatzes. Um die nächste Ergebnisseite abzurufen, rufen Sie`GetDocumentTextDetection`und bevölkern`NextToken`Anforderungsparameter mit dem Token-Wert, der vom vorherigen Aufruf an zurückgegeben wurde`GetDocumentTextDetection`aus.
Weitere Informationen finden Sie unter[Erkennung von Text-Dokumenten](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)aus.
## Anforderungssyntax
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **
Ein eindeutiger Bezeichner für den Texterkennungsauftrag. Die`JobId`wird zurückgegeben von`StartDocumentTextDetection`aus. EIN`JobId`Der Wert ist nur 7 Tage lang gültig.
Type: String (Zeichenfolge)
Einschränkungen für die Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.
Pattern: `^[a-zA-Z0-9-_]+$`
Erforderlich: Ja
** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **
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 größeren Wert als 1.000 angeben, wird die maximale Anzahl von 1.000 Ergebnissen zurückgegeben. Der Standardwert lautet 1.000.
Type: Ganzzahl
Gültiger Bereich: Der Mindestwert ist 1.
Erforderlich: Nein
** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **
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)
Einschränkungen für die Länge: Mindestlänge 1. Höchstlänge = 255 Zeichen.
Pattern: `.*\S.*`
Erforderlich: Nein
## Antwortsyntax
```
{
"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"
}
],
"DetectDocumentTextModelVersion": "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.
** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **
Die Ergebnisse des Texterkennungsvorgangs.
Type: Array von[Block](API_Block.md)Objekte
** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **
Type: String (Zeichenfolge)
** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **
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](API_DocumentMetadata.md) Objekt
** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **
Der aktuelle Status des Texterkennungsauftrags.
Type: String (Zeichenfolge)
Zulässige Werte:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **
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 Texterkennungs-Ergebnissen abzurufen.
Type: String (Zeichenfolge)
Einschränkungen für die Länge: Mindestlänge 1. Höchstlänge = 255 Zeichen.
Pattern: `.*\S.*`
** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **
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](#API_GetDocumentTextDetection_ResponseSyntax) **
Eine Liste der Warnungen, die während des Texterkennungsvorgangs für das Dokument aufgetreten sind.
Type: Array von[Warning](API_Warning.md)Objekte
## 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 an[GetDocumentAnalysis](API_GetDocumentAnalysis.md)oder zu[GetDocumentAnalysis](API_GetDocumentAnalysis.md)aus.
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 der`S3Object`oder`Bytes`Werte werden im`Document`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.[Konfigurieren des Zugriffs auf Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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:
+ [AWS-Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection)
# GetExpenseAnalysis
Ruft die Ergebnisse für einen asynchronen Amazon Textract Textract-Vorgang ab, der Rechnungen und Belege analysiert. Amazon Textract findet Kontaktinformationen, gekaufte Artikel und den Namen des Lieferanten aus Eingaberechnungen und Quittungen.
Sie starten die asynchrone Rechnungs-/Beleganalyse, indem Sie anrufen[StartExpenseAnalysis](API_StartExpenseAnalysis.md), die eine Job-ID zurückgibt (`JobId`) enthalten. Nach Abschluss der Rechnungs-/Belegungsanalyse veröffentlicht Amazon Textract den Erledigungsstatus im Amazon Simple Notification Service (Amazon SNS) -Thema. Dieses Thema muss im ersten Aufruf von`StartExpenseAnalysis`aus. Um die Ergebnisse des Rechnungs-/Beleganalysevorgangs zu erhalten, stellen Sie zunächst sicher, dass der für das Amazon SNS-Thema veröffentlichte Status Wert lautet`SUCCEEDED`aus. Wenn ja, ruf an`GetExpenseAnalysis`und übergeben Sie die Job-ID (`JobId`) vom ersten Anruf an`StartExpenseAnalysis`aus.
Verwenden Sie den MaxResults-Parameter, um die Anzahl der zurückgegebenen Blöcke einzuschränken. Wenn es mehr Ergebnisse gibt als angegeben in`MaxResults`, der Wert von`NextToken`In der Operationsantwort enthält ein Paginierungs-Token für den Abruf des nächsten Ergebnissatzes. Um die nächste Ergebnisseite abzurufen, rufen Sie`GetExpenseAnalysis`und bevölkern Sie das`NextToken`Anforderungsparameter mit dem Token-Wert, der vom vorherigen Aufruf an`GetExpenseAnalysis`aus.
Weitere Informationen finden Sie unter[Rechnungen und Belege analysieren](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html)aus.
## Anforderungssyntax
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Anfrageparameter
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **
Ein eindeutiger Bezeichner für den Texterkennungsauftrag. Die`JobId`wird zurückgegeben`StartExpenseAnalysis`aus. EIN`JobId`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](#API_GetExpenseAnalysis_RequestSyntax) **
Die maximale Anzahl der Ergebnisse, die pro paginierten Aufruf zurückgegeben werden sollen. Der größte Wert, den Sie angeben können, ist 20. Wenn Sie einen Wert größer als 20 angeben, werden maximal 20 Ergebnisse zurückgegeben. Der Standardwert ist 20.
Type: Ganzzahl
Gültiger Bereich: Der Mindestwert ist 1.
Erforderlich: Nein
** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **
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
```
{
"AnalyzeExpenseModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
],
"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.
** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **
Die aktuelle Modellversion von AnalyzeExpense.
Type: String (Zeichenfolge)
** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **
Informationen über ein Dokument, das Amazon Textract verarbeitet hat.`DocumentMetadata`wird auf jeder Seite mit paginierten Antworten eines Amazon Textract Textract-Vorgangs zurückgegeben.
Typ: [DocumentMetadata](API_DocumentMetadata.md) Objekt
** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **
Die von Amazon Textract festgestellten Kosten.
Type: Array-Anordnung[ExpenseDocument](API_ExpenseDocument.md)Objekte
** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **
Der aktuelle Status des Texterkennungsauftrags.
Type: String (Zeichenfolge)
Zulässige Werte:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **
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 Ergebnissen zur Texterkennung abzurufen.
Type: String (Zeichenfolge)
Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 255 Zeichen.
Pattern: `.*\S.*`
** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **
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](#API_GetExpenseAnalysis_ResponseSyntax) **
Eine Liste der Warnungen, die während des Texterkennungsvorgangs für das Dokument aufgetreten sind.
Type: Array-Anordnung[Warning](API_Warning.md)Objekte
## 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 an[GetDocumentAnalysis](API_GetDocumentAnalysis.md)oder zu[GetDocumentAnalysis](API_GetDocumentAnalysis.md)aus.
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 der`S3Object`oder`Bytes`Werte werden im`Document`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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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:
+ [AWS-Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis)
# StartDocumentAnalysis
Startet die asynchrone Analyse eines Eingabedokuments für Beziehungen zwischen erkannten Elementen wie Schlüssel-Wert-Paare, Tabellen und Selektionselemente.
`StartDocumentAnalysis`kann Text in Dokumenten analysieren, die im JPEG-, PNG-, TIFF- und PDF-Format vorliegen. Die Dokumente werden in einem Amazon S3 S3-Bucket gespeichert. Verwenden von[DocumentLocation](API_DocumentLocation.md)um den -Bucket-Namen und den Dateinamen des Dokuments anzugeben.
`StartDocumentAnalysis`gibt eine Job-ID zurück (`JobId`) die Sie verwenden, um die Ergebnisse der Operation zu erhalten. Wenn die Textanalyse abgeschlossen ist, veröffentlicht Amazon Textract einen Abschlussstatus im Amazon Simple Notification Service (Amazon SNS) -Thema, das Sie in angeben`NotificationChannel`aus. Um die Ergebnisse des Textanalysevorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautet`SUCCEEDED`aus. Wenn ja, ruf an[GetDocumentAnalysis](API_GetDocumentAnalysis.md)und übergeben Sie die Job-ID (`JobId`) vom ersten Anruf an`StartDocumentAnalysis`aus.
Weitere Informationen finden Sie unter[Textanalyse von Dokumenten](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)aus.
## Anforderungssyntax
```
{
"ClientRequestToken": "string",
"DocumentLocation": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "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](#API_StartDocumentAnalysis_RequestSyntax) **
Das idempotent-Token, mit dem Sie die Startanfrage identifizieren. Wenn Sie dasselbe Token mit mehreren verwenden`StartDocumentAnalysis`Anfragen, das gleiche`JobId`wird zurückgegeben. Verwenden von`ClientRequestToken`um zu verhindern, dass derselbe Job versehentlich mehr als einmal gestartet wird. Weitere Informationen finden Sie unter[Asynchrone Operationen von Amazon Textract aufrufen](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)aus.
Type: String (Zeichenfolge)
Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.
Pattern: `^[a-zA-Z0-9-_]+$`
Erforderlich: Nein
** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) **
Der Speicherort des zu verarbeitenden Dokuments.
Typ: [DocumentLocation](API_DocumentLocation.md) Objekt
Erforderlich: Ja
** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **
Eine Liste der durchzuführenden Analysetypen. Fügen Sie TABLES zur Liste hinzu, um Informationen zu den Tabellen zurückzugeben, die im Eingabedokument erkannt werden. Fügen Sie FORMS hinzu, um erkannte Formulardaten zurückzugeben Um beide Analysetypen durchzuführen, fügen Sie TABLES und FORMS hinzu`FeatureTypes`aus. Alle im Dokument erkannten Zeilen und Wörter sind in der Antwort enthalten (einschließlich Text, der nicht mit dem Wert von`FeatureTypes`) enthalten.
Type: Zeichenfolgen-Array
Zulässige Werte:` TABLES | FORMS`
Erforderlich: Ja
** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **
Eine Kennung, die Sie angeben, die in der zum Amazon SNS SNS-Thema veröffentlichten Abschlussbenachrichtigung enthalten ist. Sie können beispielsweise die Datei verwenden`JobTag`um 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](#API_StartDocumentAnalysis_RequestSyntax) **
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](#API_StartDocumentAnalysis_RequestSyntax) **
Das Amazon SNS SNS-Thema ARN, in dem Amazon Textract den Abschlussstatus des Vorgangs veröffentlichen soll.
Typ: [NotificationChannel](API_NotificationChannel.md) Objekt
Erforderlich: Nein
** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **
Legt fest, ob die Ausgabe an einen vom Kunden definierten Bucket gesendet wird. Standardmäßig speichert Amazon Textract die Ergebnisse intern, auf die der GetDocumentAnalysis Vorgang zugegriffen werden soll.
Typ: [OutputConfig](API_OutputConfig.md) 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](#API_StartDocumentAnalysis_ResponseSyntax) **
Der Bezeichner für den Dokumenttexterkennungs-Auftrag. Verwenden von`JobId`um den Job in einem nachfolgenden Aufruf zu identifizieren`GetDocumentAnalysis`aus. EIN`JobId`Der Wert 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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 **
EIN`ClientRequestToken`Der 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 ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Parameter anfordern. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 (`StartDocumentTextDetection`Wenn Sie beispielsweise eine LimitExceededException -Ausnahme (HTTP-Statuscode: 400) lösen, 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)
# StartDocumentTextDetection
Startet die asynchrone Erkennung von Text in einem Dokument. Amazon Textract kann Textzeilen und Wörter erkennen, aus denen eine Textzeile besteht.
`StartDocumentTextDetection`kann Text in Dokumenten analysieren, die im JPEG-, PNG-, TIFF- und PDF-Format vorliegen. Die Dokumente werden in einem Amazon S3 S3-Bucket gespeichert. Verwenden von[DocumentLocation](API_DocumentLocation.md)um den -Bucket-Namen und den Dateinamen des Dokuments anzugeben.
`StartTextDetection`gibt 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 in`NotificationChannel`aus. Um die Ergebnisse des Texterkennungsvorgangs zu erhalten, überprüfen Sie zunächst, ob der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautet`SUCCEEDED`aus. Wenn ja, ruf an[GetDocumentTextDetection](API_GetDocumentTextDetection.md)und übergeben Sie die Job-ID (`JobId`) vom ersten Anruf an`StartDocumentTextDetection`aus.
Weitere Informationen finden Sie unter[Texterkennung von Dokumenten](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)aus.
## 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](#API_StartDocumentTextDetection_RequestSyntax) **
Das idempotente Token, das verwendet wird, um die Startanfrage zu identifizieren. Wenn Sie dasselbe Token mit mehreren verwenden`StartDocumentTextDetection`Anfragen, das gleiche`JobId`wird zurückgegeben. Verwenden von`ClientRequestToken`um zu verhindern, dass derselbe Job versehentlich mehr als einmal gestartet wird. Weitere Informationen finden Sie unter[Asynchrone Operationen von Amazon Textract aufrufen](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)aus.
Type: String (Zeichenfolge)
Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.
Pattern: `^[a-zA-Z0-9-_]+$`
: Erforderlich Nein
** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) **
Der Speicherort des zu verarbeitenden Dokuments.
Typ: [DocumentLocation](API_DocumentLocation.md) Objekt
: Erforderlich Ja
** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **
Eine Kennung, die Sie angeben, die in der zum Amazon SNS SNS-Thema veröffentlichten Abschlussbenachrichtigung enthalten ist. Sie können beispielsweise die Datei verwenden`JobTag`um 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](#API_StartDocumentTextDetection_RequestSyntax) **
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](#API_StartDocumentTextDetection_RequestSyntax) **
Das Amazon SNS SNS-Thema ARN, in dem Amazon Textract den Abschlussstatus des Vorgangs veröffentlichen soll.
Typ: [NotificationChannel](API_NotificationChannel.md) Objekt
: Erforderlich Nein
** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **
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](API_OutputConfig.md) 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](#API_StartDocumentTextDetection_ResponseSyntax) **
Die Kennung des Texterkennungsauftrags für das Dokument. Verwenden von`JobId`um den Job in einem nachfolgenden Aufruf zu identifizieren`GetDocumentTextDetection`aus. EIN`JobId`Wert 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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 **
EIN`ClientRequestToken`Der 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 ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 (`StartDocumentTextDetection`lö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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection)
# StartExpenseAnalysis
Startet die asynchrone Analyse von Rechnungen oder Belegen für Daten wie Kontaktinformationen, gekaufte Artikel und Kreditorennamen.
`StartExpenseAnalysis`kann Text in Dokumenten analysieren, die im JPEG-, PNG- und PDF-Format vorliegen. Die Dokumente müssen in einem Amazon S3 S3-Bucket gespeichert werden. Verwenden der[DocumentLocation](API_DocumentLocation.md)Parameter, um den Namen Ihres S3-Buckets und den Namen des Dokuments in diesem Bucket anzugeben.
`StartExpenseAnalysis`gibt eine Job-ID zurück (`JobId`) die Sie zur Verfügung stellen`GetExpenseAnalysis`um die Ergebnisse der Operation abzurufen. Wenn die Analyse der Eingaberechnungen/Quittungen abgeschlossen ist, veröffentlicht Amazon Textract einen Abschlussstatus für das Thema Amazon Simple Notification Service (Amazon SNS), das Sie dem`NotificationChannel`aus. Um die Ergebnisse des Rechnungs- und Empfangsanalysevorgangs zu erhalten, stellen Sie sicher, dass der im Amazon SNS SNS-Thema veröffentlichte Statuswert lautet`SUCCEEDED`aus. Wenn ja, ruf an[GetExpenseAnalysis](API_GetExpenseAnalysis.md)und übergeben Sie die Job-ID (`JobId`) das wurde von Ihrem Anruf an zurückgegeben`StartExpenseAnalysis`aus.
Weitere Informationen finden Sie unter[Rechnungen und Belege analysieren](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html)aus.
## 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](#API_StartExpenseAnalysis_RequestSyntax) **
Das idempotente Token, das verwendet wird, um die Startanfrage zu identifizieren. Wenn Sie dasselbe Token mit mehreren verwenden`StartDocumentTextDetection`Anfragen, das gleiche`JobId`wird zurückgegeben. Verwenden von`ClientRequestToken`um zu verhindern, dass derselbe Job versehentlich mehr als einmal gestartet wird. Weitere Informationen finden Sie unter[Asynchrone Operationen von Amazon Textract aufrufen](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)
Type: String (Zeichenfolge)
Einschränkungen der Länge: Mindestlänge 1. Höchstlänge = 64 Zeichen.
Pattern: `^[a-zA-Z0-9-_]+$`
Erforderlich. Nein
** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) **
Der Speicherort des zu verarbeitenden Dokuments.
Typ: [DocumentLocation](API_DocumentLocation.md) Objekt
Erforderlich. Ja
** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **
Eine von Ihnen angegebene Kennung, die in der zum Amazon SNS SNS-Thema veröffentlichten Abschlussbenachrichtigung enthalten ist. Sie können beispielsweise die Datei verwenden`JobTag`um 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](#API_StartExpenseAnalysis_RequestSyntax) **
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](#API_StartExpenseAnalysis_RequestSyntax) **
Das Amazon SNS SNS-Thema ARN, in dem Amazon Textract den Abschlussstatus des Vorgangs veröffentlichen soll.
Typ: [NotificationChannel](API_NotificationChannel.md) Objekt
Erforderlich. Nein
** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **
Legt fest, ob die Ausgabe an einen vom Kunden definierten Bucket gesendet wird. Standardmäßig speichert Amazon Textract die Ergebnisse intern, auf die von der`GetExpenseAnalysis`verwenden.
Typ: [OutputConfig](API_OutputConfig.md) 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](#API_StartExpenseAnalysis_ResponseSyntax) **
Eine eindeutige Kennung für den Texterkennungsauftrag. Die`JobId`wird zurückgegeben von`StartExpenseAnalysis`aus. EIN`JobId`Wert 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 unter[Hard Limits in Amazon Textract](limits.md)aus.
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 **
EIN`ClientRequestToken`Der 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 ein`InvalidParameterException`Ausnahme tritt auf, wenn keiner der`S3Object`oder`Bytes`Werte werden im`Document`Anforderungsparameter. 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Informationen zur Problembehebung finden Sie unter[Fehlerbehebung für Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 (`StartDocumentTextDetection`Wenn Sie beispielsweise eine LimitExcedeDException-Ausnahme (HTTP-Statuscode: 400) aus, bis die Anzahl der gleichzeitig ausgeführten Aufträge unter dem Amazon-Textract-Service-Limit liegt.
HTTP-Statuscode: 400
** ProvisionedThroughputExceededException **
Die Anzahl der Anforderungen hat das Durchsatzlimit überschritten. Wenn Sie dieses Limit erhöhen möchten, 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS-SDK für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)