Module: CloudmersiveDocumentaiApiClient

Defined in:
lib/cloudmersive-documentai-api-client/version.rb,
lib/cloudmersive-documentai-api-client.rb,
lib/cloudmersive-documentai-api-client/api_error.rb,
lib/cloudmersive-documentai-api-client/api_client.rb,
lib/cloudmersive-documentai-api-client/configuration.rb,
lib/cloudmersive-documentai-api-client/api/analyze_api.rb,
lib/cloudmersive-documentai-api-client/api/extract_api.rb,
lib/cloudmersive-documentai-api-client/models/field_value.rb,
lib/cloudmersive-documentai-api-client/models/policy_rule.rb,
lib/cloudmersive-documentai-api-client/models/sub_document.rb,
lib/cloudmersive-documentai-api-client/models/table_result.rb,
lib/cloudmersive-documentai-api-client/api/run_batch_job_api.rb,
lib/cloudmersive-documentai-api-client/models/field_to_extract.rb,
lib/cloudmersive-documentai-api-client/models/table_result_row.rb,
lib/cloudmersive-documentai-api-client/models/table_result_cell.rb,
lib/cloudmersive-documentai-api-client/models/document_categories.rb,
lib/cloudmersive-documentai-api-client/models/extracted_text_page.rb,
lib/cloudmersive-documentai-api-client/models/field_advanced_value.rb,
lib/cloudmersive-documentai-api-client/models/extract_text_response.rb,
lib/cloudmersive-documentai-api-client/models/policy_rule_violation.rb,
lib/cloudmersive-documentai-api-client/models/document_policy_result.rb,
lib/cloudmersive-documentai-api-client/models/extracted_barcode_item.rb,
lib/cloudmersive-documentai-api-client/models/document_policy_request.rb,
lib/cloudmersive-documentai-api-client/models/extract_fields_response.rb,
lib/cloudmersive-documentai-api-client/models/extract_tables_response.rb,
lib/cloudmersive-documentai-api-client/models/split_document_response.rb,
lib/cloudmersive-documentai-api-client/models/document_question_boolean.rb,
lib/cloudmersive-documentai-api-client/models/document_questions_request.rb,
lib/cloudmersive-documentai-api-client/models/summarize_document_response.rb,
lib/cloudmersive-documentai-api-client/models/extract_barcodes_ai_response.rb,
lib/cloudmersive-documentai-api-client/models/document_question_answer_item.rb,
lib/cloudmersive-documentai-api-client/models/document_question_choice_item.rb,
lib/cloudmersive-documentai-api-client/models/document_classification_result.rb,
lib/cloudmersive-documentai-api-client/models/advanced_extract_fields_request.rb,
lib/cloudmersive-documentai-api-client/models/document_question_free_response.rb,
lib/cloudmersive-documentai-api-client/models/document_question_answers_result.rb,
lib/cloudmersive-documentai-api-client/models/extract_fields_advanced_response.rb,
lib/cloudmersive-documentai-api-client/models/document_question_multiple_choice.rb,
lib/cloudmersive-documentai-api-client/models/extract_document_batch_job_result.rb,
lib/cloudmersive-documentai-api-client/models/extract_document_job_status_result.rb,
lib/cloudmersive-documentai-api-client/models/extract_fields_and_tables_response.rb,
lib/cloudmersive-documentai-api-client/models/advanced_extract_classification_request.rb,
lib/cloudmersive-documentai-api-client/models/document_advanced_classification_result.rb

Overview

#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.

OpenAPI spec version: v1 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.14

Defined Under Namespace

Classes: AdvancedExtractClassificationRequest, AdvancedExtractFieldsRequest, AnalyzeApi, ApiClient, ApiError, Configuration, DocumentAdvancedClassificationResult, DocumentCategories, DocumentClassificationResult, DocumentPolicyRequest, DocumentPolicyResult, DocumentQuestionAnswerItem, DocumentQuestionAnswersResult, DocumentQuestionBoolean, DocumentQuestionChoiceItem, DocumentQuestionFreeResponse, DocumentQuestionMultipleChoice, DocumentQuestionsRequest, ExtractApi, ExtractBarcodesAiResponse, ExtractDocumentBatchJobResult, ExtractDocumentJobStatusResult, ExtractFieldsAdvancedResponse, ExtractFieldsAndTablesResponse, ExtractFieldsResponse, ExtractTablesResponse, ExtractTextResponse, ExtractedBarcodeItem, ExtractedTextPage, FieldAdvancedValue, FieldToExtract, FieldValue, PolicyRule, PolicyRuleViolation, RunBatchJobApi, SplitDocumentResponse, SubDocument, SummarizeDocumentResponse, TableResult, TableResultCell, TableResultRow

Constant Summary collapse

VERSION =
'2.2.1'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

CloudmersiveDocumentaiApiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



69
70
71
72
73
74
75
# File 'lib/cloudmersive-documentai-api-client.rb', line 69

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end