Discovery Engine v1 API - Class Session.Types.Turn (1.11.0)

Version latest

• 1.11.0 (latest)
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class Session.Types.Turn : IMessage<Session.Types.Turn>, IEquatable<Session.Types.Turn>, IDeepCloneable<Session.Types.Turn>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class Session.Types.Turn.

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

Inheritance

object > Session.Types.Turn

Implements

IMessageSessionTypesTurn, IEquatableSessionTypesTurn, IDeepCloneableSessionTypesTurn, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Turn()

public Turn()

Turn(Turn)

public Turn(Session.Types.Turn other)

Parameter
Name	Description
other	SessionTypesTurn

Properties

Answer

public string Answer { get; set; }

Optional. The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.

Property Value
Type	Description
string

AnswerAsAnswerName

public AnswerName AnswerAsAnswerName { get; set; }

AnswerName-typed view over the Answer resource name property.

Property Value
Type	Description
AnswerName

DetailedAnswer

public Answer DetailedAnswer { get; set; }

Output only. In [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] API, if [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details] is set to true, this field will be populated when getting answer query session.

Property Value
Type	Description
Answer

DetailedAssistAnswer

public AssistAnswer DetailedAssistAnswer { get; set; }

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

Property Value
Type	Description
AssistAnswer

Query

public Query Query { get; set; }

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

Property Value
Type	Description
Query

QueryConfig

public MapField<string, string> QueryConfig { get; }

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.

Property Value
Type	Description
MapFieldstringstring