Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface InvokeAgentRequest.Builder

    • Method Detail

      • agentAliasId

        InvokeAgentRequest.Builder agentAliasId​(String agentAliasId)

        The alias of the agent to use.

        Parameters:
        agentAliasId - The alias of the agent to use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • agentId

        InvokeAgentRequest.Builder agentId​(String agentId)

        The unique identifier of the agent to use.

        Parameters:
        agentId - The unique identifier of the agent to use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableTrace

        InvokeAgentRequest.Builder enableTrace​(Boolean enableTrace)

        Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

        Parameters:
        enableTrace - Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endSession

        InvokeAgentRequest.Builder endSession​(Boolean endSession)

        Specifies whether to end the session with the agent or not.

        Parameters:
        endSession - Specifies whether to end the session with the agent or not.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputText

        InvokeAgentRequest.Builder inputText​(String inputText)

        The prompt text to send the agent.

        If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

        Parameters:
        inputText - The prompt text to send the agent.

        If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

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

      • memoryId

        InvokeAgentRequest.Builder memoryId​(String memoryId)

        The unique identifier of the agent memory.

        Parameters:
        memoryId - The unique identifier of the agent memory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionId

        InvokeAgentRequest.Builder sessionId​(String sessionId)

        The unique identifier of the session. Use the same value across requests to continue the same conversation.

        Parameters:
        sessionId - The unique identifier of the session. Use the same value across requests to continue the same conversation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionState

        InvokeAgentRequest.Builder sessionState​(SessionState sessionState)

        Contains parameters that specify various attributes of the session. For more information, see Control session context.

        If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

        Parameters:
        sessionState - Contains parameters that specify various attributes of the session. For more information, see Control session context.

        If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

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