@aws-sdk/client-textract
Advanced tools
AWS SDK for JavaScript Textract Client for Node.js, Browser and React Native
@aws-sdk/client-textract is an AWS SDK for JavaScript package that allows developers to interact with Amazon Textract, a service that automatically extracts text and data from scanned documents. This package provides methods to analyze documents, detect text, and extract structured data from forms and tables.
Detect Document Text
This feature allows you to detect text in a document. The code sample demonstrates how to use the DetectDocumentTextCommand to extract text from a document provided as a byte array.
const { TextractClient, DetectDocumentTextCommand } = require('@aws-sdk/client-textract');
const client = new TextractClient({ region: 'us-west-2' });
const params = {
Document: {
Bytes: Buffer.from('...') // Replace with your document bytes
}
};
const run = async () => {
try {
const data = await client.send(new DetectDocumentTextCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Analyze Document
This feature allows you to analyze a document for tables and forms. The code sample demonstrates how to use the AnalyzeDocumentCommand to extract structured data from a document provided as a byte array.
const { TextractClient, AnalyzeDocumentCommand } = require('@aws-sdk/client-textract');
const client = new TextractClient({ region: 'us-west-2' });
const params = {
Document: {
Bytes: Buffer.from('...') // Replace with your document bytes
},
FeatureTypes: ['TABLES', 'FORMS']
};
const run = async () => {
try {
const data = await client.send(new AnalyzeDocumentCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Start Document Text Detection
This feature allows you to start an asynchronous job to detect text in a document stored in an S3 bucket. The code sample demonstrates how to use the StartDocumentTextDetectionCommand to initiate the text detection process.
const { TextractClient, StartDocumentTextDetectionCommand } = require('@aws-sdk/client-textract');
const client = new TextractClient({ region: 'us-west-2' });
const params = {
DocumentLocation: {
S3Object: {
Bucket: 'your-bucket-name',
Name: 'your-document-name'
}
}
};
const run = async () => {
try {
const data = await client.send(new StartDocumentTextDetectionCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Tesseract.js is a JavaScript library that provides optical character recognition (OCR) capabilities. It can extract text from images and scanned documents. Unlike @aws-sdk/client-textract, which is a cloud-based service, Tesseract.js runs entirely in the browser or on the server, making it a good choice for offline applications.
ocr-space-api-wrapper is a Node.js wrapper for the OCR.space API, which provides OCR capabilities for extracting text from images and PDFs. Similar to @aws-sdk/client-textract, it is a cloud-based service, but it offers a different set of features and pricing models.
pdf2json is a Node.js library that extracts text and metadata from PDF files. While it does not offer the same level of structured data extraction as @aws-sdk/client-textract, it is useful for basic text extraction from PDFs.
AWS SDK for JavaScript Textract Client for Node.js, Browser and React Native.
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
To install the this package, simply type add or install @aws-sdk/client-textract using your favorite package manager:
npm install @aws-sdk/client-textractyarn add @aws-sdk/client-textractpnpm add @aws-sdk/client-textractThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the TextractClient and
the commands you need, for example ListAdaptersCommand:
// ES5 example
const { TextractClient, ListAdaptersCommand } = require("@aws-sdk/client-textract");
// ES6+ example
import { TextractClient, ListAdaptersCommand } from "@aws-sdk/client-textract";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new TextractClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListAdaptersCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-textract";
const client = new AWS.Textract({ region: "REGION" });
// async/await.
try {
const data = await client.listAdapters(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listAdapters(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listAdapters(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-textract package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.635.0 (2024-08-20)
FAQs
AWS SDK for JavaScript Textract Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-textract receives a total of 403,966 weekly downloads. As such, @aws-sdk/client-textract popularity was classified as popular.
We found that @aws-sdk/client-textract demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.