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

Class InvokeAgentRequest

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

Modifier and Type	Method	Description
String	agentAliasId()	The alias of the agent to use.
String	agentId()	The unique identifier of the agent to use.
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.
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.
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.

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.

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.

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