Package com.google.cloud.retail.v2alpha
Class SearchResponse.ConversationalSearchResult
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult
- All Implemented Interfaces:
SearchResponse.ConversationalSearchResultOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
- Enclosing class:
- SearchResponse
public static final class SearchResponse.ConversationalSearchResult
extends com.google.protobuf.GeneratedMessage
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.v2alpha.SearchResponse.ConversationalSearchResult- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAdditional filter that client side need to apply.static interfacestatic final classThis field specifies all related information that is needed on client side for UI rendering of conversational retail search.static final classSuggested answers to the follow-up question.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanThis is the incremental additional filters implied from the current user answer.This is the incremental additional filters implied from the current user answer.getAdditionalFilters(int index) Deprecated.intDeprecated.Deprecated.getAdditionalFiltersOrBuilder(int index) Deprecated.Deprecated.Conversation UUID.com.google.protobuf.ByteStringConversation UUID.static final com.google.protobuf.Descriptors.DescriptorThe follow-up question. e.g., `What is the color?com.google.protobuf.ByteStringThe follow-up question. e.g., `What is the color?com.google.protobuf.Parser<SearchResponse.ConversationalSearchResult>The current refined query for the conversational search.com.google.protobuf.ByteStringThe current refined query for the conversational search.intgetSuggestedAnswers(int index) The answer options provided to client for the follow-up question.intThe answer options provided to client for the follow-up question.The answer options provided to client for the follow-up question.getSuggestedAnswersOrBuilder(int index) The answer options provided to client for the follow-up question.The answer options provided to client for the follow-up question.booleanThis is the incremental additional filters implied from the current user answer.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<SearchResponse.ConversationalSearchResult>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
CONVERSATION_ID_FIELD_NUMBER
public static final int CONVERSATION_ID_FIELD_NUMBER- See Also:
-
REFINED_QUERY_FIELD_NUMBER
public static final int REFINED_QUERY_FIELD_NUMBER- See Also:
-
ADDITIONAL_FILTERS_FIELD_NUMBER
public static final int ADDITIONAL_FILTERS_FIELD_NUMBER- See Also:
-
FOLLOWUP_QUESTION_FIELD_NUMBER
public static final int FOLLOWUP_QUESTION_FIELD_NUMBER- See Also:
-
SUGGESTED_ANSWERS_FIELD_NUMBER
public static final int SUGGESTED_ANSWERS_FIELD_NUMBER- See Also:
-
ADDITIONAL_FILTER_FIELD_NUMBER
public static final int ADDITIONAL_FILTER_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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.v2alpha.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.
string conversation_id = 1;- Specified by:
getConversationIdin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The conversationId.
-
getConversationIdBytes
public 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.v2alpha.SearchRequest.ConversationalSearchSpec.conversation_id] to restore conversation state in server.
string conversation_id = 1;- Specified by:
getConversationIdBytesin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The bytes for conversationId.
-
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.v2alpha.SearchRequest.query] is `dress` and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2alpha.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;- Specified by:
getRefinedQueryin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The refinedQuery.
-
getRefinedQueryBytes
public 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.v2alpha.SearchRequest.query] is `dress` and next [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2alpha.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;- Specified by:
getRefinedQueryBytesin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The bytes for refinedQuery.
-
getAdditionalFiltersList
@Deprecated public List<SearchResponse.ConversationalSearchResult.AdditionalFilter> getAdditionalFiltersList()Deprecated.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];- Specified by:
getAdditionalFiltersListin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getAdditionalFiltersOrBuilderList
@Deprecated public List<? extends SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder> getAdditionalFiltersOrBuilderList()Deprecated.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];- Specified by:
getAdditionalFiltersOrBuilderListin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getAdditionalFiltersCount
Deprecated.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];- Specified by:
getAdditionalFiltersCountin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getAdditionalFilters
@Deprecated public SearchResponse.ConversationalSearchResult.AdditionalFilter getAdditionalFilters(int index) Deprecated.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];- Specified by:
getAdditionalFiltersin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getAdditionalFiltersOrBuilder
@Deprecated public SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder getAdditionalFiltersOrBuilder(int index) Deprecated.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];- Specified by:
getAdditionalFiltersOrBuilderin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getFollowupQuestion
The follow-up question. e.g., `What is the color?`
string followup_question = 4;- Specified by:
getFollowupQuestionin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The followupQuestion.
-
getFollowupQuestionBytes
public com.google.protobuf.ByteString getFollowupQuestionBytes()The follow-up question. e.g., `What is the color?`
string followup_question = 4;- Specified by:
getFollowupQuestionBytesin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The bytes for followupQuestion.
-
getSuggestedAnswersList
The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;- Specified by:
getSuggestedAnswersListin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
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;- Specified by:
getSuggestedAnswersOrBuilderListin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
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;- Specified by:
getSuggestedAnswersCountin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getSuggestedAnswers
The answer options provided to client for the follow-up question.
repeated .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;- Specified by:
getSuggestedAnswersin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
getSuggestedAnswersOrBuilder
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;- Specified by:
getSuggestedAnswersOrBuilderin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
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][google.cloud.retail.v2alpha.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;- Specified by:
hasAdditionalFilterin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- Whether the additionalFilter field is set.
-
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.v2alpha.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;- Specified by:
getAdditionalFilterin interfaceSearchResponse.ConversationalSearchResultOrBuilder- Returns:
- The additionalFilter.
-
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][google.cloud.retail.v2alpha.SearchRequest.filter], and use the merged filter in the follow up search request.
.google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;- Specified by:
getAdditionalFilterOrBuilderin interfaceSearchResponse.ConversationalSearchResultOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static SearchResponse.ConversationalSearchResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SearchResponse.ConversationalSearchResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static SearchResponse.ConversationalSearchResult.Builder newBuilder(SearchResponse.ConversationalSearchResult prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SearchResponse.ConversationalSearchResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-