Skip to main content

ClassificationResult Class

ClassificationResult is a public class that represents a classification result for a part of a document.

Definition​

  • Namespace: UiPath.DocumentProcessing.Contracts.Results
  • Assembly: UiPath.DocumentProcessing.Contracts

Description​

A public class that represents a classification result for a part of a document.

Members​

Constructors​

  • ClassificationResult(string documentTypeId, string documentId, UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds documentBounds) - Initializes a new instance of the ClassificationResult class, setting the DocumentTypeId, DocumentId, and DocumentBounds properties as provided.
  • ClassificationResult(string documentTypeId, string documentId, float confidence, float ocrConfidence, UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference reference, UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds documentBounds) - Initializes a new instance of the ClassificationResult class, setting the DocumentTypeId, DocumentId, Confidence, OcrConfidence, Reference, and DocumentBounds properties as provided.
  • ClassificationResult(string documentTypeId, string documentId, float confidence, float ocrConfidence, UiPath.DocumentProcessing.Contracts.Results.ResultsContentReference reference, UiPath.DocumentProcessing.Contracts.Results.ResultsDocumentBounds documentBounds, string classifierName) - Initializes a new instance of the ClassificationResult class, setting the DocumentTypeId, DocumentId, Confidence, OcrConfidence, Reference, DocumentBounds, and ClassifierName properties as provided.

Methods​

  • AsExtractionResult(UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy taxonomy) - Returns a UiPath.DocumentProcessing.Contracts.Results.ExtractionResult object generated using the available classification information, reporting all fields as Missing.
  • Serialize() - Serializes the UiPath.DocumentProcessing.Contracts.Results.ClassificationResult object to a JSON string.
  • Deserialize(string) - De-serializes a JSON string to a UiPath.DocumentProcessing.Contracts.Results.ClassificationResult object.

Properties​

  • DocumentId string - The name of the document that is being classified.
  • DocumentTypeId string - The ID of the document type reported by the classifier.
  • Confidence float - A value between 0 and 1 representing the classifier's confidence related to the reported DocumentTypeId.
  • OcrConfidence float - A value between 0 and 1 representing the OCR confidence related to the evidence provided for the given classification result.
  • ClassifierName string - The name of the classifier which provides the result.
  • DocumentBounds - The document boundaries for which the classification is being reported.
    • (Preview) From the DocumentBounds object you can access the page range of a classified document.
  • Reference - The evidencing reference information for the provided classification.