public static final class Session.Turn extends GeneratedMessageV3 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.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANSWER_FIELD_NUMBER
public static final int ANSWER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DETAILED_ANSWER_FIELD_NUMBER
public static final int DETAILED_ANSWER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_CONFIG_FIELD_NUMBER
public static final int QUERY_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Session.Turn getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Session.Turn.Builder newBuilder()
newBuilder(Session.Turn prototype)
public static Session.Turn.Builder newBuilder(Session.Turn prototype)
public static Session.Turn parseDelimitedFrom(InputStream input)
public static Session.Turn parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Session.Turn parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Session.Turn parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Session.Turn parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Session.Turn parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Session.Turn parseFrom(CodedInputStream input)
public static Session.Turn parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Session.Turn parseFrom(InputStream input)
public static Session.Turn parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Session.Turn parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Session.Turn parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Session.Turn> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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()
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.
|
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];
getParserForType()
public Parser<Session.Turn> getParserForType()
Overrides
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.
|
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Session.Turn.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Session.Turn.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Session.Turn.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
