Share via

SearchResponse interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines the top-level object that the response includes when the request succeeds.

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.
entities

A list of entities that are relevant to the search query. 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.
places

A list of local entities such as restaurants or hotels that are relevant to the query. NOTE: This property will not be serialized. It can only be populated by the server.
queryContext

An object that contains the query string that Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.
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[]

entities

A list of entities that are relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.

entities?: Entities

Property Value

Entities

id

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

id?: string

Property Value

string

places

A list of local entities such as restaurants or hotels that are relevant to the query. NOTE: This property will not be serialized. It can only be populated by the server.

places?: Places

Property Value

Places

queryContext

An object that contains the query string that Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.

queryContext?: QueryContext

Property Value

QueryContext

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