MOST Docs
mostValid Generative
Generative Authenticate (Get JWT)
Método para obter um token de autenticação a partir da client key.
:::warning
Para elevar a segurança, utilizamos o padrão JWT, com a implementação de tokens únicas e temporárias. Desta forma será necessário obter um novo token de autenticação para cada requisição.
Ele só poderá ser utilizado uma única vez e seu tempo de expiração é de 10 minutos.
:::
sequenceDiagram
client backend->> authenticate: POST (clientkey)
authenticate--)client backend: Return 200 (bearer token)
client backend->> service route: POST (bearer token, parameters)
service route--)client backend: Return 200 (result content)
box mostValid Generative
participant authenticate
participant service route
end
Generative Content Extraction
Rota assíncrona para extração e complementação de texto de arquivos utilizando Inteligência Artificial Generativa.
O mostValid Generative permite que o cliente receba os dados extraídos de sua imagem de maneira assíncrona em um servidor de sua escolha (servidor de callback).
No término do processo de extração e complementação, é enviada uma requisição com todos os dados extraídos para o servidor do cliente, sinalizando o término do processo assíncrono.
Serão enviadas ao servidor de callback do cliente requisições de dois tipos:
:::highlight blue
- Extração: Mensagem que indica o término do processo e apresenta todos os dados extraídos do arquivo/imagem enviado pelo cliente.
- Alerta: Mensagem que indica o término do processo e que houve alguma falha durante a execução do mesmo.
:::
O produto da rota é um código de processo, processId, único por requisição enviada.
Generative Process Status
Rota para consultar o status do processamento do arquivo enviado na rota de extração do mostValid Generative.
O cliente poderá realizar consultas manuais periodicamente nesta rota até obter o resultado da extração.
:::note
O resultado do processo estará disponível para consulta por um tempo máximo de uma hora após a sua conclusão. Esse período é contado a partir do momento em que a situação do processo é definida como um dos estados finais: FINISHED, CANCELED ou ERROR.
:::
Status do processo
Abaixo tabela com os possíveis status do processo retornado no campo processStatus.
| Nome | Descrição |
|---|---|
| IN_PROCESS | O arquivo enviado está sendo tipificado e processado para verificar se necessita de complementação. |
| CANCELED | Representa que o processo foi cancelado, em um fluxo de múltiplas requisições (operation), devido o processamento de algum outro arquivo em que não foi necessário gerar tarefa OU que houve a abertura de tarefa para outro processo da mesma operation. |
| ERROR | Indica que ocorreu um erro durante uma ou mais etapas do processo. |
| TO_ANALYSIS | O arquivo necessita de complementação e está aguardando para ser analisado. |
| IN_ANALYSIS | O arquivo necessita de complementação e está sendo analisado por um complementador. |
| FINISHED | O arquivo foi analisado com sucesso e retornou o resultado, com complementação ou não. |
Status dos atributos
Abaixo tabela com possíveis status retornados no campo status dos atributos, onde o contexto pode se referir à extração, a seção, ao campo, célula da tabela ou cabeçalho da tabela.
| Status | Descrição |
|---|---|
| MOSTQIIOCR | O item não foi enviado para validação pelo revisor, pois conforme as regras do cliente, a extração feita já é considerada válida. |
| MODIFIED | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente, e o seu conteúdo original foi modificado pelo revisor. |
| UNREADABLE | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente; sendo marcado como ilegível pelo revisor. |
| REVIEWED | O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente, e o seu conteúdo original não foi modificado pelo revisor. |
| DEPRECATED | Trata-se de um item com nome do campo depreciado e que não será exibido no Portal mostValid para análise durante a tarefa de revisão. Recomenda-se considerar os nomes de campos correspondentes atualizados. Confira a listagem atualizada de documentos e respectivos campos aqui. |
Processo de Análise Humana - tarefa de revisão
O processo de análise das tarefas será iniciado após a alteração do processStatus para TO_ANALYSIS, que indicará que o documento foi enviado para análise e está aguardando a avaliação humana do operador no Portal mostValid.
Acessar a tarefa de Revisão
O operador deve realizar o login com suas credenciais e acessar a tarefa através do menu "Tarefas".
Navegar entre documentos e páginas
Para navegar entre documentos a serem revisados utilize as setas na área superior esquerda
Navegue facilmente entre as páginas do documento em revisão.
Revisar ou modificar atributos
Na área lateral direita, são exibidas as seções, campos, tabelas e respectivos dados extraídos pelo mostQI Generative.
Você pode navegar entre os campos clicando diretamente neles ou utilizando os atalhos TAB (navegar para os campos posteriores) e SHIFT + TAB (navegar para os campos anteriores). Na imagem central da página do documento, as áreas utilizadas para a extração do conteúdo serão destacadas.
Também é possível marcar atributos como ilegíveis.
Para revisar as tabelas, clique no título da tabela desejada e selecione "Editar valores". Uma janela flutuante aparecerá com os dados extraídos da tabela. Você pode mover essa janela para a posição desejada, revisar e/ou complementar os dados, marcar células como ilegíveis, além de adicionar ou remover linhas e colunas conforme necessário.
Adicionar seções manualmente
Ao identificar a ausência de alguma seção presente no documento, é possível "Adicionar seção" usando o recurso acessível pelo ícone de seta para baixo ao lado do título de cada seção. Durante a inclusão, você pode escolher se a nova seção será adicionada antes ou depois da seção atual, além de definir o tipo da seção.
Os atributos das seções adicionadas manualmente serão destacados com fundo cinza e contorno azul, diferenciando-se das seções extraídas automaticamente pelo mostQI Generative.
Também é possível remover seções adicionais incluídas.
No resultado final do processo, seja consultado via rota de status ou recebido via webhook após a conclusão da revisão, as seções adicionadas manualmente farão parte do resultado, posicionadas conforme inseridas durante a tarefa de revisão. Seus atributos terão score nulo e status como modified.
Finalizar revisão
Para concluir a revisão atual e avançar para o próximo documento, caso haja mais, clique na seta para a direita localizada no canto superior esquerdo da tela.
Se não houverem mais arquivos para revisão, uma mensagem de confirmação será exibida. Confirme para finalizar as revisões.
Quando a tarefa for concluída, o processStatus será atualizado para finished, e o mostValid disponibilizará, através da rota de status ou via webhook, todos os dados extraídos (value), os dados revisados ou modificados (finalValue), e o status de revisão/modificação para cada campo e célula da tabela.