Suggest API
Response Objects
# SuggestSearchApiResponse
Top level response model for successful Suggest Search API requests. The API can also respond back with an error response based on invalid subscription keys and rate limit events.
| Field | Type | Required | Description |
|---|---|---|---|
| type | "suggest" | true | The type of search api result. The value is always |
| query | Query | true | Suggest search query string. Only the original query is returned. |
| results | list [ SuggestResult ] | true | The list of suggestions for the given query. |
# Query
A model representing information gathered around the requested query.
| Field | Type | Required | Description |
|---|---|---|---|
| original | string | true | The original query that was requested. |
# SuggestResult
Suggestions for a query.
| Field | Type | Required | Description |
|---|---|---|---|
| query | string | true | Suggested query completion. |
| is_entity | bool | false | Whether the suggested enriched query is an entity. |
| title | string | false | The suggested query enriched title. |
| description | string | false | The suggested query enriched description. |
| img | string | false | The suggested query enriched image URL. |