npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

aws-textract-client

v1.1.1

Published

A comprehensive helper library for AWS Textract, including S3, SNS, and SQS.

Downloads

17

Readme

AWS Textract Client

A helpful class to perform server-sided AWS Textract actions.

Install

npm i aws-textract-client

Features

  • upload documents to S3 bucket
  • create and delete SNS Topics
  • create and delete SQS Queues and subscribe to SNS topic (required for async multi-page processing)
  • various AWS Textract actions
    • Analyze document
    • Detect document
    • Analyze invoices
  • process & simplify results

Example

Create SNS Topic and SQS Queue

Topics and Queue for Textract should start with AmazonTextract!

import { AWSTextractClient } from "aws-textracr-client";

// config contains AWS credentials settings and is used for all client instances
const textractClient = new AWSTextractClient(config);

// create topic and queue once
const topicArn = await textractClient.createTopic("AmazonTextractMyTopic");

const queueUrl = await textractClient.createQueue(
  "AmazonTextractMyQueue",
  topicArn
);

Process Invoce

import { AWSTextractClient } from "aws-textracr-client";

// config contains AWS credentials settings and is used for all client instances
const textractClient = new AWSTextractClient(config);

// set role and topic of notification channel
textractClient.setNotificationChannel(roleArn, topicArn);

// upload document to S3 bucket
await textractClient.uploadDocument(
  S3_BUCKET,
  file,
  createReadStream(pathToYourFile)
);

// process document and get results
const results = await textractClient.processDocument(
  AWSTextractClient.TYPE_EXPENSE,
  S3_BUCKET,
  file,
  queueUrl
);

Results

All results contain up to 3 confidence values, usually for the label and the value and additionally for the pre-trained invoice field mapping.

Additionally you can get the position of the text on the document in form of boundary boxes.

Example response:

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "d15315f4-239b-40d8-87f2-8e2731a31e4c",
    "attempts": 1,
    "totalRetryDelay": 0
  },
  "AnalyzeExpenseModelVersion": "1.0",
  "DocumentMetadata": {
    "Pages": 1
  },
  "ExpenseDocuments": [
    {
      "Blocks": [...],
      "ExpenseIndex": 1,
      "LineItemGroups": [...],
      "SummaryFields": [...]
    }
  ],
  "JobStatus": "SUCCEEDED"
}

The field JobStatus is only present in multi-page processes.

Links