This repository contains the official Sight API Clojure client. The Sight API is a text recognition service.

Quickstart

Add this project as a dependency.

Leiningen/Boot:

[sight "1.1.0"]

Clojure CLI/deps.edn:

sight {:mvn/version "1.1.0"}

Gradle

compile 'sight:sight:1.1.0

Maven

<dependency>
  <groupId>sight</groupId>
  <artifactId>sight</artifactId>
  <version>1.1.0</version>
</dependency>

Require or import the package. For example, add it to :require:

(ns my-namespace
  ...
  (:require [sight.core :as sight]))

Grab an API key from the Sight dashboard.
Create a client, passing your API key into the constructor, and recognize text:

(let [client (sight/->Client "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
      files  ["invoice.pdf" "receipt.png"]]
  (sight/recognize client files))

The returned value of (sight/recognize client files) looks like this:

{:pages [{:error "",
          :file-index 0,
          :page-number 1,
          :number-of-pages-in-file 1,
          :recognized-text [{:top-left-y 193,
                             :bottom-right-y 243,
                             :bottom-left-x 152,
                             :top-right-x 500,
                             :bottom-left-y 248,
                             :top-right-y 188,
                             :top-left-x 151,
                             :bottom-right-x 501,
                             :confidence 0.10092532855610954,
                             :text "Dummy PDF file"}]}]}

Word-Level Bounding Boxes

recognize has an additional signature with a third parameter, word-level-bounding-boxes. If it's true then word-level bounding boxes are returned instead of sentence-level bounding boxes. E.g.,

(sight/recognize client (list "invoice.pdf" "receipt.png") true)
(sight/recognize client (list "invoice.pdf" "receipt.png") true)

Streaming Results as Pages are Processed

When (sight/recognize ...) is called, it polls a URL and aggregates the results over time. Finally, when all results are collected, the function returns.

It is possible to use results immediately as they come in, instead of waiting for all results to be collected. To do this, use the recognize-stream function.

The recognize-stream uses Adam Bard's Failjure library: Instead of throwing exceptions, recognize-stream returns a failjure/failure.

Example

Users must define failure-func and success-func in the following code snippet:

(:require [failjure.core :as f])

(defn process [pages]
  (->> pages
    (map (fn [p]
      (if (f/failed? p)
        (failure-func (f/message p))
        (success-func p)))))

(let [client (->Client "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")]
  (->> (recognize-stream client (list "receipt.pdf" "invoice.png"))
    (run! process)))

Official API Documentation

Here is the official documentation for the Sight API.

Apache V2 License

This code is licensed under Apache V2.0. The full text of the license can be found in the "LICENSE" file.

Lead Maintainer

Ashwin Bhaskar

siftrics / sight-clojure