Package software.amazon.awssdk.services.bedrockagent.model

Interface UpdateAgentActionGroupRequest.Builder

    • Method Detail

      • actionGroupExecutor

        UpdateAgentActionGroupRequest.Builder actionGroupExecutor​(ActionGroupExecutor actionGroupExecutor)

        The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

        Parameters:
        actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionGroupId

        UpdateAgentActionGroupRequest.Builder actionGroupId​(String actionGroupId)

        The unique identifier of the action group.

        Parameters:
        actionGroupId - The unique identifier of the action group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionGroupName

        UpdateAgentActionGroupRequest.Builder actionGroupName​(String actionGroupName)

        Specifies a new name for the action group.

        Parameters:
        actionGroupName - Specifies a new name for the action group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionGroupState

        UpdateAgentActionGroupRequest.Builder actionGroupState​(String actionGroupState)

        Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        Parameters:
        actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionGroupState, ActionGroupState

      • agentId

        UpdateAgentActionGroupRequest.Builder agentId​(String agentId)

        The unique identifier of the agent for which to update the action group.

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

      • agentVersion

        UpdateAgentActionGroupRequest.Builder agentVersion​(String agentVersion)

        The unique identifier of the agent version for which to update the action group.

        Parameters:
        agentVersion - The unique identifier of the agent version for which to update the action group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • apiSchema

        UpdateAgentActionGroupRequest.Builder apiSchema​(APISchema apiSchema)

        Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

        Parameters:
        apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateAgentActionGroupRequest.Builder description​(String description)

        Specifies a new name for the action group.

        Parameters:
        description - Specifies a new name for the action group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • functionSchema

        UpdateAgentActionGroupRequest.Builder functionSchema​(FunctionSchema functionSchema)

        Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

        Parameters:
        functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentActionGroupSignature

        UpdateAgentActionGroupRequest.Builder parentActionGroupSignature​(String parentActionGroupSignature)

        To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

        During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

        Parameters:
        parentActionGroupSignature - To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

        During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

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

      • parentActionGroupSignature

        UpdateAgentActionGroupRequest.Builder parentActionGroupSignature​(ActionGroupSignature parentActionGroupSignature)

        To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

        During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

        Parameters:
        parentActionGroupSignature - To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

        During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

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