public static final class SearchResponse.ConversationalSearchResult extends com.google.protobuf.GeneratedMessageV3 implements SearchResponse.ConversationalSearchResultOrBuilder
This field specifies all related information that is needed on client side for UI rendering of conversational retail search.Protobuf type
google.cloud.retail.v2.SearchResponse.ConversationalSearchResult| Modifier and Type | Class and Description |
|---|---|
static class |
SearchResponse.ConversationalSearchResult.AdditionalFilter
Additional filter that client side need to apply.
|
static interface |
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder |
static class |
SearchResponse.ConversationalSearchResult.Builder
This field specifies all related information that is needed on client
side for UI rendering of conversational retail search.
|
static class |
SearchResponse.ConversationalSearchResult.SuggestedAnswer
Suggested answers to the follow-up question.
|
static interface |
SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ADDITIONAL_FILTER_FIELD_NUMBER |
static int |
ADDITIONAL_FILTERS_FIELD_NUMBER |
static int |
CONVERSATION_ID_FIELD_NUMBER |
static int |
FOLLOWUP_QUESTION_FIELD_NUMBER |
static int |
REFINED_QUERY_FIELD_NUMBER |
static int |
SUGGESTED_ANSWERS_FIELD_NUMBER |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int CONVERSATION_ID_FIELD_NUMBER
public static final int REFINED_QUERY_FIELD_NUMBER
public static final int ADDITIONAL_FILTERS_FIELD_NUMBER
public static final int FOLLOWUP_QUESTION_FIELD_NUMBER
public static final int SUGGESTED_ANSWERS_FIELD_NUMBER
public static final int ADDITIONAL_FILTER_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.
string conversation_id = 1;getConversationId in interface SearchResponse.ConversationalSearchResultOrBuilderpublic com.google.protobuf.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][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.
string conversation_id = 1;getConversationIdBytes in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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][google.cloud.retail.v2.SearchRequest.query] is `dress` and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.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;getRefinedQuery in interface SearchResponse.ConversationalSearchResultOrBuilderpublic com.google.protobuf.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][google.cloud.retail.v2.SearchRequest.query] is `dress` and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.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;getRefinedQueryBytes in interface SearchResponse.ConversationalSearchResultOrBuilder@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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
getAdditionalFiltersList in interface SearchResponse.ConversationalSearchResultOrBuilder@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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
getAdditionalFiltersOrBuilderList in interface SearchResponse.ConversationalSearchResultOrBuilder@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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
getAdditionalFiltersCount in interface SearchResponse.ConversationalSearchResultOrBuilder@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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
getAdditionalFilters in interface SearchResponse.ConversationalSearchResultOrBuilder@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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];
getAdditionalFiltersOrBuilder in interface SearchResponse.ConversationalSearchResultOrBuilderpublic String getFollowupQuestion()
The follow-up question. e.g., `What is the color?`
string followup_question = 4;getFollowupQuestion in interface SearchResponse.ConversationalSearchResultOrBuilderpublic com.google.protobuf.ByteString getFollowupQuestionBytes()
The follow-up question. e.g., `What is the color?`
string followup_question = 4;getFollowupQuestionBytes in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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;
getSuggestedAnswersList in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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;
getSuggestedAnswersOrBuilderList in interface SearchResponse.ConversationalSearchResultOrBuilderpublic int getSuggestedAnswersCount()
The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;
getSuggestedAnswersCount in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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;
getSuggestedAnswers in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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;
getSuggestedAnswersOrBuilder in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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][google.cloud.retail.v2.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
hasAdditionalFilter in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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][google.cloud.retail.v2.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
getAdditionalFilter in interface SearchResponse.ConversationalSearchResultOrBuilderpublic 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][google.cloud.retail.v2.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;
getAdditionalFilterOrBuilder in interface SearchResponse.ConversationalSearchResultOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(InputStream input) throws IOException
IOExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SearchResponse.ConversationalSearchResult.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SearchResponse.ConversationalSearchResult.Builder newBuilder()
public static SearchResponse.ConversationalSearchResult.Builder newBuilder(SearchResponse.ConversationalSearchResult prototype)
public SearchResponse.ConversationalSearchResult.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SearchResponse.ConversationalSearchResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static SearchResponse.ConversationalSearchResult getDefaultInstance()
public static com.google.protobuf.Parser<SearchResponse.ConversationalSearchResult> parser()
public com.google.protobuf.Parser<SearchResponse.ConversationalSearchResult> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public SearchResponse.ConversationalSearchResult getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.