sight-client

License	Apache-2.0
Categories	CLI User Interface
GroupId	io.github.ashwinbhaskar
ArtifactId	sight-client_0.23
Last Version	0.1.1
Release Date	May 7, 2020
Type	jar
Description	sight-client sight-client
Project URL	https://github.com/ashwinbhaskar/sight-dotty
Project Organization	io.github.ashwinbhaskar
Source Code Management	https://github.com/ashwinbhaskar/sight-dotty

Download sight-client_0.23

Filename	Size
sight-client_0.23-0.1.1.pom
sight-client_0.23-0.1.1.jar	138 KB
sight-client_0.23-0.1.1-sources.jar	18 KB
sight-client_0.23-0.1.1-javadoc.jar	189 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.ashwinbhaskar/sight-client_0.23/ -->
<dependency>
    <groupId>io.github.ashwinbhaskar</groupId>
    <artifactId>sight-client_0.23</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.ashwinbhaskar/sight-client_0.23/
implementation 'io.github.ashwinbhaskar:sight-client_0.23:0.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.ashwinbhaskar/sight-client_0.23/
implementation ("io.github.ashwinbhaskar:sight-client_0.23:0.1.1")

Apache Buildr

'io.github.ashwinbhaskar:sight-client_0.23:jar:0.1.1'

Apache Ivy

<dependency org="io.github.ashwinbhaskar" name="sight-client_0.23" rev="0.1.1">
  <artifact name="sight-client_0.23" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.ashwinbhaskar', module='sight-client_0.23', version='0.1.1')
)

Scala SBT

libraryDependencies += "io.github.ashwinbhaskar" % "sight-client_0.23" % "0.1.1"

Leiningen

[io.github.ashwinbhaskar/sight-client_0.23 "0.1.1"]

Dependencies

compile (6)

Group / Artifact	Type	Version
ch.epfl.lamp : dotty-library_0.23	jar	0.23.0
org.scalameta : munit_0.23	jar	0.7.5
com.softwaremill.sttp.client : core_2.13	jar	2.0.4
com.softwaremill.sttp.client : circe_2.13	jar	2.0.4
org.typelevel : cats-core_2.13	jar	2.0.0
commons-codec : commons-codec	jar	1.9

Project Modules

There are no modules declared in this project.

sight-dotty

Dotty client library for Sight APIs. The Sight API is a text recognition service.

Usage Dotty 0.22, 0.23, 0.24

Dependency

libraryDependencies += "io.github.ashwinbhaskar" %% "sight-client" % "0.1.1"

API Key

Grap an APIKey from the Sight Dashboard

Code

1. One Shot: If your files contain a lot of pages then this will take some time as this will return only after all the pages have been processed. Use the function recognize as shown below.

   import sight.client.SightClient
   import sight.types.APIKey
   import sight.models.{Error, Pages}
   
   val apiKey: Either[Error, APIKey] = APIKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
   val files: Seq[String] = Seq("/user/john.doe/foo.pdf","/user/john.doe/baz/bmp")
   val result: Either[Error, Pages] = apiKey.flatMap(key => SightClient(key).recognize(files))
   
   import sight.extensions.pageOps
   
   val allTxt: Either[Error, Seq[String]] = result.map(_.allText)
   val allTxtGt: Either[Error, Seq[String]] = result.map(_.allTextWithConfidenceGreaterThan(0.2))
   

2. Stream: You can choose to get pages as and when they are processed. So this returns a LazySequence which can be consumed as a bunch of pages are processed. Use the function recognizeStream as shown below.

   import sight.types.APIKey
   import sight.models.{Error, Page}
   import sight.client.SightClient
   
   val apiKey: Either[Error, APIKey] = APIKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
   val files = Seq("/user/john.doe/foo.pdf","/user/john.doe/baz/bmp")Downloads/flight-euro.pdf")
   apiKey match
       case Right(k) => 
           val result: LazyList[Either[Error, Seq[Page]]] = SightClient(k).recognizeStream(files)
           result.foreach(println)
       case Left(error) => println(e)
   

Official API Documentation

Here is the official API Documentation

Usage in Scala 2.13

There is an an going work on tasty reader for Scala 2.13 (https://github.com/scalacenter/scala/tree/tasty_reader) which can recompile the tasty to Scala 2.13. Until that work is completed, I believe this library cannot be used in scala 2.13.

Versions

Version
0.1.1 May 7, 2020