Class: CloudmersiveOcrApiClient::PreprocessingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PreprocessingApi

Returns a new instance of PreprocessingApi.



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#preprocessing_unrotate(image_file, opts = {}) ⇒ Object

Detect and unrotate a document image Detect and unrotate an image of a document (e.g. that was scanned at an angle). Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 28

def preprocessing_unrotate(image_file, opts = {})
  data, _status_code, _headers = preprocessing_unrotate_with_http_info(image_file, opts)
  return data
end

#preprocessing_unrotate_with_http_info(image_file, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Detect and unrotate a document image Detect and unrotate an image of a document (e.g. that was scanned at an angle). Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 38

def preprocessing_unrotate_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_unrotate ..."
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unrotate"
  end
  # resource path
  local_var_path = "/ocr/preprocessing/image/unrotate"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["imageFile"] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unrotate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_unskew(image_file, opts = {}) ⇒ Object

Detect and unskew a photo of a document Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


84
85
86
87
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 84

def preprocessing_unskew(image_file, opts = {})
  data, _status_code, _headers = preprocessing_unskew_with_http_info(image_file, opts)
  return data
end

#preprocessing_unskew_with_http_info(image_file, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Detect and unskew a photo of a document Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 94

def preprocessing_unskew_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_unskew ..."
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unskew"
  end
  # resource path
  local_var_path = "/ocr/preprocessing/image/unskew"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["imageFile"] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unskew\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end