Interface Collaborator.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Collaborator.Builder,
,Collaborator> SdkBuilder<Collaborator.Builder,
,Collaborator> SdkPojo
- Enclosing class:
Collaborator
-
Method Summary
Modifier and TypeMethodDescriptionactionGroups
(Collection<AgentActionGroup> actionGroups) List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.actionGroups
(Consumer<AgentActionGroup.Builder>... actionGroups) List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.actionGroups
(AgentActionGroup... actionGroups) List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.agentCollaboration
(String agentCollaboration) Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.agentCollaboration
(AgentCollaboration agentCollaboration) Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.Name of the inline collaborator agent which must be the same name as specified forcollaboratorName
.collaboratorConfigurations
(Collection<CollaboratorConfiguration> collaboratorConfigurations) Settings of the collaborator agent.collaboratorConfigurations
(Consumer<CollaboratorConfiguration.Builder>... collaboratorConfigurations) Settings of the collaborator agent.collaboratorConfigurations
(CollaboratorConfiguration... collaboratorConfigurations) Settings of the collaborator agent.customerEncryptionKeyArn
(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.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.guardrailConfiguration
(GuardrailConfigurationWithArn guardrailConfiguration) Details of the guardwrail associated with the inline collaborator.idleSessionTTLInSeconds
(Integer idleSessionTTLInSeconds) The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.instruction
(String instruction) Instruction that tell the inline collaborator agent what it should do and how it should interact with users.knowledgeBases
(Collection<KnowledgeBase> knowledgeBases) Knowledge base associated with the inline collaborator agent.knowledgeBases
(Consumer<KnowledgeBase.Builder>... knowledgeBases) Knowledge base associated with the inline collaborator agent.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.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 Details
-
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
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
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 theAgentActionGroup.Builder
avoiding the need to create one manually viaAgentActionGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionGroups(List<AgentActionGroup>)
.- Parameters:
actionGroups
- a consumer that will call methods onAgentActionGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
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 forcollaboratorName
.- 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 theCollaboratorConfiguration.Builder
avoiding the need to create one manually viaCollaboratorConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocollaboratorConfigurations(List<CollaboratorConfiguration>)
.- Parameters:
collaboratorConfigurations
- a consumer that will call methods onCollaboratorConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theGuardrailConfigurationWithArn.Builder
avoiding the need to create one manually viaGuardrailConfigurationWithArn.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toguardrailConfiguration(GuardrailConfigurationWithArn)
.- Parameters:
guardrailConfiguration
- a consumer that will call methods onGuardrailConfigurationWithArn.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
Knowledge base associated with the inline collaborator agent.
This is a convenience method that creates an instance of theKnowledgeBase.Builder
avoiding the need to create one manually viaKnowledgeBase.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toknowledgeBases(List<KnowledgeBase>)
.- Parameters:
knowledgeBases
- a consumer that will call methods onKnowledgeBase.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 thePromptOverrideConfiguration.Builder
avoiding the need to create one manually viaPromptOverrideConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topromptOverrideConfiguration(PromptOverrideConfiguration)
.- Parameters:
promptOverrideConfiguration
- a consumer that will call methods onPromptOverrideConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-