public sealed class SearchResponse : IMessage<SearchResponse>, IEquatable<SearchResponse>, IDeepCloneable<SearchResponse>, IBufferMessage, IMessage, IPageResponse<SearchResponse.Types.SearchResult>, IEnumerable<SearchResponse.Types.SearchResult>, IEnumerableReference documentation and code samples for the Retail v2 API class SearchResponse.
Response message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.
Implements
IMessageSearchResponse, IEquatableSearchResponse, IDeepCloneableSearchResponse, IBufferMessage, IMessage, IPageResponseSearchResponseTypesSearchResult, IEnumerableSearchResponseTypesSearchResult, IEnumerableNamespace
Google.Cloud.Retail.V2Assembly
Google.Cloud.Retail.V2.dll
Constructors
SearchResponse()
public SearchResponse()SearchResponse(SearchResponse)
public SearchResponse(SearchResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponse |
Properties
AppliedControls
public RepeatedField<string> AppliedControls { get; }The fully qualified resource name of applied controls.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
AttributionToken
public string AttributionToken { get; set; }A unique search token. This should be included in the [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ConversationalSearchResult
public SearchResponse.Types.ConversationalSearchResult ConversationalSearchResult { get; set; }This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
| Property Value | |
|---|---|
| Type | Description |
SearchResponseTypesConversationalSearchResult |
|
CorrectedQuery
public string CorrectedQuery { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExperimentInfo
public RepeatedField<ExperimentInfo> ExperimentInfo { get; }Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldExperimentInfo |
|
Facets
public RepeatedField<SearchResponse.Types.Facet> Facets { get; }Results of facets requested by user.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSearchResponseTypesFacet |
|
InvalidConditionBoostSpecs
public RepeatedField<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec> InvalidConditionBoostSpecs { get; }The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSearchRequestTypesBoostSpecTypesConditionBoostSpec |
|
NextPageToken
public string NextPageToken { get; set; }A token that can be sent as [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PinControlMetadata
public PinControlMetadata PinControlMetadata { get; set; }Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied.
The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
| Property Value | |
|---|---|
| Type | Description |
PinControlMetadata |
|
QueryExpansionInfo
public SearchResponse.Types.QueryExpansionInfo QueryExpansionInfo { get; set; }Query expansion information for the returned results.
| Property Value | |
|---|---|
| Type | Description |
SearchResponseTypesQueryExpansionInfo |
|
RedirectUri
public string RedirectUri { get; set; }The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token] are set in the response.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Results
public RepeatedField<SearchResponse.Types.SearchResult> Results { get; }A list of matched items. The order represents the ranking.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSearchResponseTypesSearchResult |
|
TileNavigationResult
public SearchResponse.Types.TileNavigationResult TileNavigationResult { get; set; }This field specifies all related information for tile navigation that will be used in client side.
| Property Value | |
|---|---|
| Type | Description |
SearchResponseTypesTileNavigationResult |
|
TotalSize
public int TotalSize { get; set; }The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.retail.v2.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.retail.v2.SearchResponse.total_size] that matches.
| Property Value | |
|---|---|
| Type | Description |
int |
|
Methods
GetEnumerator()
public IEnumerator<SearchResponse.Types.SearchResult> GetEnumerator()Returns an enumerator that iterates through the resources in this response.
| Returns | |
|---|---|
| Type | Description |
IEnumeratorSearchResponseTypesSearchResult |
|