Package com.google.cloud.discoveryengine.v1beta

Interface Session.TurnOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Session.Turn, Session.Turn.Builder
Enclosing class:
Session
public static interface Session.TurnOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasQuery

      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];
      Returns:
      Whether the query field is set.

    • getQuery

      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];
      Returns:
      The query.

    • getQueryOrBuilder

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

    • getAnswer

      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:
      The answer.

    • getAnswerBytes

      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) = { ... }
      Returns:
      The bytes for answer.

    • hasDetailedAnswer

      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];
      Returns:
      Whether the detailedAnswer field is set.

    • getDetailedAnswer

      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];
      Returns:
      The detailedAnswer.

    • getDetailedAnswerOrBuilder

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

    • getQueryConfigCount

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

    • containsQueryConfig

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

    • getQueryConfig

      @Deprecated Map<String,String> getQueryConfig()
      Deprecated.
      Use getQueryConfigMap() instead.

    • getQueryConfigMap

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

    • getQueryConfigOrThrow

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