Obter status da análise do documento

Retrieve the status of an Amazon Textract document analysis job using the Get Document Analysis Status activity.

A atividade Get Document Analysis Status usa a API GetDocumentAnalysis do Amazon Textract para recuperar de forma assíncrona o status de um trabalho de análise de documentos existente ou executado anteriormente (JobId).

After retrieving the document analysis, the activity returns the job status as a String value that you can use as a condition to run other activities (for example, Get Document Analysis).

To avoid overloading the Amazon Textract service with requests, it's recommended that you implement a delay between each execution of this activity (for example, add the Get Document Analysis Status and a Delay activity inside a Do While activity - see example section below)

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o momento do design (ou seja, as dependências da atividade e propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas de Configuração .
2. Adicione a atividade Amazon Scope ao seu projeto.
3. Add an activity or run an external process that outputs a JobId value (for example, Start Document Analysis).
4. Adicione o Get Document Analysis Status dentro da atividade Amazon Scope .
5. Insira valores para as propriedades de Entrada .
6. Crie e insira uma variável String para sua propriedade Saída .
7. Execute a atividade.

   • Suas propriedades de entrada são enviadas para a API GetDocumentAnalysis .

   • A API retorna o valor String para sua variável de propriedade de saída.

     

Propriedades

Os valores para as seguintes propriedades são especificados ao adicionar esta atividade ao seu projeto no UiPath Studio.

Comum

NomeDeExibição

O nome de exibição da atividade.

Atributos	Detalhes
Tipo	String
Required	Sim
Valor padrão	Get Document Analysis Status
Valores permitidos	Insira uma variável String ou String .
Observações	N/A

Entrada

JobId

O identificador atribuído ao processo de análise do documento que você deseja recuperar.

Atributos	Detalhes
Tipo	String
Required	Não (recomendado se você planejar usar os dados de saída em atividades subsequentes)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String
Observações	Para obter o valor String JobId , use um processo ou atividade externa que inclua o valor de JobID em sua saída (por exemplo, Start Document Analysis ou chamada de API externa).

Diversos

Particular

Se selecionado, os valores das variáveis e argumentos não são mais registrados no nível Verbose.

Atributos	Detalhes
Tipo	Caixa de seleção
Required	Não
Valor padrão	não selecionado
Valores permitidos	Selecionado ou Não Selecionado
Observações	N/A

Saída

JobStatus

O status do JobId especificado.

Atributos	Detalhes
Tipo	String
Required	Não (recomendado se você planejar usar os dados de saída em atividades subsequentes)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String
Observações	Há quatro valores de status possíveis: IN_PROGRESS com sucesso Falha PARTIAL_SUCCESS

Exemplo

A imagem a seguir mostra um exemplo do relacionamento de dependência de atividade e valores de propriedade de entrada/saída.

Para obter instruções passo a passo e exemplos, consulte os guias de Início rápido .