Share via

EntitiesEntityPresentationInfo interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines additional information about an entity such as type hints.

Properties

entityScenario

The supported scenario. Possible values include: 'DominantEntity', 'DisambiguationItem', 'ListItem'. Default value: 'DominantEntity'.
entityTypeDisplayHint

A display version of the entity hint. For example, if entityTypeHints is Artist, this field may be set to American Singer. NOTE: This property will not be serialized. It can only be populated by the server.
entityTypeHints

A list of hints that indicate the entity's type. The list could contain a single hint such as Movie or a list of hints such as Place, LocalBusiness, Restaurant. Each successive hint in the array narrows the entity's type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

entityScenario

The supported scenario. Possible values include: 'DominantEntity', 'DisambiguationItem', 'ListItem'. Default value: 'DominantEntity'.

entityScenario: EntityScenario

Property Value

EntityScenario

entityTypeDisplayHint

A display version of the entity hint. For example, if entityTypeHints is Artist, this field may be set to American Singer. NOTE: This property will not be serialized. It can only be populated by the server.

entityTypeDisplayHint?: string

Property Value

string

entityTypeHints

A list of hints that indicate the entity's type. The list could contain a single hint such as Movie or a list of hints such as Place, LocalBusiness, Restaurant. Each successive hint in the array narrows the entity's type. NOTE: This property will not be serialized. It can only be populated by the server.

entityTypeHints?: EntityType[]

Property Value

EntityType[]