- 2.72.0 (latest)
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ConversationalSearchResponse.Builder extends GeneratedMessageV3.Builder<ConversationalSearchResponse.Builder> implements ConversationalSearchResponseOrBuilderResponse message for ConversationalSearchService.ConversationalSearch method.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConversationalSearchResponse.BuilderImplements
ConversationalSearchResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllRefinedSearch(Iterable<? extends ConversationalSearchResponse.RefinedSearch> values)
public ConversationalSearchResponse.Builder addAllRefinedSearch(Iterable<? extends ConversationalSearchResponse.RefinedSearch> values)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 |
values |
Iterable<? extends com.google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearch> |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addAllUserQueryTypes(Iterable<String> values)
public ConversationalSearchResponse.Builder addAllUserQueryTypes(Iterable<String> values)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 |
values |
Iterable<String>The userQueryTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
addRefinedSearch(ConversationalSearchResponse.RefinedSearch value)
public ConversationalSearchResponse.Builder addRefinedSearch(ConversationalSearchResponse.RefinedSearch value)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 |
value |
ConversationalSearchResponse.RefinedSearch |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addRefinedSearch(ConversationalSearchResponse.RefinedSearch.Builder builderForValue)
public ConversationalSearchResponse.Builder addRefinedSearch(ConversationalSearchResponse.RefinedSearch.Builder builderForValue)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 |
builderForValue |
ConversationalSearchResponse.RefinedSearch.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)
public ConversationalSearchResponse.Builder addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ConversationalSearchResponse.RefinedSearch |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)
public ConversationalSearchResponse.Builder addRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ConversationalSearchResponse.RefinedSearch.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addRefinedSearchBuilder()
public ConversationalSearchResponse.RefinedSearch.Builder addRefinedSearchBuilder()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 |
ConversationalSearchResponse.RefinedSearch.Builder |
|
addRefinedSearchBuilder(int index)
public ConversationalSearchResponse.RefinedSearch.Builder addRefinedSearchBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ConversationalSearchResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
addUserQueryTypes(String value)
public ConversationalSearchResponse.Builder addUserQueryTypes(String value)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 |
value |
StringThe userQueryTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
addUserQueryTypesBytes(ByteString value)
public ConversationalSearchResponse.Builder addUserQueryTypesBytes(ByteString value)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 |
value |
ByteStringThe bytes of the userQueryTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
build()
public ConversationalSearchResponse build()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
|
buildPartial()
public ConversationalSearchResponse buildPartial()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
|
clear()
public ConversationalSearchResponse.Builder clear()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
clearConversationId()
public ConversationalSearchResponse.Builder clearConversationId()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 |
ConversationalSearchResponse.Builder |
This builder for chaining. |
clearConversationalFilteringResult()
public ConversationalSearchResponse.Builder clearConversationalFilteringResult()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.Builder |
|
clearConversationalTextResponse()
public ConversationalSearchResponse.Builder clearConversationalTextResponse()The conversational answer-based text response generated by the Server.
string conversational_text_response = 2;
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ConversationalSearchResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
clearFollowupQuestion()
public ConversationalSearchResponse.Builder clearFollowupQuestion()The conversational followup question generated for Intent refinement.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ConversationalSearchResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
clearRefinedSearch()
public ConversationalSearchResponse.Builder clearRefinedSearch()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 |
ConversationalSearchResponse.Builder |
|
clearState()
public ConversationalSearchResponse.Builder clearState()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.Builder |
This builder for chaining. |
clearUserQueryTypes()
public ConversationalSearchResponse.Builder clearUserQueryTypes()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 |
ConversationalSearchResponse.Builder |
This builder for chaining. |
clone()
public ConversationalSearchResponse.Builder clone()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
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 to restore conversation state in server.
string conversation_id = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The conversationId. |
getConversationIdBytes()
public 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 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. |
getConversationalFilteringResultBuilder()
public ConversationalSearchResponse.ConversationalFilteringResult.Builder getConversationalFilteringResultBuilder()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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.ConversationalFilteringResultOrBuilder |
|
getConversationalTextResponse()
public 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 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. |
getDefaultInstanceForType()
public ConversationalSearchResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFollowupQuestion()
public 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. |
getFollowupQuestionBuilder()
public ConversationalSearchResponse.FollowupQuestion.Builder getFollowupQuestionBuilder()The conversational followup question generated for Intent refinement.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.FollowupQuestion.Builder |
|
getFollowupQuestionOrBuilder()
public 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 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 |
|
getRefinedSearchBuilder(int index)
public ConversationalSearchResponse.RefinedSearch.Builder getRefinedSearchBuilder(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.Builder |
|
getRefinedSearchBuilderList()
public List<ConversationalSearchResponse.RefinedSearch.Builder> getRefinedSearchBuilderList()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<Builder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
int |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<RefinedSearch> |
|
getRefinedSearchOrBuilder(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.RefinedSearchOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2alpha.ConversationalSearchResponse.RefinedSearchOrBuilder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.State |
The state. |
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];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUserQueryTypes(int index)
public 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The userQueryTypes at the given index. |
getUserQueryTypesBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the userQueryTypes at the given index. |
getUserQueryTypesCount()
public 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the userQueryTypes. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the conversationalFilteringResult field is set. |
hasFollowupQuestion()
public 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)
public ConversationalSearchResponse.Builder mergeConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchResponse.ConversationalFilteringResult |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
mergeFollowupQuestion(ConversationalSearchResponse.FollowupQuestion value)
public ConversationalSearchResponse.Builder mergeFollowupQuestion(ConversationalSearchResponse.FollowupQuestion value)The conversational followup question generated for Intent refinement.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchResponse.FollowupQuestion |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
mergeFrom(ConversationalSearchResponse other)
public ConversationalSearchResponse.Builder mergeFrom(ConversationalSearchResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
ConversationalSearchResponse |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ConversationalSearchResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ConversationalSearchResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ConversationalSearchResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
removeRefinedSearch(int index)
public ConversationalSearchResponse.Builder removeRefinedSearch(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.Builder |
|
setConversationId(String value)
public ConversationalSearchResponse.Builder setConversationId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setConversationIdBytes(ByteString value)
public ConversationalSearchResponse.Builder setConversationIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)
public ConversationalSearchResponse.Builder setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchResponse.ConversationalFilteringResult |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult.Builder builderForValue)
public ConversationalSearchResponse.Builder setConversationalFilteringResult(ConversationalSearchResponse.ConversationalFilteringResult.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ConversationalSearchResponse.ConversationalFilteringResult.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setConversationalTextResponse(String value)
public ConversationalSearchResponse.Builder setConversationalTextResponse(String value)The conversational answer-based text response generated by the Server.
string conversational_text_response = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversationalTextResponse to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setConversationalTextResponseBytes(ByteString value)
public ConversationalSearchResponse.Builder setConversationalTextResponseBytes(ByteString value)The conversational answer-based text response generated by the Server.
string conversational_text_response = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversationalTextResponse to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ConversationalSearchResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setFollowupQuestion(ConversationalSearchResponse.FollowupQuestion value)
public ConversationalSearchResponse.Builder setFollowupQuestion(ConversationalSearchResponse.FollowupQuestion value)The conversational followup question generated for Intent refinement.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchResponse.FollowupQuestion |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setFollowupQuestion(ConversationalSearchResponse.FollowupQuestion.Builder builderForValue)
public ConversationalSearchResponse.Builder setFollowupQuestion(ConversationalSearchResponse.FollowupQuestion.Builder builderForValue)The conversational followup question generated for Intent refinement.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.FollowupQuestion followup_question = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ConversationalSearchResponse.FollowupQuestion.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)
public ConversationalSearchResponse.Builder setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ConversationalSearchResponse.RefinedSearch |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)
public ConversationalSearchResponse.Builder setRefinedSearch(int index, ConversationalSearchResponse.RefinedSearch.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ConversationalSearchResponse.RefinedSearch.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ConversationalSearchResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setState(ConversationalSearchResponse.State value)
public ConversationalSearchResponse.Builder setState(ConversationalSearchResponse.State value)Output only. The state of the response generation.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchResponse.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setStateValue(int value)
public ConversationalSearchResponse.Builder setStateValue(int value)Output only. The state of the response generation.
.google.cloud.retail.v2alpha.ConversationalSearchResponse.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ConversationalSearchResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
|
setUserQueryTypes(int index, String value)
public ConversationalSearchResponse.Builder setUserQueryTypes(int index, String value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe userQueryTypes to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchResponse.Builder |
This builder for chaining. |