Query interface

Package:

@azure/cognitiveservices-websearch

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	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	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?: string

Property Value

string

searchLink

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

searchLink?: string

Property Value

string

text

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

text: string

Property Value

string

thumbnail

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

thumbnail?: ImageObject

Property Value

ImageObject

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?: string

Property Value

string