Interface TextOutputEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>, SdkBuilder<TextOutputEvent.Builder,TextOutputEvent>, SdkPojo
All Known Subinterfaces:
DefaultTextEvent.Builder
Enclosing class:
TextOutputEvent
@Mutable @NotThreadSafe public static interface TextOutputEvent.Builder extends SdkPojo, CopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>

  • Method Details

    • systemMessageType

      TextOutputEvent.Builder systemMessageType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • systemMessageType

      TextOutputEvent.Builder systemMessageType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • conversationId

      TextOutputEvent.Builder conversationId(String conversationId)

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

      Parameters:
      conversationId - The identifier of the conversation with which the text output event is associated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMessageId

      TextOutputEvent.Builder userMessageId(String userMessageId)

      The identifier of an end user message in a TextOutputEvent.

      Parameters:
      userMessageId - The identifier of an end user message in a TextOutputEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemMessageId

      TextOutputEvent.Builder systemMessageId(String systemMessageId)

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

      Parameters:
      systemMessageId - The identifier of an AI-generated message in a TextOutputEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemMessage

      TextOutputEvent.Builder systemMessage(String systemMessage)

      An AI-generated message in a TextOutputEvent.

      Parameters:
      systemMessage - An AI-generated message in a TextOutputEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.