📦 @bntk/ner

EntityType

Defined in: index.ts:22

Enumeration of supported named entity types.

Enumeration Members

Enumeration Member	Value	Defined in
DATE	"DATE"	index.ts:26
LOCATION	"LOCATION"	index.ts:25
MONEY	"MONEY"	index.ts:27
ORGANIZATION	"ORGANIZATION"	index.ts:24
PERCENT	"PERCENT"	index.ts:28
PERSON	"PERSON"	index.ts:23
TIME	"TIME"	index.ts:29
UNKNOWN	"UNKNOWN"	index.ts:30

---

Entity

Defined in: index.ts:10

Represents a named entity found in text with its position and classification details.

Properties

Property	Type	Description	Defined in
confidence	number	Confidence score of the classification (0-1)	index.ts:15
end	number	Ending position of the entity in the text	index.ts:14
start	number	Starting position of the entity in the text	index.ts:13
text	string	The actual text of the entity	index.ts:11
type	EntityType	The classification type of the entity	index.ts:12

---

batchExtractEntities()

function batchExtractEntities(texts): Entity[][];

Defined in: index.ts:96

Processes multiple texts for entity extraction in batch.

Parameters

Parameter	Type	Description
texts	string[]	Array of texts to process

Returns

Entity[][]

Array of entity arrays for each input text

Example

const results = batchExtractEntities(["John Doe", "New York"]);
// Returns: [[{text: "John Doe", ...}], [{text: "New York", ...}]]

---

classifyEntity()

function classifyEntity(text): EntityType;

Defined in: index.ts:68

Classifies a single text segment into an entity type.

Parameters

Parameter	Type	Description
text	string	The text to classify

Returns

EntityType

The predicted entity type

Example

const type = classifyEntity("John Doe");
// Returns: EntityType.PERSON

---

extractEntities()

function extractEntities(text): Entity[];

Defined in: index.ts:41

Extracts named entities from input text.

Parameters

Parameter	Type	Description
text	string	The input text to analyze

Returns

Entity[]

Array of detected entities with their positions and classifications

Example

const entities = extractEntities("John Doe works at Apple Inc.");
// Returns: [{text: "John Doe", type: "PERSON", start: 0, end: 8, confidence: 0.95}]

---

getEntityConfidence()

function getEntityConfidence(text, entityType): number;

Defined in: index.ts:81

Calculates confidence score for entity classification.

Parameters

Parameter	Type	Description
text	string	The text to analyze
entityType	EntityType	The entity type to check

Returns

number

Confidence score between 0 and 1

Example

const confidence = getEntityConfidence("John Doe", EntityType.PERSON);
// Returns: 0.85

---

getSupportedEntityTypes()

function getSupportedEntityTypes(): EntityType[];

Defined in: index.ts:107

Retrieves all supported entity types.

Returns

EntityType[]

Array of all supported entity types

Example

const types = getSupportedEntityTypes();
// Returns: [EntityType.PERSON, EntityType.ORGANIZATION, ...]