Class ConversationalSearchResponse (2.78.0) 

public final class ConversationalSearchResponse extends GeneratedMessageV3 implements ConversationalSearchResponseOrBuilder

Response message for ConversationalSearchService.ConversationalSearch method.

Protobuf type google.cloud.retail.v2.ConversationalSearchResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConversationalSearchResponse

Static Fields

CONVERSATIONAL_FILTERING_RESULT_FIELD_NUMBER

public static final int CONVERSATIONAL_FILTERING_RESULT_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATIONAL_TEXT_RESPONSE_FIELD_NUMBER

public static final int CONVERSATIONAL_TEXT_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATION_ID_FIELD_NUMBER

public static final int CONVERSATION_ID_FIELD_NUMBER
Field Value
Type Description
int

FOLLOWUP_QUESTION_FIELD_NUMBER

public static final int FOLLOWUP_QUESTION_FIELD_NUMBER
Field Value
Type Description
int

REFINED_SEARCH_FIELD_NUMBER

public static final int REFINED_SEARCH_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

USER_QUERY_TYPES_FIELD_NUMBER

public static final int USER_QUERY_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversationalSearchResponse getDefaultInstance()
Returns
Type Description
ConversationalSearchResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConversationalSearchResponse.Builder newBuilder()
Returns
Type Description
ConversationalSearchResponse.Builder

newBuilder(ConversationalSearchResponse prototype)

public static ConversationalSearchResponse.Builder newBuilder(ConversationalSearchResponse prototype)
Parameter
Name Description
prototype ConversationalSearchResponse
Returns
Type Description
ConversationalSearchResponse.Builder

parseDelimitedFrom(InputStream input)

public static ConversationalSearchResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversationalSearchResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversationalSearchResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversationalSearchResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversationalSearchResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversationalSearchResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversationalSearchResponse> parser()
Returns
Type Description
Parser<ConversationalSearchResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v2.ConversationalSearchResponse.ConversationalFilteringResult conversational_filtering_result = 7;

Returns
Type Description
ConversationalSearchResponse.ConversationalFilteringResult

The conversationalFilteringResult.

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.v2.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

getFollowupQuestion()

public ConversationalSearchResponse.FollowupQuestion getFollowupQuestion()

The conversational followup question generated for Intent refinement.

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

Returns
Type Description
ConversationalSearchResponse.FollowupQuestion

The followupQuestion.

getFollowupQuestionOrBuilder()

public ConversationalSearchResponse.FollowupQuestionOrBuilder getFollowupQuestionOrBuilder()

The conversational followup question generated for Intent refinement.

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

Returns
Type Description
ConversationalSearchResponse.FollowupQuestionOrBuilder

getParserForType()

public Parser<ConversationalSearchResponse> getParserForType()
Returns
Type Description
Parser<ConversationalSearchResponse>
Overrides

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.v2.ConversationalSearchResponse.RefinedSearch refined_search = 6;

Parameter
Name Description
index int
Returns
Type Description
ConversationalSearchResponse.RefinedSearch

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.v2.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.v2.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.v2.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.v2.ConversationalSearchResponse.RefinedSearch refined_search = 6;

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public ConversationalSearchResponse.State getState()

Output only. The state of the response generation.

.google.cloud.retail.v2.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.v2.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:

  • "ORDER_SUPPORT"
  • "SIMPLE_PRODUCT_SEARCH"
  • "INTENT_REFINEMENT"
  • "PRODUCT_DETAILS"
  • "PRODUCT_COMPARISON"
  • "DEALS_AND_COUPONS"
  • "STORE_RELEVANT"
  • "BLOCKLISTED"
  • "BEST_PRODUCT"
  • "RETAIL_SUPPORT"
  • "DISABLED"

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 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"

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 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"

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:

  • "ORDER_SUPPORT"
  • "SIMPLE_PRODUCT_SEARCH"
  • "INTENT_REFINEMENT"
  • "PRODUCT_DETAILS"
  • "PRODUCT_COMPARISON"
  • "DEALS_AND_COUPONS"
  • "STORE_RELEVANT"
  • "BLOCKLISTED"
  • "BEST_PRODUCT"
  • "RETAIL_SUPPORT"
  • "DISABLED"

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.v2.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.v2.ConversationalSearchResponse.FollowupQuestion followup_question = 3;

Returns
Type Description
boolean

Whether the followupQuestion field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConversationalSearchResponse.Builder newBuilderForType()
Returns
Type Description
ConversationalSearchResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversationalSearchResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversationalSearchResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConversationalSearchResponse.Builder toBuilder()
Returns
Type Description
ConversationalSearchResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException