GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureTextExtraction Class
Properties Methods

In This Topic
GdPictureTextExtraction Class Members
In This Topic

The following tables list the members exposed by GdPictureTextExtraction.

Public Constructors
 NameDescription
Public ConstructorGdPictureTextExtraction Constructor GdPictureTextExtraction is a streamlined class designed to effortlessly convert any GdPicture technology-supported document into plain text. It provides a range of capabilities that allow for addressing various scenarios, including indexing and enhancing the performance of LLM inferences. It employs internal logic to optimize extraction accuracy and minimize processing time through the dynamic utilization of page layout analysis, encoding detection, and OCR components. The identical API serves for processing raster images, PDFs, CAD files, Email files, and office formats alike. Documents can be loaded from file paths, Stream objects, or distant URIs.  
Top
Public Properties
 NameDescription
Public PropertyDictionary Specifies the dictionary to be used during the optional OCR process.  
Public PropertyEnableKeyValuePairsExtraction Specifies whether key value pairs extraction is enabled.  
Public PropertyEnableOCR Specifies whether OCR is enabled.  
Public PropertyEnableOrientationDetection Specifies whether document orientation detection is activated.  
Public PropertyEnableTablesExtraction Specifies whether tables extraction is enabled.  
Public PropertyPageRange Use this property before the loading step to specify a range of pages that will be subsequently processed. This allows for speeding up the loading process.  
Public PropertyParagraphSeparator This property specifies the separator to be utilized for splitting paragraphs. It takes effect solely when the PreserveParagraphs property is set to true.  
Public PropertyPreserveParagraphs Specifies that the text extraction engine must preserve text paragraphs. This functionality is particularly useful to improve the accuracy of NLP engines.  
Public PropertyResourcesFolderSpecifies the path to the directory containing the engine resources (mostly dictionaries).  
Public PropertyTimeoutMillisecondsSpecifies the timeout for any subsequent process, in milliseconds. The default value is -1, which means there is no timeout.  
Top
Public Methods
 NameDescription
Public MethodCloseDocument Closes the currently loaded.  
Public MethodDispose  
Public MethodGetDocumentFormat Returns the format the currently loaded document.  
Public MethodGetFormFieldCount Returns the number of extracted form fields within the extraction process. Form fields extraction is automatically performed during each extraction process.  
Public MethodGetFormFieldKeyRect Returns the location of the key part of a specified form field.  
Public MethodGetFormFieldKeyText Returns the text of a specified form field.  
Public MethodGetFormFieldType Returns the type of a specified form field.  
Public MethodGetFormFieldValueRect Returns the location of the value part of a specified form field.  
Public MethodGetFormFieldValueText Returns the text of the key of a specified form field.  
Public MethodGetKeyValuePairConfidence Returns the detection confidence a specified key-value pair.  
Public MethodGetKeyValuePairCount Returns the number of extracted key-value pairs within the extraction process. Key-value pairs extraction is automatically performed during each extraction process.  
Public MethodGetKeyValuePairDataType Returns the data type of a specified key-value pair.  
Public MethodGetKeyValuePairIsStrong Returns whether a specific key-value pair is strong. A pair is marked as strong when a semantic relationship have been established during the detection process.  
Public MethodGetKeyValuePairKeyRect Returns the location of the key part of a specified key-value pair.  
Public MethodGetKeyValuePairKeyString Returns the string representation of the key part of a specified key-value pair.  
Public MethodGetKeyValuePairPublicName  
Public MethodGetKeyValuePairValueRect Returns the location of the value part of a specified key-value pair.  
Public MethodGetKeyValuePairValueString Returns the string representation of the value part of a specified key-value pair.  
Public MethodGetPageCount This method returns the number of pages in the currently loaded document. If there is no currently loaded document it returns 0.  
Public MethodGetPageText Retrieves the text from a particular page of the currently loaded document.  
Public MethodGetStatReturns the status of the last executed operation with the current GdPictureTextExtraction object.  
Public MethodGetTableCellRect Returns the location of a cell in a specified table.  
Public MethodGetTableCellText Returns the text content of a cell in a specified table.  
Public MethodGetTableColumnCount Returns the number of columns in a specified table.  
Public MethodGetTableColumnRect Returns the location of a column in a specified table.  
Public MethodGetTableCount Returns the number of detected tables within the extraction process.  
Public MethodGetTableRect Returns the location of a specified table.  
Public MethodGetTableRowCount Returns the number of rows in a specified table.  
Public MethodGetTableRowRect Returns the location of a row in a specified table.  
Public MethodIsHeaderCell Specify whether if the cell's coordinate is located in the table's header.  
Public MethodLoadFromFile Loads a document from a file path.  
Public MethodLoadFromHttp Loads a document from a distant URI.  
Public MethodLoadFromStream Loads a document from a stream object.  
Top
See Also

Reference

GdPictureTextExtraction Class
GdPicture14 Namespace

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved