Class SearchResponse (0.8.0)

SearchResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Response message for SearchService.Search method.


results MutableSequence[]
A list of matched documents. The order represents the ranking.
facets MutableSequence[]
Results of facets requested by user.
Guided search result.
total_size int
The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
attribution_token str
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
next_page_token str
A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
corrected_query str
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
applied_controls MutableSequence[str]
Controls applied as part of the Control service.



Facet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A facet result.


GuidedSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.


SearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the search results.


Summary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Summary of the top N search result specified by the summary spec.