Package com.google.cloud.retail.v2alpha

Class ConversationalSearchResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.ConversationalSearchResponse
All Implemented Interfaces:
ConversationalSearchResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ConversationalSearchResponse extends com.google.protobuf.GeneratedMessage implements ConversationalSearchResponseOrBuilder
 Response message for
 [ConversationalSearchService.ConversationalSearch][google.cloud.retail.v2alpha.ConversationalSearchService.ConversationalSearch]
 method.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchResponse
See Also:

  • Field Details

    • USER_QUERY_TYPES_FIELD_NUMBER

      public static final int USER_QUERY_TYPES_FIELD_NUMBER
      See Also:

    • CONVERSATIONAL_TEXT_RESPONSE_FIELD_NUMBER

      public static final int CONVERSATIONAL_TEXT_RESPONSE_FIELD_NUMBER
      See Also:

    • FOLLOWUP_QUESTION_FIELD_NUMBER

      public static final int FOLLOWUP_QUESTION_FIELD_NUMBER
      See Also:

    • CONVERSATION_ID_FIELD_NUMBER

      public static final int CONVERSATION_ID_FIELD_NUMBER
      See Also:

    • REFINED_SEARCH_FIELD_NUMBER

      public static final int REFINED_SEARCH_FIELD_NUMBER
      See Also:

    • CONVERSATIONAL_FILTERING_RESULT_FIELD_NUMBER

      public static final int CONVERSATIONAL_FILTERING_RESULT_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getUserQueryTypesList

      public com.google.protobuf.ProtocolStringList getUserQueryTypesList()
       The types Retail classifies the search query as.

 Supported values are:

 - "ORDER_SUPPORT"
 - "SIMPLE_PRODUCT_SEARCH"
 - "INTENT_REFINEMENT"
 - "PRODUCT_DETAILS"
 - "PRODUCT_COMPARISON"
 - "DEALS_AND_COUPONS"
 - "STORE_RELEVANT"
 - "BLOCKLISTED"
 - "BEST_PRODUCT"
 - "RETAIL_SUPPORT"
 - "DISABLED"
 clang-format off
 clang-format on
      repeated string user_query_types = 10;
      Specified by:
      getUserQueryTypesList in interface ConversationalSearchResponseOrBuilder
      Returns:
      A list containing the userQueryTypes.

    • getUserQueryTypesCount

      public int getUserQueryTypesCount()
       The types Retail classifies the search query as.

 Supported values are:

 - "ORDER_SUPPORT"
 - "SIMPLE_PRODUCT_SEARCH"
 - "INTENT_REFINEMENT"
 - "PRODUCT_DETAILS"
 - "PRODUCT_COMPARISON"
 - "DEALS_AND_COUPONS"
 - "STORE_RELEVANT"
 - "BLOCKLISTED"
 - "BEST_PRODUCT"
 - "RETAIL_SUPPORT"
 - "DISABLED"
 clang-format off
 clang-format on
      repeated string user_query_types = 10;
      Specified by:
      getUserQueryTypesCount in interface ConversationalSearchResponseOrBuilder
      Returns:
      The count of userQueryTypes.

    • getUserQueryTypes

      public String getUserQueryTypes(int index)
       The types Retail classifies the search query as.

 Supported values are:

 - "ORDER_SUPPORT"
 - "SIMPLE_PRODUCT_SEARCH"
 - "INTENT_REFINEMENT"
 - "PRODUCT_DETAILS"
 - "PRODUCT_COMPARISON"
 - "DEALS_AND_COUPONS"
 - "STORE_RELEVANT"
 - "BLOCKLISTED"
 - "BEST_PRODUCT"
 - "RETAIL_SUPPORT"
 - "DISABLED"
 clang-format off
 clang-format on
      repeated string user_query_types = 10;
      Specified by:
      getUserQueryTypes in interface ConversationalSearchResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The userQueryTypes at the given index.

    • getUserQueryTypesBytes

      public com.google.protobuf.ByteString getUserQueryTypesBytes(int index)
       The types Retail classifies the search query as.

 Supported values are:

 - "ORDER_SUPPORT"
 - "SIMPLE_PRODUCT_SEARCH"
 - "INTENT_REFINEMENT"
 - "PRODUCT_DETAILS"
 - "PRODUCT_COMPARISON"
 - "DEALS_AND_COUPONS"
 - "STORE_RELEVANT"
 - "BLOCKLISTED"
 - "BEST_PRODUCT"
 - "RETAIL_SUPPORT"
 - "DISABLED"
 clang-format off
 clang-format on
      repeated string user_query_types = 10;
      Specified by:
      getUserQueryTypesBytes in interface ConversationalSearchResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the userQueryTypes at the given index.

    • getConversationalTextResponse

      public String getConversationalTextResponse()
       The conversational answer-based text response generated by the Server.
      string conversational_text_response = 2;
      Specified by:
      getConversationalTextResponse in interface ConversationalSearchResponseOrBuilder
      Returns:
      The conversationalTextResponse.

    • getConversationalTextResponseBytes

      public com.google.protobuf.ByteString getConversationalTextResponseBytes()
       The conversational answer-based text response generated by the Server.
      string conversational_text_response = 2;
      Specified by:
      getConversationalTextResponseBytes in interface ConversationalSearchResponseOrBuilder
      Returns:
      The bytes for conversationalTextResponse.

    • hasFollowupQuestion

      public boolean hasFollowupQuestion()
       The conversational followup question generated for Intent refinement.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
      Specified by:
      hasFollowupQuestion in interface ConversationalSearchResponseOrBuilder
      Returns:
      Whether the followupQuestion field is set.

    • getFollowupQuestion

      public ConversationalSearchResponse.FollowupQuestion getFollowupQuestion()
       The conversational followup question generated for Intent refinement.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
      Specified by:
      getFollowupQuestion in interface ConversationalSearchResponseOrBuilder
      Returns:
      The followupQuestion.

    • getFollowupQuestionOrBuilder

      public ConversationalSearchResponse.FollowupQuestionOrBuilder getFollowupQuestionOrBuilder()
       The conversational followup question generated for Intent refinement.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
      Specified by:
      getFollowupQuestionOrBuilder in interface ConversationalSearchResponseOrBuilder

    • 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
 [ConversationalSearchRequest.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchRequest.conversation_id]
 to restore conversation state in server.
      string conversation_id = 4;
      Specified by:
      getConversationId in interface ConversationalSearchResponseOrBuilder
      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
 [ConversationalSearchRequest.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchRequest.conversation_id]
 to restore conversation state in server.
      string conversation_id = 4;
      Specified by:
      getConversationIdBytes in interface ConversationalSearchResponseOrBuilder
      Returns:
      The bytes for conversationId.

    • getRefinedSearchList

      public List<ConversationalSearchResponse.RefinedSearch> getRefinedSearchList()
       The proposed refined search queries. They can be used to fetch the relevant
 search results. When using CONVERSATIONAL_FILTER_ONLY mode, the
 refined_query from search response will be populated here.
      repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;
      Specified by:
      getRefinedSearchList in interface ConversationalSearchResponseOrBuilder

    • getRefinedSearchOrBuilderList

      public List<? extends ConversationalSearchResponse.RefinedSearchOrBuilder> getRefinedSearchOrBuilderList()
       The proposed refined search queries. They can be used to fetch the relevant
 search results. When using CONVERSATIONAL_FILTER_ONLY mode, the
 refined_query from search response will be populated here.
      repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;
      Specified by:
      getRefinedSearchOrBuilderList in interface ConversationalSearchResponseOrBuilder

    • getRefinedSearchCount

      public int getRefinedSearchCount()
       The proposed refined search queries. They can be used to fetch the relevant
 search results. When using CONVERSATIONAL_FILTER_ONLY mode, the
 refined_query from search response will be populated here.
      repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;
      Specified by:
      getRefinedSearchCount in interface ConversationalSearchResponseOrBuilder

    • getRefinedSearch

      public ConversationalSearchResponse.RefinedSearch getRefinedSearch(int index)
       The proposed refined search queries. They can be used to fetch the relevant
 search results. When using CONVERSATIONAL_FILTER_ONLY mode, the
 refined_query from search response will be populated here.
      repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;
      Specified by:
      getRefinedSearch in interface ConversationalSearchResponseOrBuilder

    • getRefinedSearchOrBuilder

      public ConversationalSearchResponse.RefinedSearchOrBuilder getRefinedSearchOrBuilder(int index)
       The proposed refined search queries. They can be used to fetch the relevant
 search results. When using CONVERSATIONAL_FILTER_ONLY mode, the
 refined_query from search response will be populated here.
      repeated .google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch refined_search = 6;
      Specified by:
      getRefinedSearchOrBuilder in interface ConversationalSearchResponseOrBuilder

    • hasConversationalFilteringResult

      public boolean hasConversationalFilteringResult()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational filtering search.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;
      Specified by:
      hasConversationalFilteringResult in interface ConversationalSearchResponseOrBuilder
      Returns:
      Whether the conversationalFilteringResult field is set.

    • getConversationalFilteringResult

      public ConversationalSearchResponse.ConversationalFilteringResult getConversationalFilteringResult()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational filtering search.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;
      Specified by:
      getConversationalFilteringResult in interface ConversationalSearchResponseOrBuilder
      Returns:
      The conversationalFilteringResult.

    • getConversationalFilteringResultOrBuilder

      public ConversationalSearchResponse.ConversationalFilteringResultOrBuilder getConversationalFilteringResultOrBuilder()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational filtering search.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;
      Specified by:
      getConversationalFilteringResultOrBuilder in interface ConversationalSearchResponseOrBuilder

    • getStateValue

      public int getStateValue()
       Output only. The state of the response generation.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface ConversationalSearchResponseOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public ConversationalSearchResponse.State getState()
       Output only. The state of the response generation.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface ConversationalSearchResponseOrBuilder
      Returns:
      The state.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ConversationalSearchResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ConversationalSearchResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ConversationalSearchResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ConversationalSearchResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ConversationalSearchResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ConversationalSearchResponse.Builder newBuilder()

    • newBuilder

      public static ConversationalSearchResponse.Builder newBuilder(ConversationalSearchResponse prototype)

    • toBuilder

      public ConversationalSearchResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ConversationalSearchResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ConversationalSearchResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ConversationalSearchResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<ConversationalSearchResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ConversationalSearchResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder