Class SearchResponse (0.12.3)

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

Response message for SearchService.Search method.

Attributes
Name	Description
`results`	`MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchResponse.SearchResult]` A list of matched documents. The order represents the ranking.
`facets`	`MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchResponse.Facet]` Results of facets requested by user.
`guided_search_result`	`google.cloud.discoveryengine_v1alpha.types.SearchResponse.GuidedSearchResult` 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. This also helps to identify a request during the customer support scenarios.
`redirect_uri`	`str` The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
`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.
`summary`	`google.cloud.discoveryengine_v1alpha.types.SearchResponse.Summary` 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.
`query_expansion_info`	`google.cloud.discoveryengine_v1alpha.types.SearchResponse.QueryExpansionInfo` Query expansion information for the returned results.
`natural_language_query_understanding_info`	`google.cloud.discoveryengine_v1alpha.types.SearchResponse.NaturalLanguageQueryUnderstandingInfo` Natural language query understanding information for the returned results.
`session_info`	`google.cloud.discoveryengine_v1alpha.types.SearchResponse.SessionInfo` Session information. Only set if SearchRequest.session is provided. See its description for more details.
`one_box_results`	`MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchResponse.OneBoxResult]` A list of One Box results. There can be multiple One Box results of different types.

Classes

Facet

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

A facet result.

GeoSearchDebugInfo

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

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

GuidedSearchResult

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.

NaturalLanguageQueryUnderstandingInfo

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

Information describing what natural language understanding was done on the input query.

OneBoxResult

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

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

QueryExpansionInfo

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

Information describing query expansion including whether expansion has occurred.

SearchResult

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

Represents the search results.

SessionInfo

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

Information about the session.

Summary

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

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