Saltar al contenido principal
Roberty Studio
RPAAPIs

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["v2_0_0"]({
filePath: `C:\\Roberty\\documento.pdf`,
featureType: ["FORMS", "TABLES", "QUERIES"],
queries: [`Qual a data de vencimento?`],
pageRanges: `1-3`,
credentials: {
accessKeyId: `asd`,
secretAccessKey: `dsa`,
},
region: `us-east-1`,
bucket: `qwe`,
timeout: 120,
});

Parámetros obligatorios​

  • filePath: String - espera un string para indicar la ruta en la que está guardado el archivo (imagen o PDF). Los archivos PDF se convierten en imágenes, una por página, antes del análisis.
  • featureType: String[] - espera un array de strings con los tipos de análisis deseados: FORMS, TABLES y/o QUERIES. Si se pasa un array vacío ([]), solo se realiza la detección de texto (palabras y líneas).

Parámetros opcionales​

  • queries: String[] - en caso de que en featureType se pase el valor QUERIES, espera un array de strings con las preguntas que deberán ser respondidas por el análisis del documento.
  • pageRanges: String - espera las páginas del PDF a analizar, separadas por comas y/o en intervalos (ej.: 1-3, 5). Si no se pasa, se analizan todas las páginas.
  • credentials: Object - espera un objeto que contenga accessKeyId: String y secretAccessKey: String, con las credenciales de AWS a utilizar.
  • region: String - espera la región de AWS a utilizar. Si no se pasa, el valor predeterminado es us-east-1.
  • bucket: String - espera el nombre del Bucket creado en S3 para almacenar los archivos temporalmente. Recomendado para archivos grandes.
  • timeout: Number - espera un valor en segundos para indicar el tiempo máximo de espera por el análisis. Si no se pasa, el valor predeterminado es 120 segundos.

Retorno​

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

  • textract.content: String - Devuelve todo el texto encontrado, con las líneas separadas por saltos de línea.
  • 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.