| Field | Type | Required | Description | Example |
|---|---|---|---|---|
missingTerm |
Optional<String> | ➖ | A query term missing from the original query on which this suggestion is based. | |
query |
String | ✔️ | The query being suggested (e.g. enforcing the missing term from the original query). | |
searchProviderInfo |
Optional<SearchProviderInfo> | ➖ | N/A | { "name": "Google", "logo": "https://app.glean.com/images/feather/globe.svg", "searchLinkUrlTemplate": "https://www.google.com/search?q={query}\u0026hl=en" } |
label |
Optional<String> | ➖ | A user-facing description to display for the suggestion. | |
datasource |
Optional<String> | ➖ | The datasource associated with the suggestion. | |
resultTab |
Optional<ResultTab> | ➖ | N/A | |
requestOptions |
Optional<SearchRequestOptions> | ➖ | N/A | { "datasourceFilter": "JIRA", "datasourcesFilter": [ "JIRA" ], "queryOverridesFacetFilters": true, "facetFilters": [ { "fieldName": "fieldName", "values": [ "fieldValues", "fieldValues" ] }, { "fieldName": "fieldName", "values": [ "fieldValues", "fieldValues" ] } ] } |
ranges |
List<TextRange> | ➖ | The bolded ranges within the query of the QuerySuggestion. | |
inputDetails |
Optional<SearchRequestInputDetails> | ➖ | N/A | { "hasCopyPaste": true } |