/java

Java binding for the Rosette API

Primary LanguageJavaApache License 2.0Apache-2.0

Build Status Maven Central

Java client binding for Rosette API

Installation

If you use Maven, include this dependency in your pom.xml:

<dependency>
    <groupId>com.basistech.rosette</groupId>
    <artifactId>rosette-api</artifactId>
    <version>${rosette.api.java.binding.version}</version>
</dependency>

where ${rosette.api.java.binding.version} is the latest version available from Maven Central.

The version will change as new versions of the binding are released. Note that versions of the form x.y.Nxx, where N is greater than 100, are internal testing versions; do not use them without consultation with Basis Technology Corp.

If the version you are using is not the latest from Maven Central. Please check for its compatibilty with api.rosette.com. If you have an on-premise version of Rosette API server, please contact support for binding compatibility with your installation.

The source code on the master branch is the current state of development; it is not recommended for general use. If you prefer to build from source, please use an appropriate release tag.

Basic Usage

To check out more examples, see examples

API Documentation

Check out the documentation

Release Notes

See the Wiki.

Docker

A Docker image for running the examples against the compiled source library is available on Docker Hub.

Command: docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-java

Additional environment settings: -e ALT_URL=<alternative URL> -e FILENAME=<single filename>

Additional Information

For more, visit Rosette API site