Discovery Engine v1beta API - Class SearchResponse (1.0.0-beta24) 

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 Discovery Engine v1beta API class SearchResponse.

Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.

Inheritance

object > SearchResponse

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SearchResponse()

public SearchResponse()

SearchResponse(SearchResponse)

public SearchResponse(SearchResponse other)
Parameter
Name Description
other SearchResponse

Properties

AppliedControls

public RepeatedField<string> AppliedControls { get; }

Controls applied as part of the Control service.

Property Value
Type Description
RepeatedFieldstring

AttributionToken

public string AttributionToken { get; set; }

A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.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.

Property Value
Type Description
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
string

Facets

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

Results of facets requested by user.

Property Value
Type Description
RepeatedFieldSearchResponseTypesFacet

GeoSearchDebugInfo

public RepeatedField<SearchResponse.Types.GeoSearchDebugInfo> GeoSearchDebugInfo { get; }
Property Value
Type Description
RepeatedFieldSearchResponseTypesGeoSearchDebugInfo

GuidedSearchResult

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

Guided search result.

Property Value
Type Description
SearchResponseTypesGuidedSearchResult

NaturalLanguageQueryUnderstandingInfo

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

Output only. Natural language query understanding information for the returned results.

Property Value
Type Description
SearchResponseTypesNaturalLanguageQueryUnderstandingInfo

NextPageToken

public string NextPageToken { get; set; }

A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.

Property Value
Type Description
string

OneBoxResults

public RepeatedField<SearchResponse.Types.OneBoxResult> OneBoxResults { get; }

A list of One Box results. There can be multiple One Box results of different types.

Property Value
Type Description
RepeatedFieldSearchResponseTypesOneBoxResult

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.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

Property Value
Type Description
RepeatedFieldSearchResponseTypesSearchResult

SearchLinkPromotions

public RepeatedField<SearchLinkPromotion> SearchLinkPromotions { get; }

Promotions for site search.

Property Value
Type Description
RepeatedFieldSearchLinkPromotion

SemanticState

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

Output only. Indicates the semantic state of the search response.

Property Value
Type Description
SearchResponseTypesSemanticState

SessionInfo

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

Session information.

Only set if [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] is provided. See its description for more details.

Property Value
Type Description
SearchResponseTypesSessionInfo

SuggestedQuery

public string SuggestedQuery { get; set; }

Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).

Property Value
Type Description
string

Summary

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

A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.

Property Value
Type Description
SearchResponseTypesSummary

TotalSize

public int TotalSize { get; set; }

The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.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