Interface InvokeInlineAgentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BedrockAgentRuntimeRequest.Builder
,Buildable
,CopyableBuilder<InvokeInlineAgentRequest.Builder,
,InvokeInlineAgentRequest> SdkBuilder<InvokeInlineAgentRequest.Builder,
,InvokeInlineAgentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
InvokeInlineAgentRequest
-
Method Summary
Modifier and TypeMethodDescriptionactionGroups
(Collection<AgentActionGroup> actionGroups) A list of action groups with each action group defining the action the inline agent needs to carry out.actionGroups
(Consumer<AgentActionGroup.Builder>... actionGroups) A list of action groups with each action group defining the action the inline agent needs to carry out.actionGroups
(AgentActionGroup... actionGroups) A list of action groups with each action group defining the action the inline agent needs to carry out.agentCollaboration
(String agentCollaboration) Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response.agentCollaboration
(AgentCollaboration agentCollaboration) Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response.The name for the agent.default InvokeInlineAgentRequest.Builder
bedrockModelConfigurations
(Consumer<InlineBedrockModelConfigurations.Builder> bedrockModelConfigurations) Model settings for the request.bedrockModelConfigurations
(InlineBedrockModelConfigurations bedrockModelConfigurations) Model settings for the request.collaboratorConfigurations
(Collection<CollaboratorConfiguration> collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.collaboratorConfigurations
(Consumer<CollaboratorConfiguration.Builder>... collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.collaboratorConfigurations
(CollaboratorConfiguration... collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.collaborators
(Collection<Collaborator> collaborators) List of collaborator inline agents.collaborators
(Consumer<Collaborator.Builder>... collaborators) List of collaborator inline agents.collaborators
(Collaborator... collaborators) List of collaborator inline agents.customerEncryptionKeyArn
(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.default InvokeInlineAgentRequest.Builder
customOrchestration
(Consumer<CustomOrchestration.Builder> customOrchestration) Contains details of the custom orchestration configured for the agent.customOrchestration
(CustomOrchestration customOrchestration) Contains details of the custom orchestration configured for the agent.enableTrace
(Boolean enableTrace) Specifies whether to turn on the trace or not to track the agent's reasoning process.endSession
(Boolean endSession) Specifies whether to end the session with the inline agent or not.foundationModel
(String foundationModel) The model identifier (ID) of the model to use for orchestration by the inline agent.default InvokeInlineAgentRequest.Builder
guardrailConfiguration
(Consumer<GuardrailConfigurationWithArn.Builder> guardrailConfiguration) The guardrails to assign to the inline agent.guardrailConfiguration
(GuardrailConfigurationWithArn guardrailConfiguration) The guardrails to assign to the inline agent.idleSessionTTLInSeconds
(Integer idleSessionTTLInSeconds) The number of seconds for which the inline agent should maintain session information.default InvokeInlineAgentRequest.Builder
inlineSessionState
(Consumer<InlineSessionState.Builder> inlineSessionState) Parameters that specify the various attributes of a sessions.inlineSessionState
(InlineSessionState inlineSessionState) Parameters that specify the various attributes of a sessions.The prompt text to send to the agent.instruction
(String instruction) The instructions that tell the inline agent what it should do and how it should interact with users.knowledgeBases
(Collection<KnowledgeBase> knowledgeBases) Contains information of the knowledge bases to associate with.knowledgeBases
(Consumer<KnowledgeBase.Builder>... knowledgeBases) Contains information of the knowledge bases to associate with.knowledgeBases
(KnowledgeBase... knowledgeBases) Contains information of the knowledge bases to associate with.orchestrationType
(String orchestrationType) Specifies the type of orchestration strategy for the agent.orchestrationType
(OrchestrationType orchestrationType) Specifies the type of orchestration strategy for the agent.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default InvokeInlineAgentRequest.Builder
promptCreationConfigurations
(Consumer<PromptCreationConfigurations.Builder> promptCreationConfigurations) Specifies parameters that control how the service populates the agent prompt for anInvokeInlineAgent
request.promptCreationConfigurations
(PromptCreationConfigurations promptCreationConfigurations) Specifies parameters that control how the service populates the agent prompt for anInvokeInlineAgent
request.default InvokeInlineAgentRequest.Builder
promptOverrideConfiguration
(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration) Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.promptOverrideConfiguration
(PromptOverrideConfiguration promptOverrideConfiguration) Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.The unique identifier of the session.default InvokeInlineAgentRequest.Builder
streamingConfigurations
(Consumer<StreamingConfigurations.Builder> streamingConfigurations) Specifies the configurations for streaming.streamingConfigurations
(StreamingConfigurations streamingConfigurations) Specifies the configurations for streaming.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.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 Details
-
actionGroups
A list of action groups with each action group defining the action the inline agent needs to carry out.
- Parameters:
actionGroups
- A list of action groups with each action group defining the action the inline agent needs to carry out.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionGroups
A list of action groups with each action group defining the action the inline agent needs to carry out.
- Parameters:
actionGroups
- A list of action groups with each action group defining the action the inline agent needs to carry out.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionGroups
A list of action groups with each action group defining the action the inline 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 collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
- Parameters:
agentCollaboration
- Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
agentCollaboration
Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
- Parameters:
agentCollaboration
- Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
agentName
The name for the agent.
- Parameters:
agentName
- The name for the agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bedrockModelConfigurations
InvokeInlineAgentRequest.Builder bedrockModelConfigurations(InlineBedrockModelConfigurations bedrockModelConfigurations) Model settings for the request.
- Parameters:
bedrockModelConfigurations
- Model settings for the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bedrockModelConfigurations
default InvokeInlineAgentRequest.Builder bedrockModelConfigurations(Consumer<InlineBedrockModelConfigurations.Builder> bedrockModelConfigurations) Model settings for the request.
This is a convenience method that creates an instance of theInlineBedrockModelConfigurations.Builder
avoiding the need to create one manually viaInlineBedrockModelConfigurations.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobedrockModelConfigurations(InlineBedrockModelConfigurations)
.- Parameters:
bedrockModelConfigurations
- a consumer that will call methods onInlineBedrockModelConfigurations.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
collaboratorConfigurations
InvokeInlineAgentRequest.Builder collaboratorConfigurations(Collection<CollaboratorConfiguration> collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.
- Parameters:
collaboratorConfigurations
- Settings for an inline agent collaborator called with InvokeInlineAgent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
collaboratorConfigurations
InvokeInlineAgentRequest.Builder collaboratorConfigurations(CollaboratorConfiguration... collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.
- Parameters:
collaboratorConfigurations
- Settings for an inline agent collaborator called with InvokeInlineAgent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
collaboratorConfigurations
InvokeInlineAgentRequest.Builder collaboratorConfigurations(Consumer<CollaboratorConfiguration.Builder>... collaboratorConfigurations) Settings for an inline agent collaborator called with InvokeInlineAgent.
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:
-
collaborators
List of collaborator inline agents.
- Parameters:
collaborators
- List of collaborator inline agents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
collaborators
List of collaborator inline agents.
- Parameters:
collaborators
- List of collaborator inline agents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
collaborators
List of collaborator inline agents.
This is a convenience method that creates an instance of theCollaborator.Builder
avoiding the need to create one manually viaCollaborator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocollaborators(List<Collaborator>)
.- Parameters:
collaborators
- a consumer that will call methods onCollaborator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 InvokeInlineAgentRequest.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 theCustomOrchestration.Builder
avoiding the need to create one manually viaCustomOrchestration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomOrchestration(CustomOrchestration)
.- Parameters:
customOrchestration
- a consumer that will call methods onCustomOrchestration.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 Amazon Web Services KMS key to use to encrypt your inline agent.
- Parameters:
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableTrace
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
- Parameters:
enableTrace
- Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endSession
Specifies whether to end the session with the inline agent or not.
- Parameters:
endSession
- Specifies whether to end the session with the inline agent or not.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
foundationModel
The model identifier (ID) of the model to use for orchestration by the inline agent. For example,
meta.llama3-1-70b-instruct-v1:0
.- Parameters:
foundationModel
- The model identifier (ID) of the model to use for orchestration by the inline agent. For example,meta.llama3-1-70b-instruct-v1:0
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guardrailConfiguration
InvokeInlineAgentRequest.Builder guardrailConfiguration(GuardrailConfigurationWithArn guardrailConfiguration) The guardrails to assign to the inline agent.
- Parameters:
guardrailConfiguration
- The guardrails to assign to the inline agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guardrailConfiguration
default InvokeInlineAgentRequest.Builder guardrailConfiguration(Consumer<GuardrailConfigurationWithArn.Builder> guardrailConfiguration) The guardrails to assign to the inline agent.
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 inline agent should maintain session information. After this time expires, the subsequent
InvokeInlineAgent
request begins a new session.A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
- Parameters:
idleSessionTTLInSeconds
- The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequentInvokeInlineAgent
request begins a new session.A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inlineSessionState
Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.
If you include
returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored.- Parameters:
inlineSessionState
- Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.If you include
returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inlineSessionState
default InvokeInlineAgentRequest.Builder inlineSessionState(Consumer<InlineSessionState.Builder> inlineSessionState) Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.
If you include
returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored.InlineSessionState.Builder
avoiding the need to create one manually viaInlineSessionState.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinlineSessionState(InlineSessionState)
.- Parameters:
inlineSessionState
- a consumer that will call methods onInlineSessionState.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
inputText
The prompt text to send to the agent.
If you include
returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored.- Parameters:
inputText
- The prompt text to send to the agent.If you include
returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instruction
The instructions that tell the inline agent what it should do and how it should interact with users.
- Parameters:
instruction
- The instructions that tell the inline 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
Contains information of the knowledge bases to associate with.
- Parameters:
knowledgeBases
- Contains information of the knowledge bases to associate with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBases
Contains information of the knowledge bases to associate with.
- Parameters:
knowledgeBases
- Contains information of the knowledge bases to associate with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBases
Contains information of the knowledge bases to associate with.
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:
-
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
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:
-
promptCreationConfigurations
InvokeInlineAgentRequest.Builder promptCreationConfigurations(PromptCreationConfigurations promptCreationConfigurations) Specifies parameters that control how the service populates the agent prompt for an
InvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.- Parameters:
promptCreationConfigurations
- Specifies parameters that control how the service populates the agent prompt for anInvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
promptCreationConfigurations
default InvokeInlineAgentRequest.Builder promptCreationConfigurations(Consumer<PromptCreationConfigurations.Builder> promptCreationConfigurations) Specifies parameters that control how the service populates the agent prompt for an
This is a convenience method that creates an instance of theInvokeInlineAgent
request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.PromptCreationConfigurations.Builder
avoiding the need to create one manually viaPromptCreationConfigurations.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topromptCreationConfigurations(PromptCreationConfigurations)
.- Parameters:
promptCreationConfigurations
- a consumer that will call methods onPromptCreationConfigurations.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
promptOverrideConfiguration
InvokeInlineAgentRequest.Builder promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration) Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
- Parameters:
promptOverrideConfiguration
- Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
promptOverrideConfiguration
default InvokeInlineAgentRequest.Builder promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration) Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
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:
-
sessionId
The unique identifier of the session. Use the same value across requests to continue the same conversation.
- Parameters:
sessionId
- The unique identifier of the session. Use the same value across requests to continue the same conversation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamingConfigurations
InvokeInlineAgentRequest.Builder streamingConfigurations(StreamingConfigurations streamingConfigurations) Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the
bedrock:InvokeModelWithResponseStream
action.- Parameters:
streamingConfigurations
- Specifies the configurations for streaming.To use agent streaming, you need permissions to perform the
bedrock:InvokeModelWithResponseStream
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamingConfigurations
default InvokeInlineAgentRequest.Builder streamingConfigurations(Consumer<StreamingConfigurations.Builder> streamingConfigurations) Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the
bedrock:InvokeModelWithResponseStream
action.StreamingConfigurations.Builder
avoiding the need to create one manually viaStreamingConfigurations.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamingConfigurations(StreamingConfigurations)
.- Parameters:
streamingConfigurations
- a consumer that will call methods onStreamingConfigurations.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
InvokeInlineAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
InvokeInlineAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-