Class AgentCoreRuntimeInvocation

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.AgentCoreRuntimeInvocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentCoreRuntimeInvocation.Builder,AgentCoreRuntimeInvocation>

@Generated("software.amazon.awssdk:codegen") public final class AgentCoreRuntimeInvocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AgentCoreRuntimeInvocation.Builder,AgentCoreRuntimeInvocation>

The configuration for invoking an agent hosted on AgentCore Runtime. Each scenario runs in its own runtime session, and the turns of a scenario are sent in order within that session. The batch evaluation uses your credentials to read the agent runtime endpoint and the dataset, invoke the agent runtime, and read the resulting traces. You must have permission for these actions.

See Also:
  • Method Details

    • agentRuntimeEndpointArn

      public final String agentRuntimeEndpointArn()

      The Amazon Resource Name (ARN) of the agent runtime endpoint to invoke. Specify an endpoint in the same account and Region as the batch evaluation. The service requires the endpoint and its agent runtime version to be ready. The agent runtime must use the HTTP protocol and IAM inbound authorization.

      Returns:
      The Amazon Resource Name (ARN) of the agent runtime endpoint to invoke. Specify an endpoint in the same account and Region as the batch evaluation. The service requires the endpoint and its agent runtime version to be ready. The agent runtime must use the HTTP protocol and IAM inbound authorization.
    • requestTemplate

      public final String requestTemplate()

      A JSON object template for the request payload sent to the agent for each turn. The template must contain the placeholder {{turn.input}} exactly once, as the complete value of a JSON string and not as a field name. The service replaces the placeholder with the input of the turn. If the input isn't a string, the service inserts it as a JSON value. If you don't specify a template, the service uses {"prompt": "{{turn.input}}"}.

      Returns:
      A JSON object template for the request payload sent to the agent for each turn. The template must contain the placeholder {{turn.input}} exactly once, as the complete value of a JSON string and not as a field name. The service replaces the placeholder with the input of the turn. If the input isn't a string, the service inserts it as a JSON value. If you don't specify a template, the service uses {"prompt": "{{turn.input}}"}.
    • 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<AgentCoreRuntimeInvocation.Builder,AgentCoreRuntimeInvocation>
      Returns:
      a builder for type T
    • builder

      public static AgentCoreRuntimeInvocation.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AgentCoreRuntimeInvocation.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.