- 2.55.0 (latest)
- 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 final class SearchResponse.ConversationalSearchResult.Builder extends GeneratedMessageV3.Builder<SearchResponse.ConversationalSearchResult.Builder> implements SearchResponse.ConversationalSearchResultOrBuilderThis field specifies all related information that is needed on client side for UI rendering of conversational retail search.
Protobuf type google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.ConversationalSearchResult.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAdditionalFilters(SearchResponse.ConversationalSearchResult.AdditionalFilter value) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder addAdditionalFilters(SearchResponse.ConversationalSearchResult.AdditionalFilter value) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addAdditionalFilters(SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder addAdditionalFilters(SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter value) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder addAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter value) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder addAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addAdditionalFiltersBuilder() (deprecated)
public SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder addAdditionalFiltersBuilder() 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
|
addAdditionalFiltersBuilder(int index) (deprecated)
public SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder addAdditionalFiltersBuilder(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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
|
addAllAdditionalFilters(Iterable<? extends SearchResponse.ConversationalSearchResult.AdditionalFilter> values) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder addAllAdditionalFilters(Iterable<? extends SearchResponse.ConversationalSearchResult.AdditionalFilter> values) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addAllSuggestedAnswers(Iterable<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswer> values)
public SearchResponse.ConversationalSearchResult.Builder addAllSuggestedAnswers(Iterable<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswer> values)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.ConversationalSearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addSuggestedAnswers(SearchResponse.ConversationalSearchResult.SuggestedAnswer value)
public SearchResponse.ConversationalSearchResult.Builder addSuggestedAnswers(SearchResponse.ConversationalSearchResult.SuggestedAnswer value)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult.SuggestedAnswer |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addSuggestedAnswers(SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)
public SearchResponse.ConversationalSearchResult.Builder addSuggestedAnswers(SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer value)
public SearchResponse.ConversationalSearchResult.Builder addSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer value)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.ConversationalSearchResult.SuggestedAnswer |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)
public SearchResponse.ConversationalSearchResult.Builder addSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
addSuggestedAnswersBuilder()
public SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder addSuggestedAnswersBuilder()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
|
addSuggestedAnswersBuilder(int index)
public SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder addSuggestedAnswersBuilder(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
|
build()
public SearchResponse.ConversationalSearchResult build()| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult |
|
buildPartial()
public SearchResponse.ConversationalSearchResult buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult |
|
clear()
public SearchResponse.ConversationalSearchResult.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clearAdditionalFilter()
public SearchResponse.ConversationalSearchResult.Builder clearAdditionalFilter()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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clearAdditionalFilters() (deprecated)
public SearchResponse.ConversationalSearchResult.Builder clearAdditionalFilters() 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clearConversationId()
public SearchResponse.ConversationalSearchResult.Builder clearConversationId()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 |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.ConversationalSearchResult.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clearFollowupQuestion()
public SearchResponse.ConversationalSearchResult.Builder clearFollowupQuestion() The follow-up question. e.g., What is the color?
string followup_question = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.ConversationalSearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clearRefinedQuery()
public SearchResponse.ConversationalSearchResult.Builder clearRefinedQuery() 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 |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
clearSuggestedAnswers()
public SearchResponse.ConversationalSearchResult.Builder clearSuggestedAnswers()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
clone()
public SearchResponse.ConversationalSearchResult.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
getAdditionalFilter()
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
The additionalFilter. |
getAdditionalFilterBuilder()
public SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder getAdditionalFilterBuilder()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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
|
getAdditionalFilterOrBuilder()
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder |
|
getAdditionalFilters(int index) (deprecated)
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
|
getAdditionalFiltersBuilder(int index) (deprecated)
public SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder getAdditionalFiltersBuilder(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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
|
getAdditionalFiltersBuilderList() (deprecated)
public List<SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder> getAdditionalFiltersBuilderList() 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getAdditionalFiltersCount() (deprecated)
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAdditionalFiltersList() (deprecated)
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<AdditionalFilter> |
|
getAdditionalFiltersOrBuilder(int index) (deprecated)
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder |
|
getAdditionalFiltersOrBuilderList() (deprecated)
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder> |
|
getConversationId()
public 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 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. |
getDefaultInstanceForType()
public SearchResponse.ConversationalSearchResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFollowupQuestion()
public String getFollowupQuestion() The follow-up question. e.g., What is the color?
string followup_question = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The followupQuestion. |
getFollowupQuestionBytes()
public 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 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 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 SearchResponse.ConversationalSearchResult.SuggestedAnswer getSuggestedAnswers(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswer |
|
getSuggestedAnswersBuilder(int index)
public SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder getSuggestedAnswersBuilder(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
|
getSuggestedAnswersBuilderList()
public List<SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder> getSuggestedAnswersBuilderList()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getSuggestedAnswersCount()
public int getSuggestedAnswersCount()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getSuggestedAnswersList()
public List<SearchResponse.ConversationalSearchResult.SuggestedAnswer> getSuggestedAnswersList()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
List<SuggestedAnswer> |
|
getSuggestedAnswersOrBuilder(int index)
public SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder getSuggestedAnswersOrBuilder(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder |
|
getSuggestedAnswersOrBuilderList()
public List<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder> getSuggestedAnswersOrBuilderList()The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder> |
|
hasAdditionalFilter()
public 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the additionalFilter field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter value)
public SearchResponse.ConversationalSearchResult.Builder mergeAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter value)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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
mergeFrom(SearchResponse.ConversationalSearchResult other)
public SearchResponse.ConversationalSearchResult.Builder mergeFrom(SearchResponse.ConversationalSearchResult other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponse.ConversationalSearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.ConversationalSearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResponse.ConversationalSearchResult.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.ConversationalSearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
removeAdditionalFilters(int index) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder removeAdditionalFilters(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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
removeSuggestedAnswers(int index)
public SearchResponse.ConversationalSearchResult.Builder removeSuggestedAnswers(int index)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter value)
public SearchResponse.ConversationalSearchResult.Builder setAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter value)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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue)
public SearchResponse.ConversationalSearchResult.Builder setAdditionalFilter(SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue)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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter value) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder setAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter value) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.ConversationalSearchResult.AdditionalFilter |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) (deprecated)
public SearchResponse.ConversationalSearchResult.Builder setAdditionalFilters(int index, SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder builderForValue) 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.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.ConversationalSearchResult.AdditionalFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setConversationId(String value)
public SearchResponse.ConversationalSearchResult.Builder setConversationId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setConversationIdBytes(ByteString value)
public SearchResponse.ConversationalSearchResult.Builder setConversationIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.ConversationalSearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setFollowupQuestion(String value)
public SearchResponse.ConversationalSearchResult.Builder setFollowupQuestion(String value) The follow-up question. e.g., What is the color?
string followup_question = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe followupQuestion to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setFollowupQuestionBytes(ByteString value)
public SearchResponse.ConversationalSearchResult.Builder setFollowupQuestionBytes(ByteString value) The follow-up question. e.g., What is the color?
string followup_question = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for followupQuestion to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setRefinedQuery(String value)
public SearchResponse.ConversationalSearchResult.Builder setRefinedQuery(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe refinedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setRefinedQueryBytes(ByteString value)
public SearchResponse.ConversationalSearchResult.Builder setRefinedQueryBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for refinedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.ConversationalSearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer value)
public SearchResponse.ConversationalSearchResult.Builder setSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer value)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.ConversationalSearchResult.SuggestedAnswer |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)
public SearchResponse.ConversationalSearchResult.Builder setSuggestedAnswers(int index, SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder builderForValue)The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.ConversationalSearchResult.SuggestedAnswer.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.ConversationalSearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult.Builder |
|