Class SearchRequest.ConversationalSearchSpec (2.55.0) 

public static final class SearchRequest.ConversationalSearchSpec extends GeneratedMessageV3 implements SearchRequest.ConversationalSearchSpecOrBuilder

This field specifies all conversational related parameters addition to traditional retail search.

Protobuf type google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.ConversationalSearchSpec

Static Fields

CONVERSATION_ID_FIELD_NUMBER

public static final int CONVERSATION_ID_FIELD_NUMBER
Field Value
Type Description
int

FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER

public static final int FOLLOWUP_CONVERSATION_REQUESTED_FIELD_NUMBER
Field Value
Type Description
int

USER_ANSWER_FIELD_NUMBER

public static final int USER_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.ConversationalSearchSpec getDefaultInstance()
Returns
Type Description
SearchRequest.ConversationalSearchSpec

getDescriptor()

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

newBuilder()

public static SearchRequest.ConversationalSearchSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.ConversationalSearchSpec.Builder

newBuilder(SearchRequest.ConversationalSearchSpec prototype)

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

parseDelimitedFrom(InputStream input)

public static SearchRequest.ConversationalSearchSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.ConversationalSearchSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchRequest.ConversationalSearchSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.ConversationalSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchRequest.ConversationalSearchSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.ConversationalSearchSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchRequest.ConversationalSearchSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.ConversationalSearchSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchRequest.ConversationalSearchSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.ConversationalSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchRequest.ConversationalSearchSpec> parser()
Returns
Type Description
Parser<ConversationalSearchSpec>

Methods

equals(Object obj)

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

getConversationId()

public String getConversationId()

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Returns
Type Description
String

The conversationId.

getConversationIdBytes()

public ByteString getConversationIdBytes()

This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous [ConversationalSearchResult.conversation_id][]. For the initial request, this should be empty.

string conversation_id = 2;

Returns
Type Description
ByteString

The bytes for conversationId.

getDefaultInstanceForType()

public SearchRequest.ConversationalSearchSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.ConversationalSearchSpec

getFollowupConversationRequested()

public boolean getFollowupConversationRequested()

This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.

bool followup_conversation_requested = 1;

Returns
Type Description
boolean

The followupConversationRequested.

getParserForType()

public Parser<SearchRequest.ConversationalSearchSpec> getParserForType()
Returns
Type Description
Parser<ConversationalSearchSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserAnswer()

public SearchRequest.ConversationalSearchSpec.UserAnswer getUserAnswer()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type Description
SearchRequest.ConversationalSearchSpec.UserAnswer

The userAnswer.

getUserAnswerOrBuilder()

public SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder getUserAnswerOrBuilder()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type Description
SearchRequest.ConversationalSearchSpec.UserAnswerOrBuilder

hasUserAnswer()

public boolean hasUserAnswer()

This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2.SearchRequest.ConversationalSearchSpec.UserAnswer user_answer = 3;

Returns
Type Description
boolean

Whether the userAnswer 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 SearchRequest.ConversationalSearchSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.ConversationalSearchSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchRequest.ConversationalSearchSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.ConversationalSearchSpec.Builder

writeTo(CodedOutputStream output)

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