| Field | Type | Required | Description | Example |
|---|---|---|---|---|
trackingToken |
Optional<String> | ➖ | A token that should be passed for additional requests related to this request (such as more results requests). | |
sessionInfo |
Optional<SessionInfo> | ➖ | N/A | |
results |
List<SearchResult> | ➖ | N/A | |
structuredResults |
List<StructuredResult> | ➖ | N/A | |
generatedQnaResult |
Optional<GeneratedQna> | ➖ | N/A | |
gleanDataError |
Optional<GleanDataError> | ➖ | N/A | |
requestID |
Optional<String> | ➖ | A platform-generated request ID to correlate backend logs. | |
backendTimeMillis |
Optional<Long> | ➖ | Time in milliseconds the backend took to respond to the request. | 1100 |
experimentIds |
List<long> | ➖ | List of experiment ids for the corresponding request. | |
metadata |
Optional<SearchResponseMetadata> | ➖ | N/A | |
facetResults |
List<FacetResult> | ➖ | N/A | |
resultTabs |
List<ResultTab> | ➖ | All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request. | |
resultTabIds |
List<String> | ➖ | The unique IDs of the result tabs to which this response belongs. | |
resultsDescription |
Optional<ResultsDescription> | ➖ | N/A | |
rewrittenFacetFilters |
List<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<String> | ➖ | Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query. | |
hasMoreResults |
Optional<Boolean> | ➖ | Whether more results are available. Use cursor to retrieve them. |