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 | Description |
|---|---|---|
| type | "suggest" | The type of search api result. The value is always suggest. |
| query | Query | Suggest search query string. Only the original query is returned. |
| results | list [ SuggestResult ] | The list of suggestions for the given query. |
# Query
A model representing information gathered around the requested query.
| Field | Type | Description |
|---|---|---|
| original | string | The original query that was requested. |
# SuggestResult
Suggestions for a query.
| Field | Type | Description |
|---|---|---|
| query | string | Suggested query completion. |
| is_entity | bool | Whether the suggested enriched query is an entity. |
| title | string | The suggested query enriched title. |
| description | string | The suggested query enriched description. |
| img | string | The suggested query enriched image url. |