- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static interface SearchResponse.ConversationalSearchResultOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdditionalFilter()
public abstract SearchResponse.ConversationalSearchResult.AdditionalFilter getAdditionalFilter()This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
The additionalFilter. |
getAdditionalFilterOrBuilder()
public abstract SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder getAdditionalFilterOrBuilder()This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder |
|
getAdditionalFilters(int index) (deprecated)
public abstract SearchResponse.ConversationalSearchResult.AdditionalFilter getAdditionalFilters(int index) This field is deprecated but will be kept for backward compatibility.
There is expected to have only one additional filter and the value will
be the same to the same as field additional_filter.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
|
getAdditionalFiltersCount() (deprecated)
public abstract int getAdditionalFiltersCount() This field is deprecated but will be kept for backward compatibility.
There is expected to have only one additional filter and the value will
be the same to the same as field additional_filter.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAdditionalFiltersList() (deprecated)
public abstract List<SearchResponse.ConversationalSearchResult.AdditionalFilter> getAdditionalFiltersList() This field is deprecated but will be kept for backward compatibility.
There is expected to have only one additional filter and the value will
be the same to the same as field additional_filter.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<AdditionalFilter> |
|
getAdditionalFiltersOrBuilder(int index) (deprecated)
public abstract SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder getAdditionalFiltersOrBuilder(int index) This field is deprecated but will be kept for backward compatibility.
There is expected to have only one additional filter and the value will
be the same to the same as field additional_filter.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder |
|
getAdditionalFiltersOrBuilderList() (deprecated)
public abstract List<? extends SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder> getAdditionalFiltersOrBuilderList() This field is deprecated but will be kept for backward compatibility.
There is expected to have only one additional filter and the value will
be the same to the same as field additional_filter.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder> |
|
getConversationId()
public abstract String getConversationId()Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
string conversation_id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The conversationId. |
getConversationIdBytes()
public abstract ByteString getConversationIdBytes()Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.
string conversation_id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for conversationId. |
getFollowupQuestion()
public abstract String getFollowupQuestion() The follow-up question. e.g., What is the color?
string followup_question = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The followupQuestion. |
getFollowupQuestionBytes()
public abstract ByteString getFollowupQuestionBytes() The follow-up question. e.g., What is the color?
string followup_question = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for followupQuestion. |
getRefinedQuery()
public abstract String getRefinedQuery() The current refined query for the conversational search. This field
will be used in customer UI that the query in the search bar should be
replaced with the refined query. For example, if
SearchRequest.query is
dress and next
SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer
is red color, which does not match any product attribute value filters,
the refined query will be dress, red color.
string refined_query = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The refinedQuery. |
getRefinedQueryBytes()
public abstract ByteString getRefinedQueryBytes() The current refined query for the conversational search. This field
will be used in customer UI that the query in the search bar should be
replaced with the refined query. For example, if
SearchRequest.query is
dress and next
SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer
is red color, which does not match any product attribute value filters,
the refined query will be dress, red color.
string refined_query = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for refinedQuery. |
getSuggestedAnswers(int index)
public abstract SearchResponse.ConversationalSearchResult.SuggestedAnswer getSuggestedAnswers(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswer |
|
getSuggestedAnswersCount()
public abstract int getSuggestedAnswersCount()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getSuggestedAnswersList()
public abstract List<SearchResponse.ConversationalSearchResult.SuggestedAnswer> getSuggestedAnswersList()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
List<SuggestedAnswer> |
|
getSuggestedAnswersOrBuilder(int index)
public abstract SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder getSuggestedAnswersOrBuilder(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder |
|
getSuggestedAnswersOrBuilderList()
public abstract List<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder> getSuggestedAnswersOrBuilderList()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder> |
|
hasAdditionalFilter()
public abstract boolean hasAdditionalFilter()This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the additionalFilter field is set. |