QueryContext interface

  • Reference
Package:
@azure/cognitiveservices-customsearch

Defines the query context that Bing used for the request.

Properties

adultIntent

A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.
alterationOverrideQuery

The query string to use to force Bing to use the original string. For example, if the query string is "saling downwind", the override query string will be "+saling downwind". Remember to encode the query string which results in "%2Bsaling+downwind". This field is included only if the original query string contains a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.
alteredQuery

The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is "saling downwind", the altered query string will be "sailing downwind". This field is included only if the original query string contains a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.
originalQuery

The query string as specified in the request.

Property Details

adultIntent

A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

adultIntent?: boolean

Property Value

boolean

alterationOverrideQuery

The query string to use to force Bing to use the original string. For example, if the query string is "saling downwind", the override query string will be "+saling downwind". Remember to encode the query string which results in "%2Bsaling+downwind". This field is included only if the original query string contains a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.

alterationOverrideQuery?: string

Property Value

string

alteredQuery

The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is "saling downwind", the altered query string will be "sailing downwind". This field is included only if the original query string contains a spelling mistake. NOTE: This property will not be serialized. It can only be populated by the server.

alteredQuery?: string

Property Value

string

originalQuery

The query string as specified in the request.

originalQuery: string

Property Value

string