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>

  • Method Details

    • 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.

    • agentId

      public final String agentId()

      The unique identifier of the agent to use.

      Returns:
      The unique identifier of the agent to use.

    • agentAliasId

      public final String agentAliasId()

      The alias of the agent to use.

      Returns:
      The alias of the agent to use.

    • 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.

    • 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.

    • 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.

    • 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.

    • bedrockModelConfigurations

      public final BedrockModelConfigurations bedrockModelConfigurations()

      Model performance settings for the request.

      Returns:
      Model performance settings for 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.

    • 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.

    • sourceArn

      public final String sourceArn()

      The ARN of the resource making the request.

      Returns:
      The ARN of the resource making the request.

    • toBuilder

      public InvokeAgentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeAgentRequest.Builder,InvokeAgentRequest>
      Specified by:
      toBuilder in class BedrockAgentRuntimeRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.