SearchResponse interface

Package:

@azure/cognitiveservices-customsearch

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

Properties

id	A String identifier. 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.
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

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

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

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