optiic
Version:
An advanced free OCR & image recognition API.
188 lines (155 loc) • 6.81 kB
Markdown
<p align="center">
<a href="https://optiic.dev">
<img src="https://cdn.itwcreativeworks.com/assets/optiic/images/logo/optiic-brandmark-black-x.svg" width="100px">
</a>
</p>
<p align="center">
<img src="https://img.shields.io/github/package-json/v/optiic/optiic.svg">
<br>
<img src="https://img.shields.io/librariesio/release/npm/optiic.svg">
<img src="https://img.shields.io/bundlephobia/min/optiic.svg">
<img src="https://img.shields.io/codeclimate/maintainability-percentage/optiic/optiic.svg">
<img src="https://img.shields.io/npm/dm/optiic.svg">
<img src="https://img.shields.io/node/v/optiic.svg">
<img src="https://img.shields.io/website/https/optiic.dev.svg">
<img src="https://img.shields.io/github/license/optiic/optiic.svg">
<img src="https://img.shields.io/github/contributors/optiic/optiic.svg">
<img src="https://img.shields.io/github/last-commit/optiic/optiic.svg">
<br>
<br>
<a href="https://optiic.dev">Site</a> | <a href="https://www.npmjs.com/package/optiic">NPM Module</a> | <a href="https://github.com/optiic/optiic">GitHub Repo</a>
<br>
<br>
<strong>optiic</strong> is the official npm module of <a href="https://optiic.dev">Optiic</a>, a free image recognition & optical character recognition (OCR) API. It works on any image as well as PDFs!
</p>
## 🌐 Optiic Works in Node AND browser environments
Yes, this module works in both Node and browser environments, including compatibility with [Webpack](https://www.npmjs.com/package/webpack) and [Browserify](https://www.npmjs.com/package/browserify)!
## 🦄 Features
* Image recognition and analysis API
* Provide images as URLs or upload them directly
* OCR
* Extract text from the supplied image
* Detect the language of the text
* Support for `.pdf`, `.png`, `.jpeg`, and many more!
### 🔑 Getting an API key
You can use so much of `optiic` for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by [signing up for an account](https://optiic.dev/signup).
## 📦 Install Optiic
### Option 1: Install via npm
Install with npm if you plan to use `optiic` in a Node project or in the browser.
```shell
npm install optiic
```
If you plan to use `optiic` in a browser environment, you will probably need to use [Webpack](https://www.npmjs.com/package/webpack), [Browserify](https://www.npmjs.com/package/browserify), or a similar service to compile it.
```js
const optiic = new (require('optiic'))({
apiKey: 'api_test_key' // Not required, but having one removes limits (get your key at https://optiic.dev).
});
```
Install with CDN if you plan to use Optiic only in a browser environment.
```html
<script src="https://cdn.jsdelivr.net/npm/optiic@latest/dist/index.min.js"></script>
<script type="text/javascript">
let optiic = new Optiic({
apiKey: 'api_test_Key' // Not required, but having one removes limits (get your key at https://optiic.dev).
});
</script>
```
You can use `optiic` in a variety of ways that require no installation, such as `curl` in terminal/shell. See the **Use without installation** section below.
If you want to see how `optiic` works, you can try a sample such as [this image](https://optiic.dev/assets/images/samples/we-love-optiic.png):
<p align="center">
<a href="https://optiic.dev">
<img src="https://optiic.dev/assets/images/samples/we-love-optiic.png" width="100%">
</a>
</p>
This will result in an output like this:
```js
{
text: "We love Optiic!",
language: "en",
}
```
After you have followed the install step, you can start using `optiic` to analyze images and perform OCR from within your app!
Submit and image to process and return the text in the image.
The options for `process(options)` are as follows.
* image `string`, `HTML Input Element`, `File`: The image to be processed. Can be a local path, remote URL, an HTML input, or a File object.
* Acceptable Values: `any`
* Default: `null`
* mode `string`: What type of optical recognition will be run, such as OCR.
* Acceptable Values: `ocr`
* Default: `ocr`
```js
let options = {
image: 'https://optiic.dev/assets/images/samples/we-love-optiic.png', // url of the image
mode: 'ocr', // ocr
};
optiic.process(options)
.then(result => {
console.log(result);
})
```
```js
let options = {
image: '/Users/username/Desktop/my-image.png', // local path to the image
mode: 'ocr', // ocr
};
optiic.process(options)
.then(result => {
console.log(result);
})
```
```html
<form class="" action="" method="post">
<input type="file" name="image" accept="image/*">
<button type="submit">Submit</button>
</form>
<script type="text/javascript">
var myForm = document.querySelector('form');
myForm.addEventListener('submit', function (event) {
event.preventDefault();
optiic.process({
image: myForm.querySelector('input[type="file"]'),
})
.then(response => {
console.log(response);
})
})
</script>
```
```shell
curl \
-d '{"apiKey": "test_api_key", "url": "https://optiic.dev/assets/images/samples/we-love-optiic.png"}' \
-H 'Content-Type: application/json' \
https://api.optiic.dev/process
```
```shell
curl \
-F "apiKey=test_api_key" \
-F "image=@/Users/username/Desktop/my-image.png" \
https://api.optiic.dev/process
```
[](https://optiic.dev) that helps you analyze images and perform OCR (optical character recognition)!
For a more in-depth documentation of this library and the Optiic service, please visit the official Optiic website.
If you are still having difficulty, we would love for you to post
a question to [the Optiic issues page](https://github.com/optiic/optiic/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
[](https://somiibo.com/): A Social Media Bot with an open-source module library. <br>
[](https://jekyllup.com/): A website devoted to sharing the best Jekyll themes. <br>
[](https://slapform.com/): A backend processor for your HTML forms on static sites. <br>
[](https://app.soundgrail.com/): A resource for producers, musicians, and DJs. <br>
[](https://hammockreport.com/): An API for exploring and listing backyard products. <br>
Ask us to have your project listed! :)