cloudmersive-documentai-api-client

CloudmersiveDocumentaiApiClient - the Ruby gem for the Document AI API

Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI. Also supports handwriting and low quality photos and scans, as well as digital document input. Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 2.2.1
  • Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://www.cloudmersive.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudmersive-documentai-api-client.gemspec

Then either install the gem locally:

gem install ./cloudmersive-documentai-api-client-2.2.1.gem

(for development, run gem install --dev ./cloudmersive-documentai-api-client-2.2.1.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 'cloudmersive-documentai-api-client', '~> 2.2.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cloudmersive-documentai-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cloudmersive-documentai-api-client'

# Setup authorization
CloudmersiveDocumentaiApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersiveDocumentaiApiClient::AnalyzeApi.new

opts = { 
  body: CloudmersiveDocumentaiApiClient::DocumentQuestionsRequest.new # DocumentQuestionsRequest | Input request, including document and questions
}

begin
  #Answer Questions about a Document in a structured way using Advanced AI
  result = api_instance.answer_questions(opts)
  p result
rescue CloudmersiveDocumentaiApiClient::ApiError => e
  puts "Exception when calling AnalyzeApi->answer_questions: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class Method HTTP request Description
CloudmersiveDocumentaiApiClient::AnalyzeApi answer_questions POST /document-ai/document/analyze/answer-questions Answer Questions about a Document in a structured way using Advanced AI
CloudmersiveDocumentaiApiClient::AnalyzeApi apply_rules POST /document-ai/document/analyze/enforce-policy Enforce Policies to a Document to allow or block it using Advanced AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_all_fields_and_tables POST /document-ai/document/extract/all Extract All Fields and Tables of Data from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_barcodes POST /document-ai/document/extract/barcodes Extract Barcodes of from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_classification POST /document-ai/document/extract/classify Extract Classification or Category from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_classification_advanced POST /document-ai/document/extract/classify/advanced Extract Classification or Category from a Document using Advanced AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_fields POST /document-ai/document/extract/fields Extract Field Values from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_fields_advanced POST /document-ai/document/extract/fields/advanced Extract Field Values from a Document using Advanced AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_split POST /document-ai/document/extract/split Intelligently Split a Combined Document into Sub-Documents using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_summary POST /document-ai/document/extract/summary Extract Summary from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_tables POST /document-ai/document/extract/tables Extract Tables of Data from a Document using AI
CloudmersiveDocumentaiApiClient::ExtractApi extract_text POST /document-ai/document/extract/text Extract Text from a Document using AI
CloudmersiveDocumentaiApiClient::RunBatchJobApi extract_all_fields_and_tables_from_document_batch_job POST /document-ai/document/batch-job/extract/all Extract All Fields and Tables of Data from a Document using AI as a Batch Job
CloudmersiveDocumentaiApiClient::RunBatchJobApi extract_classification_from_document_batch_job POST /document-ai/document/batch-job/extract/classify Extract Classification or Category from a Document using AI as a Batch Job
CloudmersiveDocumentaiApiClient::RunBatchJobApi extract_fields_from_document_advanced_batch_job POST /document-ai/document/batch-job/extract/fields/advanced Extract Field Values from a Document using Advanced AI as a Batch Job
CloudmersiveDocumentaiApiClient::RunBatchJobApi extract_text_from_document_batch_job POST /document-ai/document/batch-job/extract/text Extract Text from a Document using AI as a Batch Job
CloudmersiveDocumentaiApiClient::RunBatchJobApi get_async_job_status GET /document-ai/document/batch-job/batch-job/status Get the status and result of an Extract Document Batch Job

Documentation for Models

Documentation for Authorization

Apikey

  • Type: API key
  • API key parameter name: Apikey
  • Location: HTTP header