| Field | Type | Required | Description |
|---|---|---|---|
datasourceFilter |
Optional<String> | ➖ | Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. |
datasourcesFilter |
List<String> | ➖ | Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. |
queryOverridesFacetFilters |
Optional<Boolean> | ➖ | If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. |
facetFilters |
List<FacetFilter> | ➖ | A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. |
facetFilterSets |
List<FacetFilterSet> | ➖ | A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. |
facetBucketFilter |
Optional<FacetBucketFilter> | ➖ | N/A |
facetBucketSize |
long | ✔️ | The maximum number of FacetBuckets to return in each FacetResult. |
defaultFacets |
List<String> | ➖ | Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. |
authTokens |
List<AuthToken> | ➖ | Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). |
fetchAllDatasourceCounts |
Optional<Boolean> | ➖ | Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter |
responseHints |
List<ResponseHint> | ➖ | Array of hints containing which fields should be populated in the response. |
timezoneOffset |
Optional<Long> | ➖ | The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. |
disableSpellcheck |
Optional<Boolean> | ➖ | Whether or not to disable spellcheck. |
disableQueryAutocorrect |
Optional<Boolean> | ➖ | Disables automatic adjustment of the input query for spelling corrections or other reasons. |
returnLlmContentOverSnippets |
Optional<Boolean> | ➖ | Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. |
inclusions |
Optional<RestrictionFilters> | ➖ | N/A |
exclusions |
Optional<RestrictionFilters> | ➖ | N/A |