Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class SearchResponse.
Response message for SearchService.Search method.
Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchResponse
Namespace
Google \ Cloud \ DiscoveryEngine \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ results
array< Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\SearchResult
>
A list of matched documents. The order represents the ranking.
↳ facets
array< Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\Facet
>
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
string
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
↳ redirect_uri
string
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
string
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
string
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\V1beta\SearchResponse\Summary
A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
↳ applied_controls
array
Controls applied as part of the Control service.
getResults
A list of matched documents. The order represents the ranking.
setResults
A list of matched documents. The order represents the ranking.
$this
getFacets
Results of facets requested by user.
setFacets
Results of facets requested by user.
$this
getGuidedSearchResult
Guided search result.
hasGuidedSearchResult
clearGuidedSearchResult
setGuidedSearchResult
Guided search result.
$this
getTotalSize
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.
int
setTotalSize
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.
var
int
$this
getAttributionToken
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string
setAttributionToken
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
var
string
$this
getRedirectUri
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.
string
setRedirectUri
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.
var
string
$this
getNextPageToken
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.
string
setNextPageToken
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.
var
string
$this
getCorrectedQuery
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.
string
setCorrectedQuery
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.
var
string
$this
getSummary
A summary as part of the search results.
This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
hasSummary
clearSummary
setSummary
A summary as part of the search results.
This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
$this
getAppliedControls
Controls applied as part of the Control service.
setAppliedControls
Controls applied as part of the Control service.
var
string[]
$this
