Interface Session.TurnOrBuilder (0.68.0)

public static interface Session.TurnOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsQueryConfig(String key)

public abstract 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
Returns
Type Description
boolean

getAnswer()

public abstract 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 abstract 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.

getDetailedAnswer()

public abstract 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 abstract 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];

Returns
Type Description
AnswerOrBuilder

getQuery()

public abstract Query 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 abstract Map<String,String> getQueryConfig()

Use #getQueryConfigMap() instead.

Returns
Type Description
Map<String,String>

getQueryConfigCount()

public abstract 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 abstract 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];

Returns
Type Description
Map<String,String>

getQueryConfigOrDefault(String key, String defaultValue)

public abstract 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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getQueryConfigOrThrow(String key)

public abstract 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 abstract 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];

Returns
Type Description
QueryOrBuilder

hasDetailedAnswer()

public abstract 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 abstract 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.