Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 22.9 KB

File metadata and controls

24 lines (21 loc) · 22.9 KB

SearchRequestOptions

Fields

Field Type Required Description
datasource_filter Optional[str] Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
datasources_filter List[str] Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
query_overrides_facet_filters Optional[bool] 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.
facet_filters List[models.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.
facet_filter_sets List[models.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.
facet_bucket_filter Optional[models.FacetBucketFilter] N/A
facet_bucket_size int ✔️ The maximum number of FacetBuckets to return in each FacetResult.
default_facets List[str] 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.
auth_tokens List[models.AuthToken] Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
fetch_all_datasource_counts Optional[bool] 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
response_hints List[models.ResponseHint] Array of hints containing which fields should be populated in the response.
timezone_offset Optional[int] The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
disable_spellcheck Optional[bool] Whether or not to disable spellcheck.
disable_query_autocorrect Optional[bool] Disables automatic adjustment of the input query for spelling corrections or other reasons.
return_llm_content_over_snippets Optional[bool] 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[models.RestrictionFilters] N/A
exclusions Optional[models.RestrictionFilters] N/A