Package com.google.cloud.discoveryengine.v1

Interface StreamAssistResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StreamAssistResponse, StreamAssistResponse.Builder
@Generated public interface StreamAssistResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    AssistAnswer
    getAnswer()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    AssistAnswerOrBuilder
    getAnswerOrBuilder()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    String
    getAssistToken()
    A global unique ID that identifies the current pair of request and stream of responses.
    com.google.protobuf.ByteString
    getAssistTokenBytes()
    A global unique ID that identifies the current pair of request and stream of responses.
    StreamAssistResponse.SessionInfo
    getSessionInfo()
    Session information.
    StreamAssistResponse.SessionInfoOrBuilder
    getSessionInfoOrBuilder()
    Session information.
    boolean
    hasAnswer()
    Assist answer resource object containing parts of the assistant's final answer for the user's query.
    boolean
    hasSessionInfo()
    Session information.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasAnswer

      boolean hasAnswer()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;
      Returns:
      Whether the answer field is set.

    • getAnswer

      AssistAnswer getAnswer()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;
      Returns:
      The answer.

    • getAnswerOrBuilder

      AssistAnswerOrBuilder getAnswerOrBuilder()
       Assist answer resource object containing parts of the assistant's final
 answer for the user's query.

 Not present if the current response doesn't add anything to previously
 sent
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].

 Observe
 [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
 see if more parts are to be expected. While the state is `IN_PROGRESS`, the
 [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
 field in each response will contain replies (reply fragments) to be
 appended to the ones received in previous responses. [AssistAnswer.name][]
 won't be filled.

 If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
 is the last response and [AssistAnswer.name][] will have a value.
      .google.cloud.discoveryengine.v1.AssistAnswer answer = 1;

    • hasSessionInfo

      boolean hasSessionInfo()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;
      Returns:
      Whether the sessionInfo field is set.

    • getSessionInfo

      StreamAssistResponse.SessionInfo getSessionInfo()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;
      Returns:
      The sessionInfo.

    • getSessionInfoOrBuilder

      StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()
       Session information.
      .google.cloud.discoveryengine.v1.StreamAssistResponse.SessionInfo session_info = 2;

    • getAssistToken

      String getAssistToken()
       A global unique ID that identifies the current pair of request and stream
 of responses. Used for feedback and support.
      string assist_token = 4;
      Returns:
      The assistToken.

    • getAssistTokenBytes

      com.google.protobuf.ByteString getAssistTokenBytes()
       A global unique ID that identifies the current pair of request and stream
 of responses. Used for feedback and support.
      string assist_token = 4;
      Returns:
      The bytes for assistToken.