Interface SendMessageContext.Builder

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

  • Method Details

    • currentPage

      SendMessageContext.Builder currentPage(String currentPage)

      The current page or view the user is on

      Parameters:
      currentPage - The current page or view the user is on
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastMessage

      SendMessageContext.Builder lastMessage(String lastMessage)

      The ID of the last message in the conversation

      Parameters:
      lastMessage - The ID of the last message in the conversation
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userActionResponse

      SendMessageContext.Builder userActionResponse(String userActionResponse)

      Response to a UI prompt (not a text conversation message). Set this to the sentinel value `"APPROVAL_ACTION"` when the request is resuming a paused execution after an approval decision; in that case the structured decision is provided on the sibling `approvalAction` member. Preserved as a String for backward compatibility: clients that predate the typed approval field may still encode UI-prompt responses as JSON in this field.

      Parameters:
      userActionResponse - Response to a UI prompt (not a text conversation message). Set this to the sentinel value `"APPROVAL_ACTION"` when the request is resuming a paused execution after an approval decision; in that case the structured decision is provided on the sibling `approvalAction` member. Preserved as a String for backward compatibility: clients that predate the typed approval field may still encode UI-prompt responses as JSON in this field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalAction

      SendMessageContext.Builder approvalAction(ApprovalAction approvalAction)

      An approval decision supplied when resuming a paused agent execution. When an agent execution pauses to request approval for an elevated action, SendMessage streams an approval request carrying interrupt identifiers. To resume the paused execution, call SendMessage again with `userActionResponse` set to `"APPROVAL_ACTION"` and this member populated with those identifiers and the decision (APPROVED or REJECTED). Optional; omit it for messages that are not resuming an approval.

      Parameters:
      approvalAction - An approval decision supplied when resuming a paused agent execution. When an agent execution pauses to request approval for an elevated action, SendMessage streams an approval request carrying interrupt identifiers. To resume the paused execution, call SendMessage again with `userActionResponse` set to `"APPROVAL_ACTION"` and this member populated with those identifiers and the decision (APPROVED or REJECTED). Optional; omit it for messages that are not resuming an approval.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalAction

      default SendMessageContext.Builder approvalAction(Consumer<ApprovalAction.Builder> approvalAction)

      An approval decision supplied when resuming a paused agent execution. When an agent execution pauses to request approval for an elevated action, SendMessage streams an approval request carrying interrupt identifiers. To resume the paused execution, call SendMessage again with `userActionResponse` set to `"APPROVAL_ACTION"` and this member populated with those identifiers and the decision (APPROVED or REJECTED). Optional; omit it for messages that are not resuming an approval.

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

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

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