Class TextOutputEvent

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.TextOutputEvent
All Implemented Interfaces:
Serializable, SdkPojo, ChatOutputStream, ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>
Direct Known Subclasses:
DefaultTextEvent
@Generated("software.amazon.awssdk:codegen") public class TextOutputEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>, ChatOutputStream

An output event for an AI-generated response in an Amazon Q Business web experience.

See Also:

  • Method Details

    • systemMessageType

      public final SystemMessageType systemMessageType()

      The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

      • RESPONSE - The Amazon Q Business system response.

      • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

      If the service returns an enum value that is not available in the current SDK version, systemMessageType will return SystemMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from systemMessageTypeAsString().

      Returns:
      The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

      • RESPONSE - The Amazon Q Business system response.

      • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

      See Also:

    • systemMessageTypeAsString

      public final String systemMessageTypeAsString()

      The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

      • RESPONSE - The Amazon Q Business system response.

      • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

      If the service returns an enum value that is not available in the current SDK version, systemMessageType will return SystemMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from systemMessageTypeAsString().

      Returns:
      The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

      • RESPONSE - The Amazon Q Business system response.

      • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

      See Also:

    • conversationId

      public final String conversationId()

      The identifier of the conversation with which the text output event is associated.

      Returns:
      The identifier of the conversation with which the text output event is associated.

    • userMessageId

      public final String userMessageId()

      The identifier of an end user message in a TextOutputEvent.

      Returns:
      The identifier of an end user message in a TextOutputEvent.

    • systemMessageId

      public final String systemMessageId()

      The identifier of an AI-generated message in a TextOutputEvent.

      Returns:
      The identifier of an AI-generated message in a TextOutputEvent.

    • systemMessage

      public final String systemMessage()

      An AI-generated message in a TextOutputEvent.

      Returns:
      An AI-generated message in a TextOutputEvent.

    • toBuilder

      public TextOutputEvent.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>
      Returns:
      a builder for type T

    • builder

      public static TextOutputEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TextOutputEvent.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • copy

      public final TextOutputEvent copy(Consumer<? super TextOutputEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.

    • accept

      public void accept(ChatResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of TextOutputEvent.
      Specified by:
      accept in interface ChatOutputStream
      Parameters:
      visitor - Visitor to invoke.