SearchResponse interface

Package:

@azure/cognitiveservices-websearch

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

Properties

computation	The answer to a math expression or units conversion expression. 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.
images	A list of images that are relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.
news	A list of news articles that are relevant to the search 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.
rankingResponse	The order that Bing suggests that you display the search results in. NOTE: This property will not be serialized. It can only be populated by the server.
relatedSearches	A list of related queries made by others. NOTE: This property will not be serialized. It can only be populated by the server.
spellSuggestions	The query string that likely represents the user's intent. NOTE: This property will not be serialized. It can only be populated by the server.
timeZone	The date and time of one or more geographic locations. NOTE: This property will not be serialized. It can only be populated by the server.
videos	A list of videos that are relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.
webPages	A list of webpages that are relevant to the search query. 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

computation

The answer to a math expression or units conversion expression. NOTE: This property will not be serialized. It can only be populated by the server.

computation?: Computation

Property Value

Computation

id

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

id?: string

Property Value

string

images

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

images?: Images

Property Value

Images

news

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

news?: News

Property Value

News

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

rankingResponse

The order that Bing suggests that you display the search results in. NOTE: This property will not be serialized. It can only be populated by the server.

rankingResponse?: RankingRankingResponse

Property Value

RankingRankingResponse

relatedSearches

A list of related queries made by others. NOTE: This property will not be serialized. It can only be populated by the server.

relatedSearches?: RelatedSearchesRelatedSearchAnswer

Property Value

RelatedSearchesRelatedSearchAnswer

spellSuggestions

The query string that likely represents the user's intent. NOTE: This property will not be serialized. It can only be populated by the server.

spellSuggestions?: SpellSuggestions

Property Value

SpellSuggestions

timeZone

The date and time of one or more geographic locations. NOTE: This property will not be serialized. It can only be populated by the server.

timeZone?: TimeZone

Property Value

TimeZone

videos

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

videos?: Videos

Property Value

Videos

webPages

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

webPages?: WebWebAnswer

Property Value

WebWebAnswer

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