Interface MetadataEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MetadataEvent.Builder,MetadataEvent>, SdkBuilder<MetadataEvent.Builder,MetadataEvent>, SdkPojo
All Known Subinterfaces:
DefaultMetadataEvent.Builder
Enclosing class:
MetadataEvent
public static interface MetadataEvent.Builder extends SdkPojo, CopyableBuilder<MetadataEvent.Builder,MetadataEvent>

  • Method Details

    • conversationId

      MetadataEvent.Builder conversationId(String conversationId)

      The identifier of the conversation with which the generated metadata is associated.

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

    • userMessageId

      MetadataEvent.Builder userMessageId(String userMessageId)

      The identifier of an Amazon Q Business end user text input message within the conversation.

      Parameters:
      userMessageId - The identifier of an Amazon Q Business end user text input message within the conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemMessageId

      MetadataEvent.Builder systemMessageId(String systemMessageId)

      The identifier of an Amazon Q Business AI generated message within the conversation.

      Parameters:
      systemMessageId - The identifier of an Amazon Q Business AI generated message within the conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceAttributions

      MetadataEvent.Builder sourceAttributions(Collection<SourceAttribution> sourceAttributions)

      The source documents used to generate the conversation response.

      Parameters:
      sourceAttributions - The source documents used to generate the conversation response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceAttributions

      MetadataEvent.Builder sourceAttributions(SourceAttribution... sourceAttributions)

      The source documents used to generate the conversation response.

      Parameters:
      sourceAttributions - The source documents used to generate the conversation response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceAttributions

      MetadataEvent.Builder sourceAttributions(Consumer<SourceAttribution.Builder>... sourceAttributions)

      The source documents used to generate the conversation response.

      This is a convenience method that creates an instance of the SourceAttribution.Builder avoiding the need to create one manually via SourceAttribution.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceAttributions(List<SourceAttribution>).

      Parameters:
      sourceAttributions - a consumer that will call methods on SourceAttribution.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • finalTextMessage

      MetadataEvent.Builder finalTextMessage(String finalTextMessage)

      The final text output message generated by the system.

      Parameters:
      finalTextMessage - The final text output message generated by the system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.