Class: Mindee::V2::Product::Classification::ClassificationResult

Inherits:

Object

• Object
• Mindee::V2::Product::Classification::ClassificationResult

Defined in:

lib/mindee/v2/product/classification/classification_result.rb

Overview

Result of the document classifier inference.

Instance Attribute Summary

• #classification ⇒ ClassificationClassifier readonly

  The document type, as identified on given classification values.

Instance Method Summary

• #initialize(server_response) ⇒ ClassificationResult constructor

  A new instance of ClassificationResult.

• #to_s ⇒ String

  String representation.

Constructor Details

#initialize(server_response) ⇒ ClassificationResult

Returns a new instance of ClassificationResult.

Parameters:

• server_response (Hash) —

  Hash representation of the JSON returned by the service.

# File 'lib/mindee/v2/product/classification/classification_result.rb', line 15

def initialize(server_response)
  @classification = ClassificationClassifier.new(server_response['classification'])
end

Instance Attribute Details

#classification ⇒ ClassificationClassifier (readonly)

Returns The document type, as identified on given classification values.

Returns:

• (ClassificationClassifier) —

  The document type, as identified on given classification values.

# File 'lib/mindee/v2/product/classification/classification_result.rb', line 12

def classification
  @classification
end

Instance Method Details

#to_s ⇒ String

Returns String representation.

Returns:

• (String) —

  String representation.

# File 'lib/mindee/v2/product/classification/classification_result.rb', line 20

def to_s
  "Classification\n==============\n#{@classification}"
end