Class: Mindee::V1::WorkflowOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mindee/v1/client.rb,
sig/mindee/v1/client.rbs

Overview

Class for configuration options in workflow executions.

without requiring authentication.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params: {}) ⇒ WorkflowOptions

Returns a new instance of WorkflowOptions.

Parameters:

  • params: (Hash[String | Symbol, untyped]) (defaults to: {}) 


76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/mindee/v1/client.rb', line 76

def initialize(params: {})
  params = params.transform_keys(&:to_sym)
  @document_alias = params.fetch(:document_alias, nil)
  @priority = params.fetch(:priority, nil)
  @full_text = params.fetch(:full_text, false)
  @public_url = params.fetch(:public_url, nil)
  @rag = params.fetch(:rag, nil)
  raw_page_options = params.fetch(:page_options, nil)
  raw_page_options = PageOptions.new(params: raw_page_options) unless raw_page_options.is_a?(PageOptions)
  @page_options = raw_page_options
  @close_file = params.fetch(:close_file, true)
end

Instance Attribute Details

#close_file ⇒ Boolean

Returns the value of attribute close_file.

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/mindee/v1/client.rb', line 74

def close_file
  @close_file
end

#document_alias ⇒ String?

Alias to give to the document.

Returns:

  • (String, nil) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mindee/v1/client.rb', line 73

class WorkflowOptions
  attr_accessor :document_alias, :priority, :full_text, :public_url, :page_options, :rag, :close_file

  def initialize(params: {})
    params = params.transform_keys(&:to_sym)
    @document_alias = params.fetch(:document_alias, nil)
    @priority = params.fetch(:priority, nil)
    @full_text = params.fetch(:full_text, false)
    @public_url = params.fetch(:public_url, nil)
    @rag = params.fetch(:rag, nil)
    raw_page_options = params.fetch(:page_options, nil)
    raw_page_options = PageOptions.new(params: raw_page_options) unless raw_page_options.is_a?(PageOptions)
    @page_options = raw_page_options
    @close_file = params.fetch(:close_file, true)
  end
end

#full_text ⇒ Boolean

Returns the value of attribute full_text.

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/mindee/v1/client.rb', line 74

def full_text
  @full_text
end

#page_options ⇒ PageOptions

Returns the value of attribute page_options.

Returns:



74
75
76
 
# File 'lib/mindee/v1/client.rb', line 74

def page_options
  @page_options
end

#priority ⇒ Symbol?

Returns the value of attribute priority.

Returns:

  • (Symbol, nil) 


74
75
76
 
# File 'lib/mindee/v1/client.rb', line 74

def priority
  @priority
end

#public_url ⇒ String?

A unique, encrypted URL for accessing the document validation interface

Returns:

  • (String, nil) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mindee/v1/client.rb', line 73

class WorkflowOptions
  attr_accessor :document_alias, :priority, :full_text, :public_url, :page_options, :rag, :close_file

  def initialize(params: {})
    params = params.transform_keys(&:to_sym)
    @document_alias = params.fetch(:document_alias, nil)
    @priority = params.fetch(:priority, nil)
    @full_text = params.fetch(:full_text, false)
    @public_url = params.fetch(:public_url, nil)
    @rag = params.fetch(:rag, nil)
    raw_page_options = params.fetch(:page_options, nil)
    raw_page_options = PageOptions.new(params: raw_page_options) unless raw_page_options.is_a?(PageOptions)
    @page_options = raw_page_options
    @close_file = params.fetch(:close_file, true)
  end
end

#rag ⇒ Boolean?

Returns the value of attribute rag.

Returns:

  • (Boolean, nil) 


74
75
76
 
# File 'lib/mindee/v1/client.rb', line 74

def rag
  @rag
end