java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest
    - - software.amazon.awssdk.services.bedrockagentruntime.model.InvokeAgentRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class InvokeAgentRequest
extends BedrockAgentRuntimeRequest
implements ToCopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InvokeAgentRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`agentAliasId()`	The alias of the agent to use.
`String`	`agentId()`	The unique identifier of the agent to use.
`BedrockModelConfigurations`	`bedrockModelConfigurations()`	Model performance settings for the request.
`static InvokeAgentRequest.Builder`	`builder()`
`Boolean`	`enableTrace()`	Specifies whether to turn on the trace or not to track the agent's reasoning process.
`Boolean`	`endSession()`	Specifies whether to end the session with the agent or not.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`inputText()`	The prompt text to send the agent.
`String`	`memoryId()`	The unique identifier of the agent memory.
`PromptCreationConfigurations`	`promptCreationConfigurations()`	Specifies parameters that control how the service populates the agent prompt for an `InvokeAgent` request.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InvokeAgentRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionId()`	The unique identifier of the session.
`SessionState`	`sessionState()`	Contains parameters that specify various attributes of the session.
`String`	`sourceArn()`	The ARN of the resource making the request.
`StreamingConfigurations`	`streamingConfigurations()`	Specifies the configurations for streaming.
`InvokeAgentRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - agentAliasId
```
public final String agentAliasId()
```
    The alias of the agent to use.
    
    Returns:
    
    The alias of the agent to use.
  - agentId
```
public final String agentId()
```
    The unique identifier of the agent to use.
    
    Returns:
    
    The unique identifier of the agent to use.
  - bedrockModelConfigurations
```
public final BedrockModelConfigurations bedrockModelConfigurations()
```
    Model performance settings for the request.
    
    Returns:
    
    Model performance settings for the request.
  - enableTrace
```
public final Boolean enableTrace()
```
    Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
    
    Returns:
    
    Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
  - endSession
```
public final Boolean endSession()
```
    Specifies whether to end the session with the agent or not.
    
    Returns:
    
    Specifies whether to end the session with the agent or not.
  - inputText
```
public final String inputText()
```
    The prompt text to send the agent.
    
    If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
    
    Returns:
    
    The prompt text to send the agent.
    
    If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
  - memoryId
```
public final String memoryId()
```
    The unique identifier of the agent memory.
    
    Returns:
    
    The unique identifier of the agent memory.
  - promptCreationConfigurations
```
public final PromptCreationConfigurations promptCreationConfigurations()
```
    Specifies parameters that control how the service populates the agent prompt for an InvokeAgent 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:
    
    Specifies parameters that control how the service populates the agent prompt for an InvokeAgent 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.
  - sessionId
```
public final String sessionId()
```
    The unique identifier of the session. Use the same value across requests to continue the same conversation.
    
    Returns:
    
    The unique identifier of the session. Use the same value across requests to continue the same conversation.
  - sessionState
```
public final SessionState sessionState()
```
    Contains parameters that specify various attributes of the session. For more information, see Control session context.
    
    If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
    
    Returns:
    
    Contains parameters that specify various attributes of the session. For more information, see Control session context.
    
    If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
  - sourceArn
```
public final String sourceArn()
```
    The ARN of the resource making the request.
    
    Returns:
    
    The ARN of the resource making the request.
  - streamingConfigurations
```
public final StreamingConfigurations streamingConfigurations()
```
    Specifies the configurations for streaming.
    
    To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
    
    Returns:
    
    Specifies the configurations for streaming.
    
    To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
  - toBuilder
```
public InvokeAgentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>
    
    Specified by:
    
    toBuilder in class BedrockAgentRuntimeRequest
  - builder
```
public static InvokeAgentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InvokeAgentRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class InvokeAgentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

agentAliasId

agentId

bedrockModelConfigurations

enableTrace

endSession

inputText

memoryId

promptCreationConfigurations

sessionId

sessionState

sourceArn

streamingConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField