Skip to main content

AWS

O módulo AWS é responsável por ações que integram a ferramenta Amazon Web Service.

Métodos​

Textract​

Método responsável por reconhecer e obter os caracteres que existem em uma imagem passada pelo usuário utilizando a ferramenta Textract da Amazon Web Service. Por exemplo: Se na imagem passada pelo usuário existir a palavra "Roberty", esta ação tentará reconhecer caractere por caractere e retorná-los.

const textract = await API.AWS.textract["v1_0_0"]({ 
    useCustomCredentials: true,
    credentials: { 
        accessKeyId: `asd`, 
        secretAccessKey: `dsa`, 
    }, 
    featureType: ["FORMS", "TABLES", "QUERIES"], 
    queries: [`Qual a data de vencimento?`], 
    bucket: `qwe`, 
    filePath: `C:\\Roberty`, 
    timeout: 120, 
});

Parâmetros obrigatórios​

  • useCustomCredentials: Boolean - espera um valor booleano que representará se será utilizado ou não uma credencial customizada.
  • credentials: Object - caso em useCustomCredentials seja passado o valor true, esse parâmetro se torna obrigatório. Espera um objeto contendo o valor de accessKeyID: String e secretAccessKey: String.
  • featureType: String[] - espera um array de strings com pelo menos um dos seguintes valores: FORMS, TABLES, QUERIES.
  • queries: String[] - caso em featureType seja passado o valor QUERIES, esse parâmetro se torna obrigatório. Espera um array de strings com uma pergunta que deverá ser respondida pela análise do documento.
  • bucket: String - espera o nome do Bucket criado na S3 para armazenar os arquivos temporariamente.
  • filePath: String - espera uma string para indicar o caminho em que o arquivo está salvo.
  • timeout: Number - espera um valor em segundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 120 segundos.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a textract do exemplo mostrado anteriormente, receberá um valor do tipo Lista que dará acesso as seguintes propriedades:

  • textract.words: Array - Retorna todas as palavras encontradas pela análise.
  • textract.lines: Array - Retorna todas as linhas de palavras encontradas pela análise.
  • textract.forms: Array - Retorna as informações obtidas durante a análise como formulários de informações.
  • textract.tables: Array - Retorna as tabelas encontradas durante a análise.
  • textract.queries: Array - Retorna perguntas e respostas que foram feitas e obtidas pelo usuário e análise.