Share via

Entities interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines an entity answer.

Properties

contractualRules

A list of rules that you must adhere to if you display the item. NOTE: This property will not be serialized. It can only be populated by the server.
id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
queryContext

NOTE: This property will not be serialized. It can only be populated by the server.
queryScenario

The supported query scenario. This field is set to DominantEntity or DisambiguationItem. The field is set to DominantEntity if Bing determines that only a single entity satisfies the request. For example, a book, movie, person, or attraction. If multiple entities could satisfy the request, the field is set to DisambiguationItem. For example, if the request uses the generic title of a movie franchise, the entity's type would likely be DisambiguationItem. But, if the request specifies a specific title from the franchise, the entity's type would likely be DominantEntity. Possible values include: 'DominantEntity', 'DominantEntityWithDisambiguation', 'Disambiguation', 'List', 'ListWithPivot' NOTE: This property will not be serialized. It can only be populated by the server.. Default value: 'DominantEntity'.
value

A list of entities.
webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

contractualRules

A list of rules that you must adhere to if you display the item. NOTE: This property will not be serialized. It can only be populated by the server.

contractualRules?: ContractualRulesContractualRuleUnion[]

Property Value

ContractualRulesContractualRuleUnion[]

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

queryContext

NOTE: This property will not be serialized. It can only be populated by the server.

queryContext?: QueryContext

Property Value

QueryContext

queryScenario

The supported query scenario. This field is set to DominantEntity or DisambiguationItem. The field is set to DominantEntity if Bing determines that only a single entity satisfies the request. For example, a book, movie, person, or attraction. If multiple entities could satisfy the request, the field is set to DisambiguationItem. For example, if the request uses the generic title of a movie franchise, the entity's type would likely be DisambiguationItem. But, if the request specifies a specific title from the franchise, the entity's type would likely be DominantEntity. Possible values include: 'DominantEntity', 'DominantEntityWithDisambiguation', 'Disambiguation', 'List', 'ListWithPivot' NOTE: This property will not be serialized. It can only be populated by the server.. Default value: 'DominantEntity'.

queryScenario?: EntityQueryScenario

Property Value

EntityQueryScenario

value

A list of entities.

value: ThingUnion[]

Property Value

ThingUnion[]

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string