com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaSessionTurn

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaSessionTurn

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1alphaSessionTurn
extends com.google.api.client.json.GenericJson

Represents a turn, including a query from the user and a answer from service.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaSessionTurn()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaSessionTurn	clone()
String	getAnswer() Optional.
GoogleCloudDiscoveryengineV1alphaAnswer	getDetailedAnswer() Output only.
GoogleCloudDiscoveryengineV1alphaAssistAnswer	getDetailedAssistAnswer() Output only.
Boolean	getLive() Optional.
GoogleCloudDiscoveryengineV1alphaQuery	getQuery() Optional.
Map<String,String>	getQueryConfig() Optional.
GoogleCloudDiscoveryengineV1alphaSessionTurn	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaSessionTurn	setAnswer(String answer) Optional.
GoogleCloudDiscoveryengineV1alphaSessionTurn	setDetailedAnswer(GoogleCloudDiscoveryengineV1alphaAnswer detailedAnswer) Output only.
GoogleCloudDiscoveryengineV1alphaSessionTurn	setDetailedAssistAnswer(GoogleCloudDiscoveryengineV1alphaAssistAnswer detailedAssistAnswer) Output only.
GoogleCloudDiscoveryengineV1alphaSessionTurn	setLive(Boolean live) Optional.
GoogleCloudDiscoveryengineV1alphaSessionTurn	setQuery(GoogleCloudDiscoveryengineV1alphaQuery query) Optional.
GoogleCloudDiscoveryengineV1alphaSessionTurn	setQueryConfig(Map<String,String> queryConfig) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1alphaSessionTurn

public GoogleCloudDiscoveryengineV1alphaSessionTurn()

Method Detail

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.

Returns:

value or null for none

setAnswer

public GoogleCloudDiscoveryengineV1alphaSessionTurn setAnswer(String answer)

Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.

Parameters:

answer - answer or null for none

getDetailedAnswer

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

Returns:

value or null for none

setDetailedAnswer

public GoogleCloudDiscoveryengineV1alphaSessionTurn setDetailedAnswer(GoogleCloudDiscoveryengineV1alphaAnswer detailedAnswer)

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.

Parameters:

detailedAnswer - detailedAnswer or null for none

getDetailedAssistAnswer

public GoogleCloudDiscoveryengineV1alphaAssistAnswer getDetailedAssistAnswer()

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.

Returns:

value or null for none

setDetailedAssistAnswer

public GoogleCloudDiscoveryengineV1alphaSessionTurn setDetailedAssistAnswer(GoogleCloudDiscoveryengineV1alphaAssistAnswer detailedAssistAnswer)

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.

Parameters:

detailedAssistAnswer - detailedAssistAnswer or null for none

getLive

public Boolean getLive()

Optional. Indicates whether this turn is a live turn.

Returns:

value or null for none

setLive

public GoogleCloudDiscoveryengineV1alphaSessionTurn setLive(Boolean live)

Optional. Indicates whether this turn is a live turn.

Parameters:

live - live or null for none

getQuery

public GoogleCloudDiscoveryengineV1alphaQuery getQuery()

Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn

Returns:

value or null for none

setQuery

public GoogleCloudDiscoveryengineV1alphaSessionTurn setQuery(GoogleCloudDiscoveryengineV1alphaQuery query)

Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn

Parameters:

query - query or null for none

getQueryConfig

public Map<String,String> getQueryConfig()

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.

Returns:

value or null for none

setQueryConfig

public GoogleCloudDiscoveryengineV1alphaSessionTurn setQueryConfig(Map<String,String> queryConfig)

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.

Parameters:

queryConfig - queryConfig or null for none

set

public GoogleCloudDiscoveryengineV1alphaSessionTurn set(String fieldName,
                                                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1alphaSessionTurn clone()

Overrides:

clone in class com.google.api.client.json.GenericJson