Interface ChatSyncResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ChatSyncResponse.Builder,
,ChatSyncResponse> QBusinessResponse.Builder
,SdkBuilder<ChatSyncResponse.Builder,
,ChatSyncResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
ChatSyncResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault ChatSyncResponse.Builder
actionReview
(Consumer<ActionReview.Builder> actionReview) A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.actionReview
(ActionReview actionReview) A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.default ChatSyncResponse.Builder
authChallengeRequest
(Consumer<AuthChallengeRequest.Builder> authChallengeRequest) An authentication verification event activated by an end user request to use a custom plugin.authChallengeRequest
(AuthChallengeRequest authChallengeRequest) An authentication verification event activated by an end user request to use a custom plugin.conversationId
(String conversationId) The identifier of the Amazon Q Business conversation.failedAttachments
(Collection<AttachmentOutput> failedAttachments) A list of files which failed to upload during chat.failedAttachments
(Consumer<AttachmentOutput.Builder>... failedAttachments) A list of files which failed to upload during chat.failedAttachments
(AttachmentOutput... failedAttachments) A list of files which failed to upload during chat.sourceAttributions
(Collection<SourceAttribution> sourceAttributions) The source documents used to generate the conversation response.sourceAttributions
(Consumer<SourceAttribution.Builder>... sourceAttributions) The source documents used to generate the conversation response.sourceAttributions
(SourceAttribution... sourceAttributions) The source documents used to generate the conversation response.systemMessage
(String systemMessage) An AI-generated message in a conversation.systemMessageId
(String systemMessageId) The identifier of an Amazon Q Business AI generated message within the conversation.userMessageId
(String userMessageId) The identifier of an Amazon Q Business end user text input message within the conversation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
systemMessage
An AI-generated message in a conversation.
- Parameters:
systemMessage
- An AI-generated message in a conversation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
actionReview
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
- Parameters:
actionReview
- A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionReview
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
This is a convenience method that creates an instance of theActionReview.Builder
avoiding the need to create one manually viaActionReview.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionReview(ActionReview)
.- Parameters:
actionReview
- a consumer that will call methods onActionReview.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authChallengeRequest
An authentication verification event activated by an end user request to use a custom plugin.
- Parameters:
authChallengeRequest
- An authentication verification event activated by an end user request to use a custom plugin.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authChallengeRequest
default ChatSyncResponse.Builder authChallengeRequest(Consumer<AuthChallengeRequest.Builder> authChallengeRequest) An authentication verification event activated by an end user request to use a custom plugin.
This is a convenience method that creates an instance of theAuthChallengeRequest.Builder
avoiding the need to create one manually viaAuthChallengeRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauthChallengeRequest(AuthChallengeRequest)
.- Parameters:
authChallengeRequest
- a consumer that will call methods onAuthChallengeRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
ChatSyncResponse.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 theSourceAttribution.Builder
avoiding the need to create one manually viaSourceAttribution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceAttributions(List<SourceAttribution>)
.- Parameters:
sourceAttributions
- a consumer that will call methods onSourceAttribution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failedAttachments
A list of files which failed to upload during chat.
- Parameters:
failedAttachments
- A list of files which failed to upload during chat.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failedAttachments
A list of files which failed to upload during chat.
- Parameters:
failedAttachments
- A list of files which failed to upload during chat.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failedAttachments
A list of files which failed to upload during chat.
This is a convenience method that creates an instance of theAttachmentOutput.Builder
avoiding the need to create one manually viaAttachmentOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofailedAttachments(List<AttachmentOutput>)
.- Parameters:
failedAttachments
- a consumer that will call methods onAttachmentOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-