RecognitionResult

RecognitionResult class

The results of the image recognition. Contains elements with recognition information and methods for result export.

public class RecognitionResult

Name	Description
RecognitionResult()	Initializes a new instance of the `RecognitionResult` class.

Name	Description
FileName { get; set; }	Full path to the file.
Image { get; set; }	Gets or sets image for pdf creation.
RecognitionCharactersList { get; }	A set of characters found by the recognition algorithm and arranged in descending order of probability.
RecognitionLinesResult { get; }	Gets a list of recognition results with a list of rows (Rectangles).
RecognitionRegionsResult { get; }	Gets a list of recognition results with a list of regions (Rectangles).
RecognitionText { get; set; }	Gets recognition result in one string.
SerializableImage { get; set; }	Serialized image payload used for RecognitionResult JSON/binary serialization. Stores the same image data as `Image`, but in one-dimensional form.
Warnings { get; }	Gets list of the warning messages describing non-critical faults appeared during generation.

Name	Description
GetJson(bool)	Form JSON string with recognition results.
GetKeywords()	Get keywords from pasport (Test mode. Works only for USA and MADAGASCAR passports).
GetSpellCheckCorrectedText(SpellCheckLanguage, string)	Corrects text (replaces misspelled words).
GetSpellCheckErrorList(SpellCheckLanguage, string)	Find the misspelled words with suggested spellings for a given input text.
GetXml()	Form XML string with recognition results.
Save(MemoryStream, SaveFormat, string, PdfOptimizationMode)	Saves the document as the plain text, PDF or Microsoft Word Document.
Save(string, SaveFormat, string, PdfOptimizationMode)	Saves the document as the plain text, PDF or Microsoft Word Document.
Save(MemoryStream, SaveFormat, bool, SpellCheckLanguage, string, string, PdfOptimizationMode)	Saves the document as the plain text, PDF or Microsoft Word Document.
Save(string, SaveFormat, bool, SpellCheckLanguage, string, string, PdfOptimizationMode)	Saves the document as the plain text, PDF or Microsoft Word Document.
operator +	To complete the full result from recognized fragments (lines).

Name	Description
class LinesResult	Recognized text from row with row coordinates.
class RegionResult	Recognized text from region with region coordinates.