Spellcheck API

Response Objects

# SpellCheckSearchApiResponse

Top level response model for successful Spellcheck API requests. The API can also respond back with an error response based on invalid subscription keys and rate limit events.

FieldTypeRequiredDescription
type"spellcheck"true

The type of search api result. The value is always spellcheck.

queryQuerytrue

Spellcheck search query string. Only the original query is returned.

resultslist [ SpellCheckResult ]true

The list of spell-checked results for given query.

# Query

A model representing information gathered around the requested query.

FieldTypeRequiredDescription
originalstringtrue

The original query that was requested.

# SpellCheckResult

Spell-checked query result.

FieldTypeRequiredDescription
querystringtrue

The spellcheck-corrected query.