APIs

AWS

AWS

El módulo AWS es responsable de acciones que integran la herramienta Amazon Web Service.

Métodos

Textract

Método responsable de reconocer y obtener los caracteres que existen en una imagen indicada por el usuario utilizando la herramienta Textract de Amazon Web Service. Por ejemplo: si en la imagen indicada por el usuario existe la palabra "Roberty", esta acción intentará reconocerla carácter por carácter y devolverlos.

js

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 obligatorios

• useCustomCredentials: Boolean - espera un valor booleano que representará si se utilizará o no una credencial personalizada.
• credentials: Object - en caso de que en useCustomCredentials se pase el valor true, este parámetro se vuelve obligatorio. Espera un objeto que contenga el valor de accessKeyID: String y secretAccessKey: String.
• featureType: String[] - espera un array de strings con al menos uno de los siguientes valores: FORMS, TABLES, QUERIES.
• queries: String[] - en caso de que en featureType se pase el valor QUERIES, este parámetro se vuelve obligatorio. Espera un array de strings con una pregunta que deberá ser respondida por el análisis del documento.
• bucket: String - espera el nombre del Bucket creado en S3 para almacenar los archivos temporalmente.
• filePath: String - espera un string para indicar la ruta en la que está guardado el archivo.
• timeout: Number - espera un valor en segundos para indicar el tiempo máximo de espera para que el elemento sea reconocido. Si no se pasa, el valor predeterminado es 120 segundos.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

La constante o variable creada, como la textract del ejemplo mostrado anteriormente, recibirá un valor del tipo Lista que dará acceso a las siguientes propiedades:

• textract.words: Array - Devuelve todas las palabras encontradas por el análisis.
• textract.lines: Array - Devuelve todas las líneas de palabras encontradas por el análisis.
• textract.forms: Array - Devuelve la información obtenida durante el análisis como formularios de información.
• textract.tables: Array - Devuelve las tablas encontradas durante el análisis.
• textract.queries: Array - Devuelve las preguntas y respuestas que fueron hechas y obtenidas por el usuario y el análisis.