Interface ChatSyncRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>, QBusinessRequest.Builder, SdkBuilder<ChatSyncRequest.Builder,ChatSyncRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ChatSyncRequest
@Mutable @NotThreadSafe public static interface ChatSyncRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

  • Method Details

    • applicationId

      ChatSyncRequest.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

      Parameters:
      applicationId - The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      ChatSyncRequest.Builder userId(String userId)

      The identifier of the user attached to the chat input.

      Parameters:
      userId - The identifier of the user attached to the chat input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroups

      ChatSyncRequest.Builder userGroups(Collection<String> userGroups)

      The group names that a user associated with the chat input belongs to.

      Parameters:
      userGroups - The group names that a user associated with the chat input belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroups

      ChatSyncRequest.Builder userGroups(String... userGroups)

      The group names that a user associated with the chat input belongs to.

      Parameters:
      userGroups - The group names that a user associated with the chat input belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMessage

      ChatSyncRequest.Builder userMessage(String userMessage)

      A end user message in a conversation.

      Parameters:
      userMessage - A end user message in a conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ChatSyncRequest.Builder attachments(Collection<AttachmentInput> attachments)

      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

      Parameters:
      attachments - A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ChatSyncRequest.Builder attachments(AttachmentInput... attachments)

      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

      Parameters:
      attachments - A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ChatSyncRequest.Builder attachments(Consumer<AttachmentInput.Builder>... attachments)

      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

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

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

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

    • actionExecution

      ChatSyncRequest.Builder actionExecution(ActionExecution actionExecution)

      A request from an end user to perform an Amazon Q Business plugin action.

      Parameters:
      actionExecution - A request from an end user to perform an Amazon Q Business plugin action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionExecution

      default ChatSyncRequest.Builder actionExecution(Consumer<ActionExecution.Builder> actionExecution)

      A request from an end user to perform an Amazon Q Business plugin action.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actionExecution(ActionExecution).

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

    • authChallengeResponse

      ChatSyncRequest.Builder authChallengeResponse(AuthChallengeResponse authChallengeResponse)

      An authentication verification event response by a third party authentication server to Amazon Q Business.

      Parameters:
      authChallengeResponse - An authentication verification event response by a third party authentication server to Amazon Q Business.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authChallengeResponse

      default ChatSyncRequest.Builder authChallengeResponse(Consumer<AuthChallengeResponse.Builder> authChallengeResponse)

      An authentication verification event response by a third party authentication server to Amazon Q Business.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authChallengeResponse(AuthChallengeResponse).

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

    • conversationId

      ChatSyncRequest.Builder conversationId(String conversationId)

      The identifier of the Amazon Q Business conversation.

      Parameters:
      conversationId - The identifier of the Amazon Q Business conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentMessageId

      ChatSyncRequest.Builder parentMessageId(String parentMessageId)

      The identifier of the previous system message in a conversation.

      Parameters:
      parentMessageId - The identifier of the previous system message in a conversation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeFilter

      ChatSyncRequest.Builder attributeFilter(AttributeFilter attributeFilter)

      Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

      Parameters:
      attributeFilter - Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeFilter

      default ChatSyncRequest.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

      Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributeFilter(AttributeFilter).

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

    • chatMode

      ChatSyncRequest.Builder chatMode(String chatMode)

      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      Parameters:
      chatMode - The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

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

    • chatMode

      ChatSyncRequest.Builder chatMode(ChatMode chatMode)

      The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

      Parameters:
      chatMode - The chatMode parameter determines the chat modes available to Amazon Q Business users:

      • RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge

      • CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.

      If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

      For more information, see Admin controls and guardrails, Plugins, and Response sources.

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

    • chatModeConfiguration

      ChatSyncRequest.Builder chatModeConfiguration(ChatModeConfiguration chatModeConfiguration)

      The chat mode configuration for an Amazon Q Business application.

      Parameters:
      chatModeConfiguration - The chat mode configuration for an Amazon Q Business application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chatModeConfiguration

      default ChatSyncRequest.Builder chatModeConfiguration(Consumer<ChatModeConfiguration.Builder> chatModeConfiguration)

      The chat mode configuration for an Amazon Q Business application.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chatModeConfiguration(ChatModeConfiguration).

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

    • clientToken

      ChatSyncRequest.Builder clientToken(String clientToken)

      A token that you provide to identify a chat request.

      Parameters:
      clientToken - A token that you provide to identify a chat request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ChatSyncRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ChatSyncRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.