Retail v2 API - Class SearchResponse (2.3.0)

public sealed class SearchResponse : IMessage<SearchResponse>, IEquatable<SearchResponse>, IDeepCloneable<SearchResponse>, IBufferMessage, IMessage, IPageResponse<SearchResponse.Types.SearchResult>, IEnumerable<SearchResponse.Types.SearchResult>, IEnumerable

Reference documentation and code samples for the Retail v2 API class SearchResponse.

Response message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.

Inheritance

Object > SearchResponse

Implements

IMessage<SearchResponse>, IEquatable<SearchResponse>, IDeepCloneable<SearchResponse>, IBufferMessage, IMessage, IPageResponse<SearchResponse.Types.SearchResult>, IEnumerable<SearchResponse.Types.SearchResult>, IEnumerable

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

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
`RepeatedField<System.String>`

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
`System.String`

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
`System.String`

Facets

public RepeatedField<SearchResponse.Types.Facet> Facets { get; }

Results of facets requested by user.

Property Value
Type	Description
`RepeatedField<SearchResponse.Types.Facet>`

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
`RepeatedField<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec>`

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
`System.String`

QueryExpansionInfo

public SearchResponse.Types.QueryExpansionInfo QueryExpansionInfo { get; set; }

Query expansion information for the returned results.

Property Value
Type	Description
`SearchResponse.Types.QueryExpansionInfo`

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
`System.String`

Results

public RepeatedField<SearchResponse.Types.SearchResult> Results { get; }

A list of matched items. The order represents the ranking.

Property Value
Type	Description
`RepeatedField<SearchResponse.Types.SearchResult>`

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
`Int32`

Methods

GetEnumerator()

public IEnumerator<SearchResponse.Types.SearchResult> GetEnumerator()

Returns an enumerator that iterates through the resources in this response.

Returns
Type	Description
`IEnumerator<SearchResponse.Types.SearchResult>`

Explicit Interface Implementations

IEnumerable.GetEnumerator()

IEnumerator IEnumerable.GetEnumerator()

Returns
Type	Description
`IEnumerator`