Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
# Operazioni
Sono supportate le operazioni seguenti:
+ [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
Analizza un documento di input per individuare relazioni tra gli elementi rilevati.
I tipi di informazioni restituite sono i seguenti:
+ Dati del modulo (coppie chiave-valore). Le informazioni correlate vengono restituite in due[Block](API_Block.md)oggetti, ciascuno di tipo`KEY_VALUE_SET`: KEY`Block`oggetto e un VALORE`Block`oggetto. Ad esempio:*Nome: Ana Silva Carolina*contiene una chiave e un valore. *Nome:*è la chiave. *Ana Silva Carolina*è il valore.
+ Dati delle celle di tabella e tabella. UNA TABELLA`Block`object contiene informazioni su una tabella rilevata. CELLA`Block`l'oggetto viene restituito per ogni cella di una tabella.
+ Linee e parole di testo. RIGA`Block`object contiene una o più WORD`Block`objects. Tutte le righe e le parole rilevate nel documento vengono restituite (incluso il testo che non ha una relazione con il valore di`FeatureTypes`).
Elementi di selezione come caselle di controllo e pulsanti di opzione (pulsanti di opzione) possono essere rilevati nei dati del modulo e nelle tabelle. UN ELEMENTO SELECTION\$1ELEMENT`Block`object contiene informazioni su un elemento di selezione, incluso lo stato della selezione.
È possibile scegliere il tipo di analisi da eseguire specificando il`FeatureTypes`elenco.
L'output viene restituito in un elenco di`Block`objects.
`AnalyzeDocument`è un'operazione sincrona. Per analizzare i documenti in modo asincrono, utilizzare[StartDocumentAnalysis](API_StartDocumentAnalysis.md).
Per ulteriori informazioni, consulta[Analisi del testo dei documenti](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintassi della richiesta
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "string" ],
"HumanLoopConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"FlowDefinitionArn": "string",
"HumanLoopName": "string"
}
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [Document](#API_AnalyzeDocument_RequestSyntax) **
Il documento di input come byte con codifica base64 o un oggetto Amazon S3. Se usi la CLI di AWS per chiamare le operazioni di Amazon Textract, non puoi passare byte immagine. Il documento deve essere un'immagine in formato JPEG, PNG, PDF o TIFF.
Se utilizzi un SDK AWS per chiamare Amazon Textract, potrebbe non essere necessario codificare in base a 64 byte immagine che vengono passati utilizzando il`Bytes`.
Tipo: [Document](API_Document.md) oggetto
: Sì
** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **
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 a`FeatureTypes`. Tutte le righe e le parole rilevate nel documento sono incluse nella risposta (incluso il testo che non è correlato al valore di`FeatureTypes`).
Type: Gamma di stringhe
Valori validi: ` TABLES | FORMS`
: Sì
** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **
Imposta la configurazione per il flusso di lavoro umano in loop per l'analisi dei documenti.
Tipo: [HumanLoopConfig](API_HumanLoopConfig.md) oggetto
: No
## Sintassi della risposta
```
{
"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"
}
}
```
## 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.
** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **
La versione del modello utilizzata per analizzare il documento.
Type: Stringa
** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **
Gli elementi rilevati e analizzati da`AnalyzeDocument`.
Type: Matrice di[Block](API_Block.md)oggetti
** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **
Metadati sul documento analizzato. Un esempio è il numero di pagine.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **
Mostra i risultati della valutazione umana nel ciclo.
Tipo: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) oggetto
## 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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
** HumanLoopQuotaExceededException **
Indica che hai superato il numero massimo di flussi di lavoro di loop attivi disponibili
Codice di stato HTTP: 400
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidParameterException **
Un parametro di input ha violato un vincolo. Ad esempio, nelle operazioni sincrone, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso ad Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument)
# AnalyzeExpense
`AnalyzeExpense`analizza in modo sincrono un documento di input per le relazioni finanziarie tra testo.
Le informazioni vengono restituite come`ExpenseDocuments`e separato come segue.
+ `LineItemGroups`- Un set di dati contenente`LineItems`che memorizzano informazioni sulle righe di testo, come un articolo acquistato e il suo prezzo su una ricevuta.
+ `SummaryFields`- Contiene tutte le altre informazioni di una ricevuta, come le informazioni sull'intestazione o il nome del fornitore.
## Sintassi della richiesta
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [Document](#API_AnalyzeExpense_RequestSyntax) **
Il documento di input, sia come byte che come oggetto S3.
È possibile trasmettere i byte di immagine a un'operazione API di Amazon Textract utilizzando la`Bytes`proprietà. Ad esempio, è possibile utilizzare la`Bytes`proprietà per passare un documento caricato da un file system locale. Byte immagine passati usando il`Bytes`la proprietà deve essere codificata in base64. Il codice potrebbe non aver bisogno di codificare i byte dei file dei documenti se utilizzi un SDK AWS per chiamare le operazioni dell'API Amazon Textract.
È possibile trasmettere le immagini archiviate in un bucket S3 a un'operazione API Amazon Textract di utilizzando la`S3Object`proprietà. I documenti archiviati in un bucket S3 non devono essere codificati con Base64.
La regione AWS per il bucket S3 contenente l'oggetto S3 deve corrispondere alla regione AWS utilizzata per le operazioni Amazon Textract.
Se si utilizza AWS CLI per richiamare le operazioni Amazon Textract, la trasmissione dei byte di immagine utilizzando la proprietà Bytes non è supportata. È necessario prima caricare il documento in un bucket Amazon S3, quindi richiamare l'operazione utilizzando la proprietà S3Object.
Per consentire ad Amazon Textract di elaborare un oggetto S3, l'utente deve disporre dell'autorizzazione per accedere all'oggetto S3.
Tipo: [Document](API_Document.md) oggetto
Campo obbligatorio: Sì
## Sintassi della risposta
```
{
"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"
}
}
]
}
]
}
```
## 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.
** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **
Informazioni sul documento di input.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **
Le spese rilevate da Amazon Textract.
Type: Matrice di[ExpenseDocument](API_ExpenseDocument.md)oggetti
## 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
Codice di stato HTTP: 400
** DocumentTooLargeException **
Il documento non può essere elaborato perché è troppo grande. La dimensione massima dei documenti per le 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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidParameterException **
Un parametro di input ha violato un vincolo. Ad esempio, nelle operazioni sincrone, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro di richiesta. Convalida il parametro prima di richiamare nuovamente l'operazione API.
Codice di stato HTTP: 400
** InvalidS3ObjectException **
Amazon Textract non è in grado di accedere all'oggetto S3 specificato nella richiesta. Per ulteriori informazioni,[Configura l'accesso ad Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 è supportata. 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense)
# AnalyzeID
Analizza i documenti di identità alla ricerca di informazioni pertinenti. Queste informazioni vengono estratte e restituite come`IdentityDocumentFields`, che registra sia il campo normalizzato che il valore del testo estratto.A differenza di altre operazioni di Amazon Textract,`AnalyzeID`non restituisce alcun dato Geometry.
## Sintassi della richiesta
```
{
"DocumentPages": [
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
]
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [DocumentPages](#API_AnalyzeID_RequestSyntax) **
Il documento che viene passato ad AnalyzeID.
Type: Matrice di[Document](API_Document.md)oggetti
Membri dell'array: Numero minimo di 1 elemento. Numero massimo di 2 elementi.
campo obbligatorio Sì
## Sintassi della risposta
```
{
"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"
}
}
]
}
]
}
```
## 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.
** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **
La versione dell'API AnalyzeIdentity utilizzata per elaborare i documenti.
Type: Stringa
** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **
Informazioni sul documento di input.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **
L'elenco dei documenti elaborati da AnalyzeID. Include un numero che indica la loro posizione nell'elenco e la struttura di risposta per il documento.
Type: Matrice di[IdentityDocument](API_IdentityDocument.md)oggetti
## 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidParameterException **
Un parametro di input ha violato un vincolo. Ad esempio, nelle operazioni sincrone, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID)
# DetectDocumentText
Rileva il testo nel documento di input. Amazon Textract è in grado di rilevare le righe di testo e le parole che costituiscono una riga di testo. Il documento di input deve essere un'immagine in formato JPEG, PNG, PDF o TIFF.`DetectDocumentText`restituisce il testo rilevato in una matrice di[Block](API_Block.md)oggetti.
Ogni pagina del documento ha come associato`Block`di tipo PAGE. Ogni PAGINA`Block`object è il padre di LINE`Block`oggetti che rappresentano le righe del testo rilevato in una pagina. RIGA DI`Block`object è un genitore per ogni parola che compone la riga. Le parole sono rappresentate da`Block`oggetti di tipo WORD.
`DetectDocumentText`è un'operazione sincrona. Per analizzare i documenti in modo asincrono, utilizzare[StartDocumentTextDetection](API_StartDocumentTextDetection.md).
Per ulteriori informazioni, consulta[Rilevamento del documento](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintassi della richiesta
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [Document](#API_DetectDocumentText_RequestSyntax) **
Il documento di input come byte con codifica base64 o un oggetto Amazon S3. Se usi la CLI di AWS per chiamare le operazioni di Amazon Textract, non puoi passare byte immagine. Il documento deve essere un'immagine in formato JPEG o PNG.
Se utilizzi un SDK AWS per chiamare Amazon Textract, potrebbe non essere necessario codificare in base a 64 byte immagine che vengono passati utilizzando il`Bytes`.
Tipo: [Document](API_Document.md) oggetto
Campo obbligatorio: Sì
## Sintassi della risposta
```
{
"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
}
}
```
## 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.
** [Blocks](#API_DetectDocumentText_ResponseSyntax) **
Una matrice di`Block`oggetti che contengono il testo rilevato nel documento.
Type: Array di[Block](API_Block.md)oggetti
** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **
Type: Stringa
** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **
Metadati sul documento. Contiene il numero di pagine rilevate nel documento.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
## 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidParameterException **
Un parametro di input ha violato un vincolo. Ad esempio, nelle operazioni sincrone, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText)
# GetDocumentAnalysis
Ottiene i risultati di un'operazione asincrona Amazon Textract che analizza il testo in un documento.
Si avvia l'analisi asincrona del testo chiamando[StartDocumentAnalysis](API_StartDocumentAnalysis.md), che restituisce un identificatore di lavoro (`JobId`). Al termine dell'operazione di analisi del testo, Amazon Textract pubblica uno stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS) registrato nella chiamata iniziale a`StartDocumentAnalysis`. Per ottenere i risultati dell'operazione di rilevamento del testo, verificare innanzitutto che il valore di stato pubblicato nell'argomento Amazon SNS sia`SUCCEEDED`. Se è così, chiama`GetDocumentAnalysis`e passa l'identificativo del processo (`JobId`) dalla chiamata iniziale a`StartDocumentAnalysis`.
`GetDocumentAnalysis`restituisce una matrice di[Block](API_Block.md)oggetti. Vengono restituiti i seguenti tipi di informazioni:
+ Dati di modulo (coppie chiave-valore). Le informazioni correlate vengono restituite in due[Block](API_Block.md)oggetti, ciascuno di tipo`KEY_VALUE_SET`: KEY`Block`oggetto e un VALORE`Block`oggetto. Ad esempio:*Nome: Ana Silva Carolina*contiene una chiave e un valore. *Nome:*è la chiave. *Ana Silva Carolina*è il valore.
+ Dati delle celle di tabella e tabella. UNA TABELLA`Block`object contiene informazioni su una tabella rilevata. CELLA`Block`l'oggetto viene restituito per ogni cella di una tabella.
+ Linee e parole di testo. RIGA`Block`l'oggetto contiene una o più WORD`Block`oggetti. Vengono restituite tutte le righe e le parole rilevate nel documento (incluso il testo che non ha una relazione con il valore del`StartDocumentAnalysis` `FeatureTypes`parametro di input).
Elementi di selezione come caselle di controllo e pulsanti di opzione (pulsanti di opzione) possono essere rilevati nei dati del modulo e nelle tabelle. UN ELEMENTO SELECTION\$1ELEMENT`Block`object contiene informazioni su un elemento di selezione, incluso lo stato della selezione.
Utilizzo dell'`MaxResults`parametro per limitare il numero di blocchi restituiti. Se ci sono più risultati di quelli specificati in`MaxResults`, il valore di`NextToken`nella risposta dell'operazione contiene un token di impaginazione per ottenere il successivo set di risultati. Per visualizzare la pagina di risultati successiva, chiama`GetDocumentAnalysis`e popolare`NextToken`parametro request con il valore del token restituito dalla chiamata precedente a`GetDocumentAnalysis`.
Per ulteriori informazioni, consulta[Analisi del testo del documento](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintassi della richiesta
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **
Identificatore univoco per il processo di rilevamento del testo. La`JobId`restituisce da`StartDocumentAnalysis`. UN`JobId`Il 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-_]+$`
Campo obbligatorio: Sì
** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **
Numero massimo di risultati da restituire per ogni chiamata impaginata. Il valore maggiore che puoi specificare è 1.000. Se si specifica un valore maggiore di 1.000, vengono restituiti al massimo 1.000 risultati. Il valore predefinito è 1,000.
Type: Numero intero
Intervallo valido: Valore minimo di 1.
Campo obbligatorio: No
** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **
Se la risposta precedente era incompleta (perché ci sono più blocchi da recuperare), Amazon Textract restituisce un token di impaginazione nella risposta. È possibile utilizzare questo token di impaginazione per recuperare il successivo set di blocchi.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
Campo obbligatorio: No
## Sintassi della risposta
```
{
"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 ]
}
]
}
```
## 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.
** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **
Type: Stringa
** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **
I risultati dell'operazione di analisi testuale.
Type: Matrice di[Block](API_Block.md)oggetti
** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **
Informazioni su un documento elaborato da Amazon Textract.`DocumentMetadata`viene restituito in ogni pagina delle risposte impaginate da un'operazione video di Amazon Textract.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **
Lo stato corrente del processo di rilevamento del testo.
Type: Stringa
Valori validi: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **
Se la risposta viene troncata, Amazon Textract restituisce questo token. È possibile utilizzare questo token nella richiesta seguente per recuperare il successivo set di risultati di rilevamento del testo.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **
Restituisce se non è stato possibile completare il processo di rilevamento. Contiene una spiegazione per quale errore si è verificato.
Type: Stringa
** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **
Un elenco di avvisi verificati durante l'operazione di analisi del documento.
Type: Matrice di[Warning](API_Warning.md)oggetti
## 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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidJobIdException **
È stato passato un identificatore di lavoro non valido[GetDocumentAnalysis](#API_GetDocumentAnalysis)o a[GetDocumentAnalysis](#API_GetDocumentAnalysis).
Codice di stato HTTP: 400
** 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro di 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 ad Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis)
# GetDocumentTextDetection
Ottiene i risultati di un'operazione asincrona Amazon Textract che rileva il testo in un documento. Amazon Textract è in grado di rilevare le righe di testo e le parole che costituiscono una riga di testo.
Si avvia il rilevamento asincrono del testo chiamando[StartDocumentTextDetection](API_StartDocumentTextDetection.md), che restituisce un identificatore di lavoro (`JobId`). Al termine dell'operazione di rilevamento del testo, Amazon Textract pubblica uno stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS) registrato nella chiamata iniziale a`StartDocumentTextDetection`. Per ottenere i risultati dell'operazione di rilevamento del testo, verificare innanzitutto che il valore di stato pubblicato nell'argomento Amazon SNS sia`SUCCEEDED`. Se è così, chiama`GetDocumentTextDetection`e passa l'identificativo del processo (`JobId`) dalla chiamata iniziale a`StartDocumentTextDetection`.
`GetDocumentTextDetection`restituisce una matrice di[Block](API_Block.md)oggetti.
Ogni pagina del documento è associata`Block`di tipo PAGE. Ogni PAGINA`Block`object è il padre di LINE`Block`oggetti che rappresentano le righe del testo rilevato in una pagina. RIGA`Block`object è un genitore per ogni parola che compone la riga. Le parole sono rappresentate da`Block`oggetti di tipo WORD.
Utilizza il parametro MaxResults per limitare il numero di blocchi restituiti. Se ci sono più risultati di quelli specificati in`MaxResults`, il valore di`NextToken`nella risposta operativa contiene un token di impaginazione per ottenere il successivo set di risultati. Per visualizzare la pagina di risultati successiva, chiama`GetDocumentTextDetection`e popolare il campo obbligatorio`NextToken`parametro request con il valore del token restituito dalla chiamata precedente a`GetDocumentTextDetection`.
Per ulteriori informazioni, consulta[Rilevamento del testo documento](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintassi della richiesta
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **
Identificatore univoco per il processo di rilevamento del testo. La`JobId`viene restituito da`StartDocumentTextDetection`. UN`JobId`il 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-_]+$`
Campo obbligatorio: Sì
** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **
Numero massimo di risultati da restituire per ogni chiamata impaginata. Il valore maggiore che puoi specificare è 1.000. Se si specifica un valore maggiore di 1.000, vengono restituiti al massimo 1.000 risultati. Il valore predefinito è 1,000.
Type: Numero intero
Intervallo valido: Valore minimo di 1.
Campo obbligatorio: No
** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **
Se la risposta precedente era incompleta (perché ci sono più blocchi da recuperare), Amazon Textract restituisce un token di impaginazione nella risposta. È possibile utilizzare questo token di impaginazione per recuperare il successivo set di blocchi.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
Campo obbligatorio: No
## Sintassi della risposta
```
{
"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 ]
}
]
}
```
## 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.
** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **
I risultati dell'operazione di rilevamento del testo.
Type: Array di[Block](API_Block.md)oggetti
** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **
Type: Stringa
** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **
Informazioni su un documento elaborato da Amazon Textract.`DocumentMetadata`viene restituito in ogni pagina delle risposte impaginate da un'operazione video di Amazon Textract.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **
Lo stato corrente del processo di rilevamento del testo.
Type: Stringa
Valori validi: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **
Se la risposta viene troncata, Amazon Textract restituisce questo token. È possibile utilizzare questo token nella richiesta seguente per recuperare il successivo set di risultati del rilevamento del testo.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **
Restituisce se non è stato possibile completare il processo di rilevamento. Contiene una spiegazione per quale errore si è verificato.
Type: Stringa
** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **
Un elenco di avvisi verificati durante l'operazione di rilevamento del testo per il documento.
Type: Array di[Warning](API_Warning.md)oggetti
## 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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidJobIdException **
È stato passato un identificatore di lavoro non valido[GetDocumentAnalysis](API_GetDocumentAnalysis.md)o a[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Codice di stato HTTP: 400
** 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection)
# GetExpenseAnalysis
Ottiene i risultati di un'operazione asincrona Amazon Textract che analizza fatture e ricevute. Amazon Textract trova le informazioni di contatto, gli articoli acquistati e il nome del fornitore, dalle fatture di input e dalle ricevute.
Si avvia l'analisi asincrona di fattura/ricevuta chiamando[StartExpenseAnalysis](API_StartExpenseAnalysis.md), che restituisce un identificatore di lavoro (`JobId`). Al termine dell'analisi di fattura/ricevuta, Amazon Textract pubblica lo stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS). Questo argomento deve essere registrato nella chiamata iniziale a`StartExpenseAnalysis`. Per ottenere i risultati dell'operazione di analisi fattura/ricevuta, accertati prima che il valore di stato pubblicato nell'argomento Amazon SNS sia.`SUCCEEDED`. Se è così, chiama`GetExpenseAnalysis`e passa l'identificativo del processo (`JobId`) dalla chiamata iniziale a`StartExpenseAnalysis`.
Utilizza il parametro MaxResults per limitare il numero di blocchi restituiti. Se ci sono più risultati di quelli specificati in`MaxResults`, il valore di`NextToken`nella risposta operativa contiene un token di impaginazione per ottenere il successivo set di risultati. Per visualizzare la pagina di risultati successiva, chiama`GetExpenseAnalysis`e popolare il`NextToken`parametro request con il valore del token restituito dalla chiamata precedente a`GetExpenseAnalysis`.
Per ulteriori informazioni, consulta[Analisi di fatture e ricevute](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html).
## Sintassi della richiesta
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parametri della richiesta
La richiesta accetta i seguenti dati in formato JSON.
** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **
L'identificatore univoco per il processo di rilevamento del testo. La`JobId`viene restituito da`StartExpenseAnalysis`. UN`JobId`il 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-_]+$`
Campo obbligatorio: Sì
** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **
Numero massimo di risultati da restituire per ogni chiamata impaginata. Il valore maggiore che puoi specificare è 20. Se si specifica un valore maggiore di 20, vengono restituiti al massimo 20 risultati. Il valore predefinito è 20.
Type: Numero intero
Intervallo valido: Valore minimo di 1.
Campo obbligatorio: No
** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **
Se la risposta precedente era incompleta (perché ci sono più blocchi da recuperare), Amazon Textract restituisce un token di impaginazione nella risposta. È possibile utilizzare questo token per recuperare il successivo set di blocchi.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
Campo obbligatorio: No
## Sintassi della risposta
```
{
"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 ]
}
]
}
```
## 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.
** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **
La versione attuale del modello di AnalyzeExpense.
Type: Stringa
** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **
Informazioni su un documento elaborato da Amazon Textract.`DocumentMetadata`viene restituito in ogni pagina delle risposte impaginate da un'operazione Amazon Textract.
Tipo: [DocumentMetadata](API_DocumentMetadata.md) oggetto
** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **
Le spese rilevate da Amazon Textract.
Type: Matrice di[ExpenseDocument](API_ExpenseDocument.md)oggetti
** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **
Lo stato corrente del processo di rilevamento del testo.
Type: Stringa
Valori validi: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **
Se la risposta viene troncata, Amazon Textract restituisce questo token. È possibile utilizzare questo token nella richiesta seguente per recuperare il successivo set di risultati di rilevamento del testo.
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 255.
Modello: `.*\S.*`
** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **
Restituisce se non è stato possibile completare il processo di rilevamento. Contiene una spiegazione per quale errore si è verificato.
Type: Stringa
** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **
Un elenco di avvisi verificati durante l'operazione di rilevamento del testo per il documento.
Type: Matrice di[Warning](API_Warning.md)oggetti
## 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
** InternalServerError **
Amazon Textract ha riscontrato un problema del servizio. Riprova la chiamata.
Codice di stato HTTP: 500
** InvalidJobIdException **
È stato passato un identificatore di lavoro non valido[GetDocumentAnalysis](API_GetDocumentAnalysis.md)o a[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Codice di stato HTTP: 400
** 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso ad Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis)
# 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.
`StartDocumentAnalysis`può analizzare il testo nei documenti in formato JPEG, PNG, TIFF e PDF. I documenti vengono archiviati in un bucket Amazon S3. Utilizza[DocumentLocation](API_DocumentLocation.md)per specificare il nome del file e del bucket.
`StartDocumentAnalysis`restituisce 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 in`NotificationChannel`. Per ottenere i risultati dell'operazione di analisi del testo, verificare innanzitutto che il valore di stato pubblicato nell'argomento Amazon SNS sia`SUCCEEDED`. Se è così, chiama[GetDocumentAnalysis](API_GetDocumentAnalysis.md)e passa l'identificativo del processo (`JobId`) dalla chiamata iniziale a`StartDocumentAnalysis`.
Per ulteriori informazioni, consulta[Analisi del testo di un documento](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## 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](#API_StartDocumentAnalysis_RequestSyntax) **
Il token idempotente utilizzato per identificare la richiesta iniziale. Se usi lo stesso token con più`StartDocumentAnalysis`richieste, le stesse`JobId`restituisce. Utilizza`ClientRequestToken`per evitare che lo stesso lavoro venga avviato accidentalmente più di una volta. Per ulteriori informazioni, consulta[Chiamata di Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.
Modello: `^[a-zA-Z0-9-_]+$`
: campo obbligatorio No
** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) **
La posizione del documento da elaborare.
Tipo: [DocumentLocation](API_DocumentLocation.md) oggetto
: campo obbligatorio Sì
** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **
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 a`FeatureTypes`. Tutte le righe e le parole rilevate nel documento sono incluse nella risposta (incluso il testo che non è correlato al valore di`FeatureTypes`).
Type: Gamma di stringhe
Valori validi: ` TABLES | FORMS`
: campo obbligatorio Sì
** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **
Identificativo specificato incluso nella notifica di completamento pubblicata sull'argomento Amazon SNS. Ad esempio, è possibile utilizzare`JobTag`per 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](#API_StartDocumentAnalysis_RequestSyntax) **
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](#API_StartDocumentAnalysis_RequestSyntax) **
Argomento Amazon SNS su cui desideri che Amazon Textract pubblichi lo stato di completamento dell'operazione.
Tipo: [NotificationChannel](API_NotificationChannel.md) oggetto
: campo obbligatorio No
** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **
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](API_OutputConfig.md) 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](#API_StartDocumentAnalysis_ResponseSyntax) **
Identificatore per il processo di rilevamento del testo del documento. Utilizza`JobId`per identificare il processo in una successiva chiamata a`GetDocumentAnalysis`. UN`JobId`Il 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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 **
UN`ClientRequestToken`Il 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)
# StartDocumentTextDetection
Avvia il rilevamento asincrono di testo in un documento. Amazon Textract è in grado di rilevare le righe di testo e le parole che costituiscono una riga di testo.
`StartDocumentTextDetection`può analizzare il testo nei documenti in formato JPEG, PNG, TIFF e PDF. I documenti vengono archiviati in un bucket Amazon S3. Utilizza[DocumentLocation](API_DocumentLocation.md)per specificare il nome del file e del bucket.
`StartTextDetection`restituisce un identificatore di lavoro (`JobId`) utilizzato per ottenere i risultati dell'operazione. Al termine del rilevamento del testo, Amazon Textract pubblica uno stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS) specificato in`NotificationChannel`. Per ottenere i risultati dell'operazione di rilevamento del testo, verificare innanzitutto che il valore di stato pubblicato nell'argomento Amazon SNS sia`SUCCEEDED`. Se è così, chiama[GetDocumentTextDetection](API_GetDocumentTextDetection.md)e passa l'identificativo del processo (`JobId`) dalla chiamata iniziale a`StartDocumentTextDetection`.
Per ulteriori informazioni, consulta[Rilevamento del testo](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintassi della richiesta
```
{
"ClientRequestToken": "string",
"DocumentLocation": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "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](#API_StartDocumentTextDetection_RequestSyntax) **
Il token idempotente utilizzato per identificare la richiesta iniziale. Se usi lo stesso token con più`StartDocumentTextDetection`richieste, le stesse`JobId`viene restituito. Utilizza`ClientRequestToken`per evitare che lo stesso lavoro venga avviato accidentalmente più di una volta. Per ulteriori informazioni, consulta[Chiamata di Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.
Modello: `^[a-zA-Z0-9-_]+$`
Campo obbligatorio No
** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) **
La posizione del documento da elaborare.
Tipo: [DocumentLocation](API_DocumentLocation.md) oggetto
Campo obbligatorio Sì
** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **
Identificativo specificato incluso nella notifica di completamento pubblicata sull'argomento Amazon SNS. Ad esempio, è possibile utilizzare`JobTag`per 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](#API_StartDocumentTextDetection_RequestSyntax) **
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](#API_StartDocumentTextDetection_RequestSyntax) **
Argomento Amazon SNS su cui desideri che Amazon Textract pubblichi lo stato di completamento dell'operazione.
Tipo: [NotificationChannel](API_NotificationChannel.md) oggetto
Campo obbligatorio No
** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **
Imposta se l'output andrà a un bucket definito dal cliente. Per impostazione predefinita, Amazon Textract salverà i risultati internamente per accedere con l'operazione GetDocumentTextDetection.
Tipo: [OutputConfig](API_OutputConfig.md) 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](#API_StartDocumentTextDetection_ResponseSyntax) **
Identificatore del processo di rilevamento del testo per il documento. Utilizza`JobId`per identificare il processo in una successiva chiamata a`GetDocumentTextDetection`. UN`JobId`il 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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 **
UN`ClientRequestToken`Il 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro di 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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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. Se desideri 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection)
# StartExpenseAnalysis
Avvia l'analisi asincrona di fatture o ricevute per dati quali informazioni di contatto, articoli acquistati e nomi dei fornitori.
`StartExpenseAnalysis`può analizzare il testo nei documenti in formato JPEG, PNG e PDF. I documenti devono essere archiviati in un bucket Amazon S3. Utilizzo dell'[DocumentLocation](API_DocumentLocation.md)parametro per specificare il nome del bucket S3 e il nome del documento in quel bucket.
`StartExpenseAnalysis`restituisce un identificatore di lavoro (`JobId`) che fornirai`GetExpenseAnalysis`per recuperare i risultati dell'operazione. Al termine dell'analisi delle fatture/delle ricevute di input, Amazon Textract pubblica uno stato di completamento nell'argomento Amazon Simple Notification Service (Amazon SNS) fornito al`NotificationChannel`. Per ottenere i risultati dell'operazione di analisi della fattura e della ricevuta, assicurarsi che il valore dello stato pubblicato nell'argomento Amazon SNS sia`SUCCEEDED`. Se è così, chiama[GetExpenseAnalysis](API_GetExpenseAnalysis.md)e passa l'identificativo del processo (`JobId`) che è stato restituito dalla tua chiamata a`StartExpenseAnalysis`.
Per ulteriori informazioni, consulta[Analisi di fatture e ricevute](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html).
## Sintassi della richiesta
```
{
"ClientRequestToken": "string",
"DocumentLocation": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "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](#API_StartExpenseAnalysis_RequestSyntax) **
Il token idempotente utilizzato per identificare la richiesta iniziale. Se usi lo stesso token con più`StartDocumentTextDetection`richieste, le stesse`JobId`restituisce. Utilizza`ClientRequestToken`per evitare che lo stesso lavoro venga avviato accidentalmente più di una volta. Per ulteriori informazioni, consulta[Chiamata di Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)
Type: Stringa
Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.
Modello: `^[a-zA-Z0-9-_]+$`
: campo obbligatorio No
** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) **
La posizione del documento da elaborare.
Tipo: [DocumentLocation](API_DocumentLocation.md) oggetto
: campo obbligatorio Sì
** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **
Identificativo specificato incluso nella notifica di completamento pubblicata sull'argomento Amazon SNS. Per esempio, è possibile utilizzare`JobTag`per 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](#API_StartExpenseAnalysis_RequestSyntax) **
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](#API_StartExpenseAnalysis_RequestSyntax) **
Argomento Amazon SNS su cui desideri che Amazon Textract pubblichi lo stato di completamento dell'operazione.
Tipo: [NotificationChannel](API_NotificationChannel.md) oggetto
: campo obbligatorio No
** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **
Imposta se l'output andrà a un bucket definito dal cliente. Per impostazione predefinita, Amazon Textract salverà i risultati internamente per accedere al`GetExpenseAnalysis`operazione.
Tipo: [OutputConfig](API_OutputConfig.md) 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](#API_StartExpenseAnalysis_ResponseSyntax) **
Un identificativo univoco per il processo di rilevamento del testo. La`JobId`restituisce da`StartExpenseAnalysis`. UN`JobId`è 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, consulta[Limiti rigidi per Amazon Textract](limits.md).
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 **
UN`ClientRequestToken`Il 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, un`InvalidParameterException`eccezione si verifica quando nessuno dei due`S3Object`o`Bytes`i valori sono forniti nel`Document`parametro 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. Per ulteriori informazioni,[Configura l'accesso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Per informazioni sulla risoluzione dei problemi, consulta[Risoluzione dei problemi Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK AWS per .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK AWS per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK AWS per Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK AWS per JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK AWS per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)