CategorizedEntity interface

Package:

@azure/ai-text-analytics

An entity from text analysis with information about its categorical classification.

Extends

Entity

Inherited Properties

category	Entity type.
confidenceScore	Confidence score between 0 and 1 of the extracted entity.
length	Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
offset	Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
subCategory	(Optional) Entity sub type.
text	Entity text as appears in the request.

Inherited Property Details

category

Entity type.

category: string

Property Value

string

Inherited From Entity.category

confidenceScore

Confidence score between 0 and 1 of the extracted entity.

confidenceScore: number

Property Value

number

Inherited From Entity.confidenceScore

length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

length: number

Property Value

number

Inherited From Entity.length

offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

offset: number

Property Value

number

Inherited From Entity.offset

subCategory

(Optional) Entity sub type.

subCategory?: string

Property Value

string

Inherited From Entity.subCategory

text

Entity text as appears in the request.

text: string

Property Value

string

Inherited From Entity.text