Package com.google.cloud.discoveryengine.v1beta

Class Session.Turn.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>
com.google.cloud.discoveryengine.v1beta.Session.Turn.Builder
All Implemented Interfaces:
Session.TurnOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Session.Turn
public static final class Session.Turn.Builder extends com.google.protobuf.GeneratedMessage.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.v1beta.Session.Turn

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • clear

      public Session.Turn.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • getDefaultInstanceForType

      public Session.Turn getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Session.Turn build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Session.Turn buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Session.Turn.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Session.Turn.Builder>

    • mergeFrom

      public Session.Turn.Builder mergeFrom(Session.Turn other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Session.Turn.Builder>

    • mergeFrom

      public Session.Turn.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Session.Turn.Builder>
      Throws:
      IOException

    • 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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasQuery in interface Session.TurnOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public 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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface Session.TurnOrBuilder
      Returns:
      The query.

    • setQuery

      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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];

    • setQuery

      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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];

    • mergeQuery

      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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];

    • 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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];

    • 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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];

    • 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.v1beta.Query query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryOrBuilder in interface Session.TurnOrBuilder

    • 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) = { ... }
      Specified by:
      getAnswer in interface Session.TurnOrBuilder
      Returns:
      The answer.

    • getAnswerBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getAnswerBytes in interface Session.TurnOrBuilder
      Returns:
      The bytes for answer.

    • setAnswer

      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) = { ... }
      Parameters:
      value - The answer to set.
      Returns:
      This builder for chaining.

    • 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) = { ... }
      Returns:
      This builder for chaining.

    • setAnswerBytes

      public Session.Turn.Builder setAnswerBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for answer to set.
      Returns:
      This builder for chaining.

    • hasDetailedAnswer

      public boolean hasDetailedAnswer()
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDetailedAnswer in interface Session.TurnOrBuilder
      Returns:
      Whether the detailedAnswer field is set.

    • getDetailedAnswer

      public Answer getDetailedAnswer()
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDetailedAnswer in interface Session.TurnOrBuilder
      Returns:
      The detailedAnswer.

    • setDetailedAnswer

      public Session.Turn.Builder setDetailedAnswer(Answer value)
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setDetailedAnswer

      public Session.Turn.Builder setDetailedAnswer(Answer.Builder builderForValue)
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeDetailedAnswer

      public Session.Turn.Builder mergeDetailedAnswer(Answer value)
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearDetailedAnswer

      public Session.Turn.Builder clearDetailedAnswer()
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDetailedAnswerBuilder

      public Answer.Builder getDetailedAnswerBuilder()
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDetailedAnswerOrBuilder

      public AnswerOrBuilder getDetailedAnswerOrBuilder()
       Output only. In
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 API, if
 [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details]
 is set to true, this field will be populated when getting answer query
 session.
      .google.cloud.discoveryengine.v1beta.Answer detailed_answer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDetailedAnswerOrBuilder in interface Session.TurnOrBuilder

    • getQueryConfigCount

      public int getQueryConfigCount()
      Description copied from interface: Session.TurnOrBuilder
       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];
      Specified by:
      getQueryConfigCount in interface Session.TurnOrBuilder

    • containsQueryConfig

      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];
      Specified by:
      containsQueryConfig in interface Session.TurnOrBuilder

    • getQueryConfig

      @Deprecated public Map<String,String> getQueryConfig()
      Deprecated.
      Use getQueryConfigMap() instead.
      Specified by:
      getQueryConfig in interface Session.TurnOrBuilder

    • 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];
      Specified by:
      getQueryConfigMap in interface Session.TurnOrBuilder

    • getQueryConfigOrDefault

      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];
      Specified by:
      getQueryConfigOrDefault in interface Session.TurnOrBuilder

    • getQueryConfigOrThrow

      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];
      Specified by:
      getQueryConfigOrThrow in interface Session.TurnOrBuilder

    • clearQueryConfig

      public Session.Turn.Builder clearQueryConfig()

    • removeQueryConfig

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

    • getMutableQueryConfig

      @Deprecated public Map<String,String> getMutableQueryConfig()
      Deprecated.
      Use alternate mutation accessors instead.

    • putQueryConfig

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

    • putAllQueryConfig

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