Class: Mindee::V2::Product::BaseProduct

Inherits:

Object

• Object
• Mindee::V2::Product::BaseProduct

Defined in:

lib/mindee/v2/product/base_product.rb,
sig/mindee/v2/product/base_product.rbs

Overview

Base class for all V2 products.

Direct Known Subclasses

Mindee::V2::Parsing::BaseInference, Classification::Classification, Crop::Crop, Extraction::Extraction, OCR::OCR, Split::Split

Class Attribute Summary

• .params_type ⇒ singleton(Input::BaseParameters) readonly

  Returns the value of attribute params_type.

• .response_type ⇒ singleton(Parsing::BaseResponse) readonly

  Returns the value of attribute response_type.

• .slug ⇒ String readonly

  Returns the value of attribute slug.

Class Method Summary

• ._params_type ⇒ singleton(Input::BaseParameters)

Instance Method Summary

• #initialize ⇒ BaseProduct constructor

  A new instance of BaseProduct.

Constructor Details

#initialize ⇒ BaseProduct

Returns a new instance of BaseProduct.

Raises:

• (StandardError)

# File 'lib/mindee/v2/product/base_product.rb', line 18

def initialize
  raise StandardError, 'Cannot instantiate abstract class.' if instance_of?(BaseProduct)
end

Class Attribute Details

.params_type ⇒ singleton(Input::BaseParameters) (readonly)

Returns the value of attribute params_type.

Returns:

• (singleton(Input::BaseParameters))

# File 'lib/mindee/v2/product/base_product.rb', line 23

def params_type
  @params_type
end

.response_type ⇒ singleton(Parsing::BaseResponse) (readonly)

Returns the value of attribute response_type.

Returns:

• (singleton(Parsing::BaseResponse))

# File 'lib/mindee/v2/product/base_product.rb', line 23

def response_type
  @response_type
end

.slug ⇒ String (readonly)

Returns the value of attribute slug.

Returns:

• (String)

# File 'lib/mindee/v2/product/base_product.rb', line 23

def slug
  @slug
end

Class Method Details

._params_type ⇒ singleton(Input::BaseParameters)

Returns:

• (singleton(Input::BaseParameters))

# File 'sig/mindee/v2/product/base_product.rbs', line 9

def self._params_type: () -> singleton(Input::BaseParameters)