Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 13.2 KB

File metadata and controls

24 lines (21 loc) · 13.2 KB

SearchResponse

Fields

Field Type Required Description Example
tracking_token Optional[str] ➖ A token that should be passed for additional requests related to this request (such as more results requests).
session_info Optional[models.SessionInfo] ➖ N/A
results List[models.SearchResult] ➖ N/A
structured_results List[models.StructuredResult] ➖ N/A
generated_qna_result Optional[models.GeneratedQna] ➖ N/A
glean_data_error Optional[models.GleanDataError] ➖ N/A
request_id Optional[str] ➖ A platform-generated request ID to correlate backend logs.
backend_time_millis Optional[int] ➖ Time in milliseconds the backend took to respond to the request. 1100
experiment_ids List[int] ➖ List of experiment ids for the corresponding request.
metadata Optional[models.SearchResponseMetadata] ➖ N/A
facet_results List[models.FacetResult] ➖ N/A
result_tabs List[models.ResultTab] ➖ All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request.
result_tab_ids List[str] ➖ The unique IDs of the result tabs to which this response belongs.
results_description Optional[models.ResultsDescription] ➖ N/A
rewritten_facet_filters List[models.FacetFilter] ➖ The actual applied facet filters based on the operators and facetFilters in the query. Useful for mapping typed operators to visual facets.
cursor Optional[str] ➖ Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query.
has_more_results Optional[bool] ➖ Whether more results are available. Use cursor to retrieve them.