Click or drag to resize

EntityExtractionSettings Class

Entity extraction settings.
Inheritance Hierarchy
SystemObject
  OpenDiscoverSDK.Interfaces.Settings.TextAnalyticsEntityExtractionSettings

Namespace: OpenDiscoverSDK.Interfaces.Settings.TextAnalytics
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
Syntax
C#
Copy
[DataContractAttribute]
public class EntityExtractionSettings

The EntityExtractionSettings type exposes the following members.

Constructors
 NameDescription
Public methodEntityExtractionSettings Constructor.
Public methodEntityExtractionSettings(EntityExtractionSettings) Constructor. Initializes this object with the values of another instance.
Top
Properties
 NameDescription
Public propertyCustomEntityDefinitions Custom entity definitions. To use these custom item definitions they MUST be loaded using method OpenDiscoverSDK.ContentExtractorFactory.LoadCustomEntityDefinitions once in a process BEFORE starting any content extraction on process threads.
Public propertyCustomEntityExtractionEnabled If true, enables custom entity detection and extraction
Public propertyDeduplicateEntityItems If enabled (true) then duplicate entity items are not included in results. See remarks.
Public propertyEnabled If true, entity extraction is enabled. If false, no entity extraction is performed in extracted text nor metadata.
Public propertyEnableEmojiEntityDetection If enabled (true) then emoji entity items will be detected (default value is true). If false, emoji entities will not be detected and returned in results.
Public propertyEnableExtractedEntityTypeFilter If enabled, true, the SDK will filter-out entity types (EntityType) in the Items property that are NOT in the ExtractedEntityTypeFilter hash set. If false, then Items property is not filtered by EntityType.
Public propertyEnablePersonNameFinder If enabled the SDK will attempt to find person names without context. If enabled, this will lead to some degradation in document processing speed performance.
Public propertyEnablePersonNameFinderInBinaryToText If enabled the SDK will attempt to find person names in binary-to-text filtered documents. Binary-to-text filtered files have lots of "noise", enabling this feature may lead to lots of false postives.
Public propertyEnableRelaxedCreditCardDetectionMode If enabled, less stringent rules are used to find credit card number entities, i.e., the Luhn check is not used to verify the card number checksum (default value is true). This will lead to more false positives but improve entity detection as some card numbers no longer use the Luhn check.
Public propertyEnableRelaxedStructuredDataMode If enabled, less stringent rules are used to find column based entities in structured tabular formats such as spreadsheets and database files (default value is true). This will lead to more false positives but improve entity detection.
Public propertyExtractedEntityTypeFilter If EnableExtractedEntityTypeFilter is true, only entity types (EntityType) in this property HashSet are extracted and returned by Items property. If EnableExtractedEntityTypeFilter is false, then this property is ignored.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Remarks
The entity extractions provided by the Open Discover SDK are not purposed or intended to satisfy any state or federal personally identifiable information (PII), PHI, nor FERPA regulatory requirements.
See Also