ClassificationResult Class Reference

Class that contains the result of a classification call on the Execution State. More...

#include <src/api/mip/upe/classification_result.h>

Public Member Functions
virtual int	GetConfidenceLevel () const =0
	Get the confidence in the result.
virtual int	GetCount () const =0
	Get the instance count.
virtual std::vector< std::shared_ptr< mip::DetailedClassificationResult > >	GetDetailedClassificationAttributes () const
	Get the specific detection bands if the enchanced classification is enabled.
virtual std::string	GetId () const =0
	Get the ID of the classification policy.
virtual std::string	GetName () const =0
	Get the name of the classification policy.
virtual std::string	GetSensitiveInformationDetections () const =0
	Get the sensitive information detections.

Detailed Description

Class that contains the result of a classification call on the Execution State.

Definition at line 48 of file classification_result.h.

Member Function Documentation

GetConfidenceLevel()

virtual int ClassificationResult::GetConfidenceLevel ( ) const

pure virtual

Get the confidence in the result.

GetCount()

virtual int ClassificationResult::GetCount ( ) const

pure virtual

Get the instance count.

Returns

the instance count.

GetDetailedClassificationAttributes()

virtual std::vector< std::shared_ptr< mip::DetailedClassificationResult > > ClassificationResult::GetDetailedClassificationAttributes ( ) const

inlinevirtual

Get the specific detection bands if the enchanced classification is enabled.

Returns

a vector of instance counts at different confidence thresholds

Definition at line 83 of file classification_result.h.

                                                                                                                {
    return std::vector<std::shared_ptr<mip::DetailedClassificationResult>>();
  }

GetId()

virtual std::string ClassificationResult::GetId ( ) const

pure virtual

Get the ID of the classification policy.

Returns

ID of the classification policy.

GetName()

virtual std::string ClassificationResult::GetName ( ) const

pure virtual

Get the name of the classification policy.

Returns

name of the classification policy.

GetSensitiveInformationDetections()

virtual std::string ClassificationResult::GetSensitiveInformationDetections ( ) const

pure virtual

Get the sensitive information detections.

Returns

json string of all the sensitive information detections. if not empty must be a valid json format.

---

The documentation for this class was generated from the following file:

• src/api/mip/upe/classification_result.h