Ruby REST API for OMR Processing
Aspose.OMR for Cloud is a REST API that helps you to perform optical mark recognition in the cloud. We provide a series of SDKs. Along with that, you can get binaries to start working immediately and recognize various OMR forms.
Developers can embed optical recognition in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using Aspose.OMR API in your project.
OMR Processing Features
- Perform recognition of scanned photos and images for OMR operations.
- Ability to perform OMR on rotated & perspective (within 25 deg) photos.
- Extract & recognize human-marked data from scanned tests, exams, surveys, etc.
- Supports the export of OMR results to CSV file format.
- Use textual markup to generate OMR templates, generate surveys, and test sheets.
- Availability of GUI application for managing OMR templates.
- Specify the number of OMR based questions & answers in the template.
- Availability of GUI OMR editor as a cloud client.
- Provide JSON rules to perform OMR answer grading.
- Clip an area of interest from an image, save it as JPEG & perform OMR on it.
- Perform highly accurate optical mark recognition (OMR).
Save OMR As
CSV
Read OMR Formats
JPEG, PNG, BMP, TIFF, PDF
Quickstart
You can perform tasks out of the box without writing a single line of code with our GUI client. You can also refer to the client documentation.
Using OMR Cloud API in your Ruby projects
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.1
- Package version: 18.8.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen
Requirements
Ruby 2.3 and later
Installation
Clone repository
Clone aspose-omr-cloud
with submodules:
git clone https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby.git --recurse-submodules
Build a gem
To build the Ruby code into a gem:
gem build aspose_omr_cloud.gemspec
Then either install the gem locally:
gem install ./aspose_omr_cloud-18.8.0.gem
(for development, run gem install --dev ./aspose_omr_cloud-18.8.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'aspose_omr_cloud', '~> 18.8.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby, then add the following in the Gemfile:
gem 'aspose_omr_cloud', :git => 'https://github.com/aspose-omr-cloud/aspose-omr-cloud-ruby.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Optional requirements
To take full advantage of Aspose.OMR for Cloud, aspose/storage-sdk-ruby is required. Just run gem install aspose_storage_cloud
. You may refer to official Aspose Storage SDK to get more information.
Usage
Receive Cloud Keys
Aspose.Cloud credentials are required to use Aspose.OMR for Cloud API. You can acquire App SID and App Key by registrating at Aspose Cloud Dashboard. It will take only a couple of minutes.
Update submodule
Make sure you've cloned aspose-omr-cloud-demo-data submodule, that contains all data required to run demo. In case you are missing submodules use the following git commands to initialize and update them:
git submodule init
git submodule update --remote --merge
Code example
You can check out OMR Demo project to get started with Aspose.OMR for Cloud.
Documentation for API Endpoints
All URIs are relative to https://api.aspose.cloud/v1.1
Class | Method | HTTP request | Description |
---|---|---|---|
AsposeOmrCloud::OmrApi | post_run_omr_task | POST /omr/{name}/runOmrTask | Run specific OMR task |
Documentation for Models
- AsposeOmrCloud::AsposeResponse
- AsposeOmrCloud::FileInfo
- AsposeOmrCloud::OMRFunctionParam
- AsposeOmrCloud::OMRResponseDetails
- AsposeOmrCloud::OmrResponseContent
- AsposeOmrCloud::OmrResponseInfo
- AsposeOmrCloud::Payload
- AsposeOmrCloud::RecognitionStatistics
- AsposeOmrCloud::ServerStat
- AsposeOmrCloud::OMRResponse
Authentication
Library uses OAUTH2 internally
Aspose.OMR Cloud SDKs in Popular Languages
.NET | Java | PHP | Python | Ruby | Node.js |
---|---|---|---|---|---|
GitHub | GitHub | GitHub | GitHub | GitHub | GitHub |
NuGet | Maven | Composer | PIP | GEM | NPM |
Product Page | Documentation | API Reference | Code Samples | Blog | Free Support | Free Trial|