Query interface

Defines a search query.

Properties

displayText

The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting NOTE: This property will not be serialized. It can only be populated by the server.

searchLink

The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL. NOTE: This property will not be serialized. It can only be populated by the server.

text

The query string. Use this string as the query term in a new search request.

thumbnail

The URL to a thumbnail of a related image. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl

The URL that takes the user to the Bing search results page for the query.Only related search results include this field. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

displayText

The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting NOTE: This property will not be serialized. It can only be populated by the server.

displayText?: undefined | string

Property Value

undefined | string

The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL. NOTE: This property will not be serialized. It can only be populated by the server.

searchLink?: undefined | string

Property Value

undefined | string

text

The query string. Use this string as the query term in a new search request.

text: string

Property Value

string

thumbnail

The URL to a thumbnail of a related image. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnail?: ImageObject

Property Value

webSearchUrl

The URL that takes the user to the Bing search results page for the query.Only related search results include this field. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: undefined | string

Property Value

undefined | string