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

Interface CreateAgentActionGroupRequest.Builder

    • Method Detail

      • actionGroupExecutor

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

      • actionGroupName

        CreateAgentActionGroupRequest.Builder actionGroupName​(String actionGroupName)

        The name to give the action group.

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

      • actionGroupState

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

        CreateAgentActionGroupRequest.Builder agentId​(String agentId)

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

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

      • agentVersion

        CreateAgentActionGroupRequest.Builder agentVersion​(String agentVersion)

        The version of the agent for which to create the action group.

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

      • apiSchema

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

      • clientToken

        CreateAgentActionGroupRequest.Builder clientToken​(String clientToken)

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

        Parameters:
        clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateAgentActionGroupRequest.Builder description​(String description)

        A description of the action group.

        Parameters:
        description - A description of the action group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • functionSchema

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

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

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