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

Interface InvokeInlineAgentRequest.Builder

    • Method Detail

      • actionGroups

        InvokeInlineAgentRequest.Builder actionGroups​(Collection<AgentActionGroup> actionGroups)

        A list of action groups with each action group defining the action the inline agent needs to carry out.

        Parameters:
        actionGroups - A list of action groups with each action group defining the action the inline agent needs to carry out.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionGroups

        InvokeInlineAgentRequest.Builder actionGroups​(AgentActionGroup... actionGroups)

        A list of action groups with each action group defining the action the inline agent needs to carry out.

        Parameters:
        actionGroups - A list of action groups with each action group defining the action the inline agent needs to carry out.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customerEncryptionKeyArn

        InvokeInlineAgentRequest.Builder customerEncryptionKeyArn​(String customerEncryptionKeyArn)

        The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

        Parameters:
        customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableTrace

        InvokeInlineAgentRequest.Builder enableTrace​(Boolean enableTrace)

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

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

      • endSession

        InvokeInlineAgentRequest.Builder endSession​(Boolean endSession)

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

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

      • foundationModel

        InvokeInlineAgentRequest.Builder foundationModel​(String foundationModel)

        The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.

        Parameters:
        foundationModel - The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • idleSessionTTLInSeconds

        InvokeInlineAgentRequest.Builder idleSessionTTLInSeconds​(Integer idleSessionTTLInSeconds)

        The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

        A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

        Parameters:
        idleSessionTTLInSeconds - The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.

        A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

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

      • inlineSessionState

        InvokeInlineAgentRequest.Builder inlineSessionState​(InlineSessionState inlineSessionState)

        Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

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

        Parameters:
        inlineSessionState - Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. 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.

      • inputText

        InvokeInlineAgentRequest.Builder inputText​(String inputText)

        The prompt text to send to the agent.

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

        Parameters:
        inputText - The prompt text to send to 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.

      • instruction

        InvokeInlineAgentRequest.Builder instruction​(String instruction)

        The instructions that tell the inline agent what it should do and how it should interact with users.

        Parameters:
        instruction - The instructions that tell the inline agent what it should do and how it should interact with users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • knowledgeBases

        InvokeInlineAgentRequest.Builder knowledgeBases​(Collection<KnowledgeBase> knowledgeBases)

        Contains information of the knowledge bases to associate with.

        Parameters:
        knowledgeBases - Contains information of the knowledge bases to associate with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • knowledgeBases

        InvokeInlineAgentRequest.Builder knowledgeBases​(KnowledgeBase... knowledgeBases)

        Contains information of the knowledge bases to associate with.

        Parameters:
        knowledgeBases - Contains information of the knowledge bases to associate with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promptOverrideConfiguration

        InvokeInlineAgentRequest.Builder promptOverrideConfiguration​(PromptOverrideConfiguration promptOverrideConfiguration)

        Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

        Parameters:
        promptOverrideConfiguration - Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionId

        InvokeInlineAgentRequest.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.