Options
All
  • Public
  • Public/Protected
  • All
Menu

The important people, places, geopolitical entities and other types of entities in your content.

Hierarchy

  • EntitiesResult

Index

Properties

Optional confidence

confidence: number

Confidence in the entity identification from 0 to 1. Higher values indicate higher confidence. In standard entities requests, confidence is returned only for English text. All entities requests that use custom models return the confidence score.

Optional count

count: number

How many times the entity was mentioned in the text.

Optional disambiguation

disambiguation: DisambiguationResult

Disambiguation information for the entity.

Optional emotion

emotion: EmotionScores

Emotion analysis results for the entity, enabled with the emotion option.

Optional mentions

mentions: EntityMention[]

Entity mentions and locations.

Optional relevance

relevance: number

Relevance score from 0 to 1. Higher values indicate greater relevance.

Optional sentiment

Sentiment analysis results for the entity, enabled with the sentiment option.

Optional text

text: string

The name of the entity.

Optional type

type: string

Entity type.

Generated using TypeDoc