Share via

SpellSuggestions interface

  • Reference
Package:
@azure/cognitiveservices-websearch

Defines a suggested query string that likely represents the user's intent. The search results include this response if Bing determines that the user may have intended to search for something different. For example, if the user searches for alon brown, Bing may determine that the user likely intended to search for Alton Brown instead (based on past searches by others of Alon Brown).

Properties

followUpQueries

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.
isFamilyFriendly

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

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

The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. NOTE: This property will not be serialized. It can only be populated by the server.
value

A list of suggested query strings that may represent the user's intention. The list contains only one Query object.
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

followUpQueries

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

followUpQueries?: Query[]

Property Value

Query[]

id

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

id?: string

Property Value

string

isFamilyFriendly

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

isFamilyFriendly?: boolean

Property Value

boolean

queryContext

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

queryContext?: QueryContext

Property Value

QueryContext

totalEstimatedMatches

The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. NOTE: This property will not be serialized. It can only be populated by the server.

totalEstimatedMatches?: number

Property Value

number

value

A list of suggested query strings that may represent the user's intention. The list contains only one Query object.

value: Query[]

Property Value

Query[]

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