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

Interface Collaborator.Builder

All Superinterfaces:

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

Enclosing class:

Collaborator

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

Method Summary

Modifier and Type	Method	Description
Collaborator.Builder	actionGroups(Collection<AgentActionGroup> actionGroups)	List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
Collaborator.Builder	actionGroups(Consumer<AgentActionGroup.Builder>... actionGroups)	List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
Collaborator.Builder	actionGroups(AgentActionGroup... actionGroups)	List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
Collaborator.Builder	agentCollaboration(String agentCollaboration)	Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
Collaborator.Builder	agentCollaboration(AgentCollaboration agentCollaboration)	Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
Collaborator.Builder	agentName(String agentName)	Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
Collaborator.Builder	collaboratorConfigurations(Collection<CollaboratorConfiguration> collaboratorConfigurations)	Settings of the collaborator agent.
Collaborator.Builder	collaboratorConfigurations(Consumer<CollaboratorConfiguration.Builder>... collaboratorConfigurations)	Settings of the collaborator agent.
Collaborator.Builder	collaboratorConfigurations(CollaboratorConfiguration... collaboratorConfigurations)	Settings of the collaborator agent.
Collaborator.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
Collaborator.Builder	foundationModel(String foundationModel)	The foundation model used by the inline collaborator agent.
default Collaborator.Builder	guardrailConfiguration(Consumer<GuardrailConfigurationWithArn.Builder> guardrailConfiguration)	Details of the guardwrail associated with the inline collaborator.
Collaborator.Builder	guardrailConfiguration(GuardrailConfigurationWithArn guardrailConfiguration)	Details of the guardwrail associated with the inline collaborator.
Collaborator.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)	The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
Collaborator.Builder	instruction(String instruction)	Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
Collaborator.Builder	knowledgeBases(Collection<KnowledgeBase> knowledgeBases)	Knowledge base associated with the inline collaborator agent.
Collaborator.Builder	knowledgeBases(Consumer<KnowledgeBase.Builder>... knowledgeBases)	Knowledge base associated with the inline collaborator agent.
Collaborator.Builder	knowledgeBases(KnowledgeBase... knowledgeBases)	Knowledge base associated with the inline collaborator agent.
default Collaborator.Builder	promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)	Contains configurations to override prompt templates in different parts of an inline collaborator sequence.
Collaborator.Builder	promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)	Contains configurations to override prompt templates in different parts of an inline collaborator sequence.

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

actionGroups

Collaborator.Builder actionGroups(Collection<AgentActionGroup> actionGroups)

List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

Parameters:

actionGroups - List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

Returns:

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

actionGroups

Collaborator.Builder actionGroups(AgentActionGroup... actionGroups)

List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

Parameters:

actionGroups - List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

Returns:

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

actionGroups

Collaborator.Builder actionGroups(Consumer<AgentActionGroup.Builder>... actionGroups)

List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #actionGroups(List).

Parameters:

actionGroups - a consumer that will call methods on AgentActionGroup.Builder

Returns:

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

See Also:

#actionGroups(java.util.Collection)

agentCollaboration

Collaborator.Builder agentCollaboration(String agentCollaboration)

Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.

Parameters:

agentCollaboration - Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.

Returns:

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

See Also:

AgentCollaboration, AgentCollaboration

agentCollaboration

Collaborator.Builder agentCollaboration(AgentCollaboration agentCollaboration)

Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.

Parameters:

agentCollaboration - Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.

Returns:

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

See Also:

AgentCollaboration, AgentCollaboration

agentName

Collaborator.Builder agentName(String agentName)

Name of the inline collaborator agent which must be the same name as specified for collaboratorName.

Parameters:

agentName - Name of the inline collaborator agent which must be the same name as specified for collaboratorName.

Returns:

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

collaboratorConfigurations

Collaborator.Builder collaboratorConfigurations(Collection<CollaboratorConfiguration> collaboratorConfigurations)

Settings of the collaborator agent.

Parameters:

collaboratorConfigurations - Settings of the collaborator agent.

Returns:

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

collaboratorConfigurations

Collaborator.Builder collaboratorConfigurations(CollaboratorConfiguration... collaboratorConfigurations)

Settings of the collaborator agent.

Parameters:

collaboratorConfigurations - Settings of the collaborator agent.

Returns:

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

collaboratorConfigurations

Collaborator.Builder collaboratorConfigurations(Consumer<CollaboratorConfiguration.Builder>... collaboratorConfigurations)

Settings of the collaborator agent.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #collaboratorConfigurations(List).

Parameters:

collaboratorConfigurations - a consumer that will call methods on CollaboratorConfiguration.Builder

Returns:

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

See Also:

#collaboratorConfigurations(java.util.Collection)

customerEncryptionKeyArn

Collaborator.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.

Returns:

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

foundationModel

Collaborator.Builder foundationModel(String foundationModel)

The foundation model used by the inline collaborator agent.

Parameters:

foundationModel - The foundation model used by the inline collaborator agent.

Returns:

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

guardrailConfiguration

Collaborator.Builder guardrailConfiguration(GuardrailConfigurationWithArn guardrailConfiguration)

Details of the guardwrail associated with the inline collaborator.

Parameters:

guardrailConfiguration - Details of the guardwrail associated with the inline collaborator.

Returns:

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

guardrailConfiguration

default Collaborator.Builder guardrailConfiguration(Consumer<GuardrailConfigurationWithArn.Builder> guardrailConfiguration)

Details of the guardwrail associated with the inline collaborator.

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

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

Parameters:

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

Returns:

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

See Also:

guardrailConfiguration(GuardrailConfigurationWithArn)

idleSessionTTLInSeconds

Collaborator.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator 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 the Amazon Bedrock keeps information about the user's conversation with the inline collaborator 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.

instruction

Collaborator.Builder instruction(String instruction)

Instruction that tell the inline collaborator agent what it should do and how it should interact with users.

Parameters:

instruction - Instruction that tell the inline collaborator 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

Collaborator.Builder knowledgeBases(Collection<KnowledgeBase> knowledgeBases)

Knowledge base associated with the inline collaborator agent.

Parameters:

knowledgeBases - Knowledge base associated with the inline collaborator agent.

Returns:

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

knowledgeBases

Collaborator.Builder knowledgeBases(KnowledgeBase... knowledgeBases)

Knowledge base associated with the inline collaborator agent.

Parameters:

knowledgeBases - Knowledge base associated with the inline collaborator agent.

Returns:

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

knowledgeBases

Collaborator.Builder knowledgeBases(Consumer<KnowledgeBase.Builder>... knowledgeBases)

Knowledge base associated with the inline collaborator agent.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #knowledgeBases(List).

Parameters:

knowledgeBases - a consumer that will call methods on KnowledgeBase.Builder

Returns:

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

See Also:

#knowledgeBases(java.util.Collection)

promptOverrideConfiguration

Collaborator.Builder promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.

Parameters:

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

Returns:

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

promptOverrideConfiguration

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

Contains configurations to override prompt templates in different parts of an inline collaborator 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)