Class: CloudmersiveOcrApiClient::ReceiptsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReceiptsApi 



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/api/receipts_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/receipts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Convert a photo of a receipt into a CSV file containing structured information from the receipt Leverage Deep Learning to automatically turn a photo of a receipt into a CSV file containing the structured information from the receipt.



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

def receipts_photo_to_csv(image_file, opts = {})
  data, _status_code, _headers = receipts_photo_to_csv_with_http_info(image_file, opts)
  return data
end

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

Convert a photo of a receipt into a CSV file containing structured information from the receipt Leverage Deep Learning to automatically turn a photo of a receipt into a CSV file containing the structured information from the receipt.



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/receipts_api.rb', line 38

def receipts_photo_to_csv_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.receipts_photo_to_csv ..."
  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 ReceiptsApi.receipts_photo_to_csv"
  end
  # resource path
  local_var_path = "/ocr/receipts/photo/to/csv"

  # 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: ReceiptsApi#receipts_photo_to_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end