- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface SearchResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAppliedControls(int index)
public abstract String getAppliedControls(int index)Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The appliedControls at the given index. |
getAppliedControlsBytes(int index)
public abstract ByteString getAppliedControlsBytes(int index)Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the appliedControls at the given index. |
getAppliedControlsCount()
public abstract int getAppliedControlsCount()Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The count of appliedControls. |
getAppliedControlsList()
public abstract List<String> getAppliedControlsList()Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the appliedControls. |
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.
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.
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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.FacetOrBuilder> |
|
getGeoSearchDebugInfo(int index)
public abstract SearchResponse.GeoSearchDebugInfo getGeoSearchDebugInfo(int index)
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.GeoSearchDebugInfo |
|
getGeoSearchDebugInfoCount()
public abstract int getGeoSearchDebugInfoCount()
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Returns | |
|---|---|
| Type | Description |
int |
|
getGeoSearchDebugInfoList()
public abstract List<SearchResponse.GeoSearchDebugInfo> getGeoSearchDebugInfoList()
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Returns | |
|---|---|
| Type | Description |
List<GeoSearchDebugInfo> |
|
getGeoSearchDebugInfoOrBuilder(int index)
public abstract SearchResponse.GeoSearchDebugInfoOrBuilder getGeoSearchDebugInfoOrBuilder(int index)
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.GeoSearchDebugInfoOrBuilder |
|
getGeoSearchDebugInfoOrBuilderList()
public abstract List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder> getGeoSearchDebugInfoOrBuilderList()
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfoOrBuilder> |
|
getGuidedSearchResult()
public abstract SearchResponse.GuidedSearchResult getGuidedSearchResult()Guided search result.
.google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult guided_search_result = 8;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.GuidedSearchResult |
The guidedSearchResult. |
getGuidedSearchResultOrBuilder()
public abstract SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()Guided search result.
.google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult guided_search_result = 8;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.GuidedSearchResultOrBuilder |
|
getNaturalLanguageQueryUnderstandingInfo()
public abstract SearchResponse.NaturalLanguageQueryUnderstandingInfo getNaturalLanguageQueryUnderstandingInfo()Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.NaturalLanguageQueryUnderstandingInfo |
The naturalLanguageQueryUnderstandingInfo. |
getNaturalLanguageQueryUnderstandingInfoOrBuilder()
public abstract SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder getNaturalLanguageQueryUnderstandingInfoOrBuilder()Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder |
|
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. |
getOneBoxResults(int index)
public abstract SearchResponse.OneBoxResult getOneBoxResults(int index)A list of One Box results. There can be multiple One Box results of different types.
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult one_box_results = 20;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.OneBoxResult |
|
getOneBoxResultsCount()
public abstract int getOneBoxResultsCount()A list of One Box results. There can be multiple One Box results of different types.
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult one_box_results = 20;
| Returns | |
|---|---|
| Type | Description |
int |
|
getOneBoxResultsList()
public abstract List<SearchResponse.OneBoxResult> getOneBoxResultsList()A list of One Box results. There can be multiple One Box results of different types.
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult one_box_results = 20;
| Returns | |
|---|---|
| Type | Description |
List<OneBoxResult> |
|
getOneBoxResultsOrBuilder(int index)
public abstract SearchResponse.OneBoxResultOrBuilder getOneBoxResultsOrBuilder(int index)A list of One Box results. There can be multiple One Box results of different types.
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult one_box_results = 20;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.OneBoxResultOrBuilder |
|
getOneBoxResultsOrBuilderList()
public abstract List<? extends SearchResponse.OneBoxResultOrBuilder> getOneBoxResultsOrBuilderList()A list of One Box results. There can be multiple One Box results of different types.
repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult one_box_results = 20;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResultOrBuilder> |
|
getQueryExpansionInfo()
public abstract SearchResponse.QueryExpansionInfo getQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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. |
hasGuidedSearchResult()
public abstract boolean hasGuidedSearchResult()Guided search result.
.google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult guided_search_result = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the guidedSearchResult field is set. |
hasNaturalLanguageQueryUnderstandingInfo()
public abstract boolean hasNaturalLanguageQueryUnderstandingInfo()Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the naturalLanguageQueryUnderstandingInfo field is set. |
hasQueryExpansionInfo()
public abstract boolean hasQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.Summary summary = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the summary field is set. |