public static final class Session.Turn.Builder extends GeneratedMessageV3.Builder<Session.Turn.Builder> implements Session.TurnOrBuilder
Represents a turn, including a query from the user and a
answer from service.
Protobuf type google.cloud.discoveryengine.v1.Session.Turn
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Session.Turn.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public Session.Turn build()
buildPartial()
public Session.Turn buildPartial()
clear()
public Session.Turn.Builder clear()
Overrides
clearAnswer()
public Session.Turn.Builder clearAnswer()
Optional. The resource name of the answer to the user query.
Only set if the answer generation (/answer API call) happened in this
turn.
string answer = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
clearDetailedAnswer()
public Session.Turn.Builder clearDetailedAnswer()
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
clearField(Descriptors.FieldDescriptor field)
public Session.Turn.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Session.Turn.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearQuery()
public Session.Turn.Builder clearQuery()
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
clearQueryConfig()
public Session.Turn.Builder clearQueryConfig()
clone()
public Session.Turn.Builder clone()
Overrides
containsQueryConfig(String key)
public boolean containsQueryConfig(String key)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getAnswer()
public String getAnswer()
Optional. The resource name of the answer to the user query.
Only set if the answer generation (/answer API call) happened in this
turn.
string answer = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The answer.
|
getAnswerBytes()
public ByteString getAnswerBytes()
Optional. The resource name of the answer to the user query.
Only set if the answer generation (/answer API call) happened in this
turn.
string answer = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for answer.
|
getDefaultInstanceForType()
public Session.Turn getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getDetailedAnswer()
public Answer getDetailedAnswer()
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Answer |
The detailedAnswer.
|
getDetailedAnswerBuilder()
public Answer.Builder getDetailedAnswerBuilder()
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDetailedAnswerOrBuilder()
public AnswerOrBuilder getDetailedAnswerOrBuilder()
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMutableQueryConfig() (deprecated)
public Map<String,String> getMutableQueryConfig()
Use alternate mutation accessors instead.
getQuery()
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Query |
The query.
|
getQueryBuilder()
public Query.Builder getQueryBuilder()
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
getQueryConfig() (deprecated)
public Map<String,String> getQueryConfig()
getQueryConfigCount()
public int getQueryConfigCount()
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getQueryConfigMap()
public Map<String,String> getQueryConfigMap()
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
getQueryConfigOrDefault(String key, String defaultValue)
public String getQueryConfigOrDefault(String key, String defaultValue)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getQueryConfigOrThrow(String key)
public String getQueryConfigOrThrow(String key)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getQueryOrBuilder()
public QueryOrBuilder getQueryOrBuilder()
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
hasDetailedAnswer()
public boolean hasDetailedAnswer()
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the detailedAnswer field is set.
|
hasQuery()
public boolean hasQuery()
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the query field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
mergeDetailedAnswer(Answer value)
public Session.Turn.Builder mergeDetailedAnswer(Answer value)
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
value |
Answer
|
mergeFrom(Session.Turn other)
public Session.Turn.Builder mergeFrom(Session.Turn other)
public Session.Turn.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Session.Turn.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeQuery(Query value)
public Session.Turn.Builder mergeQuery(Query value)
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
Query
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Session.Turn.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
putAllQueryConfig(Map<String,String> values)
public Session.Turn.Builder putAllQueryConfig(Map<String,String> values)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
putQueryConfig(String key, String value)
public Session.Turn.Builder putQueryConfig(String key, String value)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
removeQueryConfig(String key)
public Session.Turn.Builder removeQueryConfig(String key)
Optional. Represents metadata related to the query config, for example
LLM model and version used, model parameters (temperature, grounding
parameters, etc.). The prefix "google." is reserved for Google-developed
functionality.
map<string, string> query_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
setAnswer(String value)
public Session.Turn.Builder setAnswer(String value)
Optional. The resource name of the answer to the user query.
Only set if the answer generation (/answer API call) happened in this
turn.
string answer = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
String
The answer to set.
|
setAnswerBytes(ByteString value)
public Session.Turn.Builder setAnswerBytes(ByteString value)
Optional. The resource name of the answer to the user query.
Only set if the answer generation (/answer API call) happened in this
turn.
string answer = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for answer to set.
|
setDetailedAnswer(Answer value)
public Session.Turn.Builder setDetailedAnswer(Answer value)
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
value |
Answer
|
setDetailedAnswer(Answer.Builder builderForValue)
public Session.Turn.Builder setDetailedAnswer(Answer.Builder builderForValue)
Output only. In
ConversationalSearchService.GetSession
API, if
GetSessionRequest.include_answer_details
is set to true, this field will be populated when getting answer query
session.
.google.cloud.discoveryengine.v1.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
setField(Descriptors.FieldDescriptor field, Object value)
public Session.Turn.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setQuery(Query value)
public Session.Turn.Builder setQuery(Query value)
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
Query
|
setQuery(Query.Builder builderForValue)
public Session.Turn.Builder setQuery(Query.Builder builderForValue)
Optional. The user query. May not be set if this turn is merely
regenerating an answer to a different turn
.google.cloud.discoveryengine.v1.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Session.Turn.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Session.Turn.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
