Package com.google.cloud.retail.v2alpha

Interface ConversationalSearchResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ConversationalSearchResponse, ConversationalSearchResponse.Builder
@Generated public interface ConversationalSearchResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getUserQueryTypesList

      List<String> 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;
      Returns:
      A list containing the userQueryTypes.

    • getUserQueryTypesCount

      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;
      Returns:
      The count of userQueryTypes.

    • getUserQueryTypes

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The userQueryTypes at the given index.

    • getUserQueryTypesBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the userQueryTypes at the given index.

    • getConversationalTextResponse

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

    • getConversationalTextResponseBytes

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

    • hasFollowupQuestion

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

    • getFollowupQuestion

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

    • getFollowupQuestionOrBuilder

      ConversationalSearchResponse.FollowupQuestionOrBuilder getFollowupQuestionOrBuilder()
       The conversational followup question generated for Intent refinement.
      .google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;

    • getConversationId

      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;
      Returns:
      The conversationId.

    • getConversationIdBytes

      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;
      Returns:
      The bytes for conversationId.

    • getRefinedSearchList

      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;

    • getRefinedSearch

      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;

    • getRefinedSearchCount

      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;

    • getRefinedSearchOrBuilderList

      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;

    • getRefinedSearchOrBuilder

      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;

    • hasConversationalFilteringResult

      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;
      Returns:
      Whether the conversationalFilteringResult field is set.

    • getConversationalFilteringResult

      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;
      Returns:
      The conversationalFilteringResult.

    • getConversationalFilteringResultOrBuilder

      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;

    • getStateValue

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

    • getState

      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];
      Returns:
      The state.