public interface SearchResponseOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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. |
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. |
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> |
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. |