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

Interface AgentActionGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkPojo

Enclosing class:

AgentActionGroup

public static interface AgentActionGroup.Builder
extends SdkPojo, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>

Method Summary

Modifier and Type	Method	Description
default AgentActionGroup.Builder	actionGroupExecutor(Consumer<ActionGroupExecutor.Builder> actionGroupExecutor)	The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
AgentActionGroup.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 or the custom control method for handling the information elicited from the user.
AgentActionGroup.Builder	actionGroupName(String actionGroupName)	The name of the action group.
default AgentActionGroup.Builder	apiSchema(Consumer<APISchema.Builder> 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.
AgentActionGroup.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.
AgentActionGroup.Builder	description(String description)	A description of the action group.
default AgentActionGroup.Builder	functionSchema(Consumer<FunctionSchema.Builder> functionSchema)	Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
AgentActionGroup.Builder	functionSchema(FunctionSchema functionSchema)	Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
AgentActionGroup.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.
AgentActionGroup.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.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

actionGroupExecutor

AgentActionGroup.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 or the custom control method for handling the information elicited from the user.

Parameters:

actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:

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

actionGroupExecutor

default AgentActionGroup.Builder actionGroupExecutor(Consumer<ActionGroupExecutor.Builder> actionGroupExecutor)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

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

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

Parameters:

actionGroupExecutor - a consumer that will call methods on ActionGroupExecutor.Builder

Returns:

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

See Also:

actionGroupExecutor(ActionGroupExecutor)

actionGroupName

AgentActionGroup.Builder actionGroupName(String actionGroupName)

The name of the action group.

Parameters:

actionGroupName - The name of the action group.

Returns:

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

apiSchema

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

apiSchema

default AgentActionGroup.Builder apiSchema(Consumer<APISchema.Builder> 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.

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

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

Parameters:

apiSchema - a consumer that will call methods on APISchema.Builder

Returns:

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

See Also:

apiSchema(APISchema)

description

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

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

functionSchema

default AgentActionGroup.Builder functionSchema(Consumer<FunctionSchema.Builder> functionSchema)

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

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

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

Parameters:

functionSchema - a consumer that will call methods on FunctionSchema.Builder

Returns:

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

See Also:

functionSchema(FunctionSchema)

parentActionGroupSignature

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

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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

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

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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