Interface ConversationalSearchResponseOrBuilder (2.64.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

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>

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.