Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 14.1 KB

SearchResponseMetadata.md

File metadata and controls

20 lines (17 loc) · 14.1 KB

SearchResponseMetadata

Fields

Field Type Required Description Example
rewrittenQuery Optional<String> ➖ A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators.
searchedQuery Optional<String> ➖ The actual query used to perform search and return results.
searchedQueryWithoutNegation Optional<String> ➖ The query used to perform search and return results, with negated terms and facets removed.
searchedQueryRanges List<TextRange> ➖ The bolded ranges within the searched query.
originalQuery Optional<String> ➖ The query text sent by the client in the request.
querySuggestion Optional<QuerySuggestion> ➖ N/A {
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
additionalQuerySuggestions Optional<QuerySuggestionList> ➖ N/A
negatedTerms List<String> ➖ A list of terms that were negated when processing the query.
modifiedQueryWasUsed Optional<Boolean> ➖ A different query was performed than the one requested.
originalQueryHadNoResults Optional<Boolean> ➖ No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based.
searchWarning Optional<SearchWarning> ➖ N/A
triggeredExpertDetection Optional<Boolean> ➖ Whether the query triggered expert detection results in the People tab.
isNoQuotesSuggestion Optional<Boolean> ➖ Whether the query was modified to remove quotes