Interface SearchResponseOrBuilder (0.47.0)

public interface SearchResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAttributionToken()

public abstract String 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. This also helps to identify a request during the customer support scenarios.

string attribution_token = 4;

Returns
Type Description
String

The attributionToken.

getAttributionTokenBytes()

public abstract ByteString getAttributionTokenBytes()

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.

string attribution_token = 4;

Returns
Type Description
ByteString

The bytes for attributionToken.

getCorrectedQuery()

public abstract String 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 corrected_query = 7;

Returns
Type Description
String

The correctedQuery.

getCorrectedQueryBytes()

public abstract ByteString getCorrectedQueryBytes()

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 corrected_query = 7;

Returns
Type Description
ByteString

The bytes for correctedQuery.

getFacets(int index)

public abstract SearchResponse.Facet getFacets(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Facet

getFacetsCount()

public abstract int getFacetsCount()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type Description
int

getFacetsList()

public abstract List<SearchResponse.Facet> getFacetsList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type Description
List<Facet>

getFacetsOrBuilder(int index)

public abstract SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.FacetOrBuilder

getFacetsOrBuilderList()

public abstract List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.FacetOrBuilder>

getNextPageToken()

public abstract String 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 next_page_token = 5;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract ByteString getNextPageTokenBytes()

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 next_page_token = 5;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getQueryExpansionInfo()

public abstract SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type Description
SearchResponse.QueryExpansionInfo

The queryExpansionInfo.

getQueryExpansionInfoOrBuilder()

public abstract SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type Description
SearchResponse.QueryExpansionInfoOrBuilder

getRedirectUri()

public abstract String 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 redirect_uri = 12;

Returns
Type Description
String

The redirectUri.

getRedirectUriBytes()

public abstract ByteString getRedirectUriBytes()

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 redirect_uri = 12;

Returns
Type Description
ByteString

The bytes for redirectUri.

getResults(int index)

public abstract SearchResponse.SearchResult getResults(int index)

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

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.SearchResult

getResultsCount()

public abstract int getResultsCount()

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

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type Description
int

getResultsList()

public abstract List<SearchResponse.SearchResult> getResultsList()

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

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type Description
List<SearchResult>

getResultsOrBuilder(int index)

public abstract SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.SearchResultOrBuilder

getResultsOrBuilderList()

public abstract List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()

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

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResultOrBuilder>

getSessionInfo()

public abstract SearchResponse.SessionInfo getSessionInfo()

Session information.

Only set if SearchRequest.session is provided. See its description for more details.

.google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

Returns
Type Description
SearchResponse.SessionInfo

The sessionInfo.

getSessionInfoOrBuilder()

public abstract SearchResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()

Session information.

Only set if SearchRequest.session is provided. See its description for more details.

.google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

Returns
Type Description
SearchResponse.SessionInfoOrBuilder

getSummary()

public abstract SearchResponse.Summary getSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type Description
SearchResponse.Summary

The summary.

getSummaryOrBuilder()

public abstract SearchResponse.SummaryOrBuilder getSummaryOrBuilder()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type Description
SearchResponse.SummaryOrBuilder

getTotalSize()

public abstract int 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.

int32 total_size = 3;

Returns
Type Description
int

The totalSize.

hasQueryExpansionInfo()

public abstract boolean hasQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type Description
boolean

Whether the queryExpansionInfo field is set.

hasSessionInfo()

public abstract boolean hasSessionInfo()

Session information.

Only set if SearchRequest.session is provided. See its description for more details.

.google.cloud.discoveryengine.v1.SearchResponse.SessionInfo session_info = 19;

Returns
Type Description
boolean

Whether the sessionInfo field is set.

hasSummary()

public abstract boolean hasSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type Description
boolean

Whether the summary field is set.