Entity Class |
Represents a detected entity item in extracted text and/or metadata.
See EntityResult for more information.
Inheritance HierarchySystemObject
OpenDiscoverSDK.Interfaces.Content.TextAnalyticsEntity
OpenDiscoverSDK.Interfaces.Content.TextAnalyticsEntity
Namespace: OpenDiscoverSDK.Interfaces.Content.TextAnalytics
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
SyntaxC#
[DataContractAttribute] public class Entity
The Entity type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Entity | Constructor. |
| Entity(EntityType, String, String, Int32, Int32, Int32) | Constructor. |
| Entity(EntityType, EntityMatchType, String, Int32, Int32, Int32, String, String, String) | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | Associated | Extra associated information, if any, about the item. See remarks. |
| CategoryType | The category of this entity item. |
| ColumnIndexStart | If non-negative, contains the starting column index of the entity in a structured file format column. |
| Context | Additional keyword information, if any, used to identify the item. |
| CustomEntityClassification | User defined custom entity classification. Useful for classifying (grouping) different CustomEntityName. |
| CustomEntityName | User defined custom entity name. |
| End | Zero-offset ending position in text of item. |
| GroupId | Entity group Id. Applies only to PXI entities found in spreadsheet/database formats. |
| ItemType | The type of this entity item. |
| Keywords | If MatchType property is equal to ImmediatelyAfter, ProximityBefore, or ProximityAfter then this property gives the the keywords that triggered the match for the item. If MatchType property is equal Structure then this property value will be null. |
| Line | Line number in text of item. |
| LocationType | Get or set where in the document content the entity is located (e.g., in extracted text, metadata, or hyperlink). |
| MatchType | The type of match used to find this entity item. |
| MetadataName | If property LocationType is set to Metadata, this property holds the name of the metadata field. If the metadata field is a custom (user defined) property then it will be prefixed with "cust:". |
| NormalizedText | Normalized extracted text, if supported for the ItemType. |
| Start | Zero-offset starting position in text of item. |
| Text | Extracted text of entity item (e.g., for credit cards it will be the credit card number). |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also