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

Interface CreateAgentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>, SdkBuilder<CreateAgentRequest.Builder,CreateAgentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAgentRequest

@Mutable
@NotThreadSafe
public static interface CreateAgentRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

Method Summary

Modifier and Type	Method	Description
CreateAgentRequest.Builder	agentCollaboration(String agentCollaboration)	The agent's collaboration role.
CreateAgentRequest.Builder	agentCollaboration(AgentCollaboration agentCollaboration)	The agent's collaboration role.
CreateAgentRequest.Builder	agentName(String agentName)	A name for the agent that you create.
CreateAgentRequest.Builder	agentResourceRoleArn(String agentResourceRoleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
CreateAgentRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateAgentRequest.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
default CreateAgentRequest.Builder	customOrchestration(Consumer<CustomOrchestration.Builder> customOrchestration)	Contains details of the custom orchestration configured for the agent.
CreateAgentRequest.Builder	customOrchestration(CustomOrchestration customOrchestration)	Contains details of the custom orchestration configured for the agent.
CreateAgentRequest.Builder	description(String description)	A description of the agent.
CreateAgentRequest.Builder	foundationModel(String foundationModel)	The identifier for the model that you want to be used for orchestration by the agent you create.
default CreateAgentRequest.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	The unique Guardrail configuration assigned to the agent when it is created.
CreateAgentRequest.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	The unique Guardrail configuration assigned to the agent when it is created.
CreateAgentRequest.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
CreateAgentRequest.Builder	instruction(String instruction)	Instructions that tell the agent what it should do and how it should interact with users.
default CreateAgentRequest.Builder	memoryConfiguration(Consumer<MemoryConfiguration.Builder> memoryConfiguration)	Contains the details of the memory configured for the agent.
CreateAgentRequest.Builder	memoryConfiguration(MemoryConfiguration memoryConfiguration)	Contains the details of the memory configured for the agent.
CreateAgentRequest.Builder	orchestrationType(String orchestrationType)	Specifies the type of orchestration strategy for the agent.
CreateAgentRequest.Builder	orchestrationType(OrchestrationType orchestrationType)	Specifies the type of orchestration strategy for the agent.
CreateAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateAgentRequest.Builder	promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)	Contains configurations to override prompts in different parts of an agent sequence.
CreateAgentRequest.Builder	promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)	Contains configurations to override prompts in different parts of an agent sequence.
CreateAgentRequest.Builder	tags(Map<String,String> tags)	Any tags that you want to attach to the agent.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.Builder

build

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

agentName

CreateAgentRequest.Builder agentName(String agentName)

A name for the agent that you create.

Parameters:

agentName - A name for the agent that you create.

Returns:

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

clientToken

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

instruction

CreateAgentRequest.Builder instruction(String instruction)

Instructions that tell the agent what it should do and how it should interact with users.

Parameters:

instruction - Instructions that tell the 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.

foundationModel

CreateAgentRequest.Builder foundationModel(String foundationModel)

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Parameters:

foundationModel - The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Returns:

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

description

CreateAgentRequest.Builder description(String description)

A description of the agent.

Parameters:

description - A description of the agent.

Returns:

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

orchestrationType

CreateAgentRequest.Builder orchestrationType(String orchestrationType)

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Parameters:

orchestrationType - Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Returns:

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

See Also:

OrchestrationType, OrchestrationType

orchestrationType

CreateAgentRequest.Builder orchestrationType(OrchestrationType orchestrationType)

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Parameters:

orchestrationType - Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Returns:

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

See Also:

OrchestrationType, OrchestrationType

customOrchestration

CreateAgentRequest.Builder customOrchestration(CustomOrchestration customOrchestration)

Contains details of the custom orchestration configured for the agent.

Parameters:

customOrchestration - Contains details of the custom orchestration configured for the agent.

Returns:

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

customOrchestration

default CreateAgentRequest.Builder customOrchestration(Consumer<CustomOrchestration.Builder> customOrchestration)

Contains details of the custom orchestration configured for the agent.

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

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

Parameters:

customOrchestration - a consumer that will call methods on CustomOrchestration.Builder

Returns:

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

See Also:

customOrchestration(CustomOrchestration)

idleSessionTTLInSeconds

CreateAgentRequest.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

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

Parameters:

idleSessionTTLInSeconds - The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

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

Returns:

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

agentResourceRoleArn

CreateAgentRequest.Builder agentResourceRoleArn(String agentResourceRoleArn)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Parameters:

agentResourceRoleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

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

customerEncryptionKeyArn

CreateAgentRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Returns:

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

tags

CreateAgentRequest.Builder tags(Map<String,String> tags)

Any tags that you want to attach to the agent.

Parameters:

tags - Any tags that you want to attach to the agent.

Returns:

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

promptOverrideConfiguration

CreateAgentRequest.Builder promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Parameters:

promptOverrideConfiguration - Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:

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

promptOverrideConfiguration

default CreateAgentRequest.Builder promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

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

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

Parameters:

promptOverrideConfiguration - a consumer that will call methods on PromptOverrideConfiguration.Builder

Returns:

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

See Also:

promptOverrideConfiguration(PromptOverrideConfiguration)

guardrailConfiguration

CreateAgentRequest.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

The unique Guardrail configuration assigned to the agent when it is created.

Parameters:

guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is created.

Returns:

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

guardrailConfiguration

default CreateAgentRequest.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

The unique Guardrail configuration assigned to the agent when it is created.

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

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

Parameters:

guardrailConfiguration - a consumer that will call methods on GuardrailConfiguration.Builder

Returns:

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

See Also:

guardrailConfiguration(GuardrailConfiguration)

memoryConfiguration

CreateAgentRequest.Builder memoryConfiguration(MemoryConfiguration memoryConfiguration)

Contains the details of the memory configured for the agent.

Parameters:

memoryConfiguration - Contains the details of the memory configured for the agent.

Returns:

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

memoryConfiguration

default CreateAgentRequest.Builder memoryConfiguration(Consumer<MemoryConfiguration.Builder> memoryConfiguration)

Contains the details of the memory configured for the agent.

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

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

Parameters:

memoryConfiguration - a consumer that will call methods on MemoryConfiguration.Builder

Returns:

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

See Also:

memoryConfiguration(MemoryConfiguration)

agentCollaboration

CreateAgentRequest.Builder agentCollaboration(String agentCollaboration)

The agent's collaboration role.

Parameters:

agentCollaboration - The agent's collaboration role.

Returns:

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

See Also:

AgentCollaboration, AgentCollaboration

agentCollaboration

CreateAgentRequest.Builder agentCollaboration(AgentCollaboration agentCollaboration)

The agent's collaboration role.

Parameters:

agentCollaboration - The agent's collaboration role.

Returns:

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

See Also:

AgentCollaboration, AgentCollaboration

overrideConfiguration

CreateAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder