com.google.cloud.retail.v2

Interface SearchResponse.ConversationalSearchResultOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchResponse.ConversationalSearchResult, SearchResponse.ConversationalSearchResult.Builder

Enclosing class:

SearchResponse

public static interface SearchResponse.ConversationalSearchResultOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchResponse.ConversationalSearchResult.AdditionalFilter	getAdditionalFilter() This is the incremental additional filters implied from the current user answer.
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder	getAdditionalFilterOrBuilder() This is the incremental additional filters implied from the current user answer.
SearchResponse.ConversationalSearchResult.AdditionalFilter	getAdditionalFilters(int index) Deprecated.
int	getAdditionalFiltersCount() Deprecated.
List<SearchResponse.ConversationalSearchResult.AdditionalFilter>	getAdditionalFiltersList() Deprecated.
SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder	getAdditionalFiltersOrBuilder(int index) Deprecated.
List<? extends SearchResponse.ConversationalSearchResult.AdditionalFilterOrBuilder>	getAdditionalFiltersOrBuilderList() Deprecated.
String	getConversationId() Conversation UUID.
com.google.protobuf.ByteString	getConversationIdBytes() Conversation UUID.
String	getFollowupQuestion() The follow-up question. e.g., `What is the color?
com.google.protobuf.ByteString	getFollowupQuestionBytes() The follow-up question. e.g., `What is the color?
String	getRefinedQuery() The current refined query for the conversational search.
com.google.protobuf.ByteString	getRefinedQueryBytes() The current refined query for the conversational search.
SearchResponse.ConversationalSearchResult.SuggestedAnswer	getSuggestedAnswers(int index) The answer options provided to client for the follow-up question.
int	getSuggestedAnswersCount() The answer options provided to client for the follow-up question.
List<SearchResponse.ConversationalSearchResult.SuggestedAnswer>	getSuggestedAnswersList() The answer options provided to client for the follow-up question.
SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder	getSuggestedAnswersOrBuilder(int index) The answer options provided to client for the follow-up question.
List<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder>	getSuggestedAnswersOrBuilderList() The answer options provided to client for the follow-up question.
boolean	hasAdditionalFilter() This is the incremental additional filters implied from the current user answer.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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
 [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id]
 to restore conversation state in server.
 

string conversation_id = 1;

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
 [SearchRequest.ConversationalSearchSpec.conversation_id][google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.conversation_id]
 to restore conversation state in server.
 

string conversation_id = 1;

Returns:

The bytes for conversationId.

getRefinedQuery

String 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.v2.SearchRequest.query] is
 `dress` and next
 [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.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;

Returns:

The refinedQuery.

getRefinedQueryBytes

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.v2.SearchRequest.query] is
 `dress` and next
 [SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer][google.cloud.retail.v2.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;

Returns:

The bytes for refinedQuery.

getAdditionalFiltersList

@Deprecated
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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

getAdditionalFilters

@Deprecated
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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

getAdditionalFiltersCount

@Deprecated
int 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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

getAdditionalFiltersOrBuilderList

@Deprecated
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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

getAdditionalFiltersOrBuilder

@Deprecated
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.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filters = 3 [deprecated = true];

getFollowupQuestion

String getFollowupQuestion()

 The follow-up question. e.g., `What is the color?`
 

string followup_question = 4;

Returns:

The followupQuestion.

getFollowupQuestionBytes

com.google.protobuf.ByteString getFollowupQuestionBytes()

 The follow-up question. e.g., `What is the color?`
 

string followup_question = 4;

Returns:

The bytes for followupQuestion.

getSuggestedAnswersList

List<SearchResponse.ConversationalSearchResult.SuggestedAnswer> getSuggestedAnswersList()

 The answer options provided to client for the follow-up question.
 

repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;

getSuggestedAnswers

SearchResponse.ConversationalSearchResult.SuggestedAnswer getSuggestedAnswers(int index)

 The answer options provided to client for the follow-up question.
 

repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;

getSuggestedAnswersCount

int getSuggestedAnswersCount()

 The answer options provided to client for the follow-up question.
 

repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;

getSuggestedAnswersOrBuilderList

List<? extends SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder> getSuggestedAnswersOrBuilderList()

 The answer options provided to client for the follow-up question.
 

repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;

getSuggestedAnswersOrBuilder

SearchResponse.ConversationalSearchResult.SuggestedAnswerOrBuilder getSuggestedAnswersOrBuilder(int index)

 The answer options provided to client for the follow-up question.
 

repeated .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.SuggestedAnswer suggested_answers = 5;

hasAdditionalFilter

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.v2.SearchRequest.filter],  and
 use the merged filter in the follow up search request.
 

.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;

Returns:

Whether the additionalFilter field is set.

getAdditionalFilter

SearchResponse.ConversationalSearchResult.AdditionalFilter 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.v2.SearchRequest.filter],  and
 use the merged filter in the follow up search request.
 

.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;

Returns:

The additionalFilter.

getAdditionalFilterOrBuilder

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.v2.SearchRequest.filter],  and
 use the merged filter in the follow up search request.
 

.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult.AdditionalFilter additional_filter = 6;