Class: Mindee::HTTP::MindeeApiV2

Inherits:
Object
  • Object
show all
Defined in:
lib/mindee/http/mindee_api_v2.rb

Overview

API client for version 2.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key: nil) ⇒ MindeeApiV2

Returns a new instance of MindeeApiV2.

Parameters:

  • api_key (String, nil) (defaults to: nil) 


16
17
18
 
# File 'lib/mindee/http/mindee_api_v2.rb', line 16

def initialize(api_key: nil)
  @settings = ApiSettingsV2.new(api_key: api_key)
end

Instance Attribute Details

#settings ⇒ ApiSettingsV2 (readonly)

Returns:



13
14
15
 
# File 'lib/mindee/http/mindee_api_v2.rb', line 13

def settings
  @settings
end

Instance Method Details

#req_get_inference(inference_id) ⇒ Mindee::Parsing::V2::InferenceResponse

Retrieves a queued inference.

Parameters:

  • inference_id (String)

Returns:



39
40
41
42
43
44
45
 
# File 'lib/mindee/http/mindee_api_v2.rb', line 39

def req_get_inference(inference_id)
  @settings.check_api_key
  response = inference_result_req_get(
    inference_id
  )
  Parsing::V2::InferenceResponse.new(process_response(response))
end

#req_get_job(job_id) ⇒ Mindee::Parsing::V2::JobResponse

Retrieves a queued job.

Parameters:

  • job_id (String)

Returns:



51
52
53
54
55
56
57
 
# File 'lib/mindee/http/mindee_api_v2.rb', line 51

def req_get_job(job_id)
  @settings.check_api_key
  response = inference_job_req_get(
    job_id
  )
  Parsing::V2::JobResponse.new(process_response(response))
end

#req_post_inference_enqueue(input_source, params) ⇒ Mindee::Parsing::V2::JobResponse

Sends a file to the inference queue.

Parameters:

Returns:

Raises:

  • (Mindee::Errors::MindeeHttpErrorV2) 


26
27
28
29
30
31
32
33
 
# File 'lib/mindee/http/mindee_api_v2.rb', line 26

def req_post_inference_enqueue(input_source, params)
  @settings.check_api_key
  response = enqueue(
    input_source,
    params
  )
  Parsing::V2::JobResponse.new(process_response(response))
end