Interface ConversationalSearchResponseOrBuilder (2.72.0) 

public interface ConversationalSearchResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversationId()

public abstract 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 to restore conversation state in server.

string conversation_id = 4;

Returns
Type Description
String

The conversationId.

getConversationIdBytes()

public abstract 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 to restore conversation state in server.

string conversation_id = 4;

Returns
Type Description
ByteString

The bytes for conversationId.

getConversationalFilteringResult()

public abstract 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
Type Description
ConversationalSearchResponse.ConversationalFilteringResult

The conversationalFilteringResult.

getConversationalFilteringResultOrBuilder()

public abstract 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;

Returns
Type Description
ConversationalSearchResponse.ConversationalFilteringResultOrBuilder

getConversationalTextResponse()

public abstract String getConversationalTextResponse()

The conversational answer-based text response generated by the Server.

string conversational_text_response = 2;

Returns
Type Description
String

The conversationalTextResponse.

getConversationalTextResponseBytes()

public abstract ByteString getConversationalTextResponseBytes()

The conversational answer-based text response generated by the Server.

string conversational_text_response = 2;

Returns
Type Description
ByteString

The bytes for conversationalTextResponse.

getFollowupQuestion()

public abstract ConversationalSearchResponse.FollowupQuestion getFollowupQuestion()

The conversational followup question generated for Intent refinement.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;

Returns
Type Description
ConversationalSearchResponse.FollowupQuestion

The followupQuestion.

getFollowupQuestionOrBuilder()

public abstract ConversationalSearchResponse.FollowupQuestionOrBuilder getFollowupQuestionOrBuilder()

The conversational followup question generated for Intent refinement.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;

Returns
Type Description
ConversationalSearchResponse.FollowupQuestionOrBuilder

getRefinedSearch(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearch

getRefinedSearchCount()

public abstract 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;

Returns
Type Description
int

getRefinedSearchList()

public abstract 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;

Returns
Type Description
List<RefinedSearch>

getRefinedSearchOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearchOrBuilder

getRefinedSearchOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearchOrBuilder>

getState()

public abstract 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
Type Description
ConversationalSearchResponse.State

The state.

getStateValue()

public abstract 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
Type Description
int

The enum numeric value on the wire for state.

getUserQueryTypes(int index)

public abstract String getUserQueryTypes(int index)

The types Retail classifies the search query as.

Supported values are:

  • "ADVERSARIAL"
  • "CHITCHAT"
  • "JAILBREAK"
  • "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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The userQueryTypes at the given index.

getUserQueryTypesBytes(int index)

public abstract ByteString getUserQueryTypesBytes(int index)

The types Retail classifies the search query as.

Supported values are:

  • "ADVERSARIAL"
  • "CHITCHAT"
  • "JAILBREAK"
  • "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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the userQueryTypes at the given index.

getUserQueryTypesCount()

public abstract int getUserQueryTypesCount()

The types Retail classifies the search query as.

Supported values are:

  • "ADVERSARIAL"
  • "CHITCHAT"
  • "JAILBREAK"
  • "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
Type Description
int

The count of userQueryTypes.

getUserQueryTypesList()

public abstract List<String> getUserQueryTypesList()

The types Retail classifies the search query as.

Supported values are:

  • "ADVERSARIAL"
  • "CHITCHAT"
  • "JAILBREAK"
  • "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
Type Description
List<String>

A list containing the userQueryTypes.

hasConversationalFilteringResult()

public abstract 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
Type Description
boolean

Whether the conversationalFilteringResult field is set.

hasFollowupQuestion()

public abstract boolean hasFollowupQuestion()

The conversational followup question generated for Intent refinement.

.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;

Returns
Type Description
boolean

Whether the followupQuestion field is set.