StartDocumentAnalysis

Avvia l'analisi asincrona di un documento di input per le relazioni tra elementi rilevati come coppie chiave-valore, tabelle ed elementi di selezione.

StartDocumentAnalysispuò analizzare il testo nei documenti in formato JPEG, PNG, TIFF e PDF. I documenti vengono archiviati in un bucket Amazon S3. UtilizzaDocumentLocationper specificare il nome del file e del bucket.

StartDocumentAnalysisrestituisce un identificatore di lavoro (JobId) utilizzato per ottenere i risultati dell'operazione. Al termine dell'analisi del testo, Amazon Textract pubblica uno stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS) specificato inNotificationChannel. Per ottenere i risultati dell'operazione di analisi del testo, verificare innanzitutto che il valore di stato pubblicato nell'argomento Amazon SNS siaSUCCEEDED. Se è così, chiamaGetDocumentAnalysise passa l'identificativo del processo (JobId) dalla chiamata iniziale aStartDocumentAnalysis.

Per ulteriori informazioni, consultaAnalisi del testo di un documento.

Sintassi della richiesta

{
   "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"
   }
}

Parametri della richiesta

La richiesta accetta i seguenti dati in formato JSON.

ClientRequestToken

Il token idempotente utilizzato per identificare la richiesta iniziale. Se usi lo stesso token con piùStartDocumentAnalysisrichieste, le stesseJobIdrestituisce. UtilizzaClientRequestTokenper evitare che lo stesso lavoro venga avviato accidentalmente più di una volta. Per ulteriori informazioni, consultaChiamata di Amazon Textract Asynchronous Operations.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

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

: campo obbligatorio No

DocumentLocation

La posizione del documento da elaborare.

Tipo: DocumentLocation oggetto

: campo obbligatorio Sì

FeatureTypes

Un elenco dei tipi di analisi da eseguire. Aggiungere TABLES all'elenco per restituire informazioni sulle tabelle rilevate nel documento di input. Aggiungi FORMS per restituire i dati del modulo rilevati. Per eseguire entrambi i tipi di analisi, aggiungere TABLES e FORMS aFeatureTypes. Tutte le righe e le parole rilevate nel documento sono incluse nella risposta (incluso il testo che non è correlato al valore diFeatureTypes).

Type: Gamma di stringhe

Valori validi: TABLES | FORMS

: campo obbligatorio Sì

JobTag

Identificativo specificato incluso nella notifica di completamento pubblicata sull'argomento Amazon SNS. Ad esempio, è possibile utilizzareJobTagper identificare il tipo di documento a cui corrisponde la notifica di completamento (ad esempio un modulo fiscale o una ricevuta).

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

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

: campo obbligatorio No

KMSKeyId

La chiave KMS utilizzata per crittografare i risultati dell'inferenza. Può essere in formato Key ID o Key Alias. Quando viene fornita una chiave KMS, la chiave KMS viene utilizzata per la crittografia lato server degli oggetti nel bucket cliente. Quando questo parametro non è abilitato, il risultato sarà crittografato lato server, utilizzando SSE-S3.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

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

: campo obbligatorio No

NotificationChannel

Argomento Amazon SNS su cui desideri che Amazon Textract pubblichi lo stato di completamento dell'operazione.

Tipo: NotificationChannel oggetto

: campo obbligatorio No

OutputConfig

Imposta se l'output andrà a un bucket definito dal cliente. Per impostazione predefinita, Amazon Textract salverà i risultati internamente per accedere dall'operazione GetDocumentAnalysis.

Tipo: OutputConfig oggetto

: campo obbligatorio No

Sintassi della risposta

{
   "JobId": "string"
}

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

JobId

Identificatore per il processo di rilevamento del testo del documento. UtilizzaJobIdper identificare il processo in una successiva chiamata aGetDocumentAnalysis. UNJobIdIl valore è valido solo per 7 giorni.

Type: Stringa

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

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

Errori

AccessDeniedException

Non sei autorizzato a eseguire l'operazione. Utilizzare l'ARN (Amazon Resource Name) di un utente autorizzato o un ruolo IAM per eseguire l'operazione.

Codice di stato HTTP: 400

BadDocumentException

Amazon Textract non è in grado di leggere il documento. Per ulteriori informazioni sui limiti dei documenti in Amazon Textract, consultaLimiti rigidi per Amazon Textract.

Codice di stato HTTP: 400

DocumentTooLargeException

Il documento non può essere elaborato perché è troppo grande. La dimensione massima dei documenti per operazioni sincrone 10 MB. La dimensione massima del documento per le operazioni asincrone è di 500 MB per i file PDF.

Codice di stato HTTP: 400

IdempotentParameterMismatchException

UNClientRequestTokenIl parametro di input è stato riutilizzato con un'operazione, ma almeno uno degli altri parametri di input è diverso dalla precedente chiamata all'operazione.

Codice di stato HTTP: 400

InternalServerError

Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.

Codice di stato HTTP: 500

InvalidKMSKeyException

Indica che non si dispone delle autorizzazioni di decrittografia con la chiave KMS immessa o che la chiave KMS è stata immessa in modo errato.

Codice di stato HTTP: 400

InvalidParameterException

Un parametro di input ha violato un vincolo. Ad esempio, nelle operazioni sincrone, unInvalidParameterExceptioneccezione si verifica quando nessuno dei dueS3ObjectoBytesi valori sono forniti nelDocumentparametro della richiesta. Convalida il parametro prima di chiamare nuovamente l'operazione API.

Codice di stato HTTP: 400

InvalidS3ObjectException

Amazon Textract non è in grado di accedere all'oggetto S3 specificato nella richiesta.Configura l'accesso a Amazon S3Per informazioni sulla risoluzione dei problemi, consultaRisoluzione dei problemi Amazon S3

Codice di stato HTTP: 400

LimitExceededException

Un limite del servizio Amazon Textract è stato superato. Ad esempio, se si avvia troppi processi asincroni contemporaneamente, chiamate per avviare le operazioni (StartDocumentTextDetection, ad esempio) sollevano un'LimitExceededException (codice di stato HTTP: 400) finché il numero di processi simultanei in esecuzione è inferiore al service limit Amazon Textract.

Codice di stato HTTP: 400

ProvisionedThroughputExceededException

Il numero di richieste ha superato il limite di throughput. Per aumentare questo limite, contatta Amazon Textract.

Codice di stato HTTP: 400

ThrottlingException

Amazon Textract non è temporaneamente in grado di elaborare la richiesta. Riprova la chiamata.

Codice di stato HTTP: 500

UnsupportedDocumentException

Il formato del documento di input non è supportato. I documenti per le operazioni possono essere in formato PNG, JPEG, PDF o TIFF.

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue:

• Interfaccia a riga di comando AWS

• SDK AWS per .NET

• SDK AWS per C++

• SDK AWS per Go

• AWSSDK per Java V2

• SDK AWS per JavaScript

• SDK AWS per PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3