Class Trace

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.Trace
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Trace.Builder,Trace>
@Generated("software.amazon.awssdk:codegen") public final class Trace extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Trace.Builder,Trace>

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

See Also:

  • Method Details

    • failureTrace

      public final FailureTrace failureTrace()

      Contains information about the failure of the interaction.

      Returns:
      Contains information about the failure of the interaction.

    • guardrailTrace

      public final GuardrailTrace guardrailTrace()

      The trace details for a trace defined in the Guardrail filter.

      Returns:
      The trace details for a trace defined in the Guardrail filter.

    • orchestrationTrace

      public final OrchestrationTrace orchestrationTrace()

      Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

      Returns:
      Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

    • postProcessingTrace

      public final PostProcessingTrace postProcessingTrace()

      Details about the post-processing step, in which the agent shapes the response..

      Returns:
      Details about the post-processing step, in which the agent shapes the response..

    • preProcessingTrace

      public final PreProcessingTrace preProcessingTrace()

      Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

      Returns:
      Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

    • toBuilder

      public Trace.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<Trace.Builder,Trace>
      Returns:
      a builder for type T

    • builder

      public static Trace.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Trace.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)

    • fromFailureTrace

      public static Trace fromFailureTrace(FailureTrace failureTrace)
      Create an instance of this class with failureTrace() initialized to the given value.

      Contains information about the failure of the interaction.

      Parameters:
      failureTrace - Contains information about the failure of the interaction.

    • fromFailureTrace

      public static Trace fromFailureTrace(Consumer<FailureTrace.Builder> failureTrace)
      Create an instance of this class with failureTrace() initialized to the given value.

      Contains information about the failure of the interaction.

      Parameters:
      failureTrace - Contains information about the failure of the interaction.

    • fromGuardrailTrace

      public static Trace fromGuardrailTrace(GuardrailTrace guardrailTrace)
      Create an instance of this class with guardrailTrace() initialized to the given value.

      The trace details for a trace defined in the Guardrail filter.

      Parameters:
      guardrailTrace - The trace details for a trace defined in the Guardrail filter.

    • fromGuardrailTrace

      public static Trace fromGuardrailTrace(Consumer<GuardrailTrace.Builder> guardrailTrace)
      Create an instance of this class with guardrailTrace() initialized to the given value.

      The trace details for a trace defined in the Guardrail filter.

      Parameters:
      guardrailTrace - The trace details for a trace defined in the Guardrail filter.

    • fromOrchestrationTrace

      public static Trace fromOrchestrationTrace(OrchestrationTrace orchestrationTrace)
      Create an instance of this class with orchestrationTrace() initialized to the given value.

      Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

      Parameters:
      orchestrationTrace - Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

    • fromOrchestrationTrace

      public static Trace fromOrchestrationTrace(Consumer<OrchestrationTrace.Builder> orchestrationTrace)
      Create an instance of this class with orchestrationTrace() initialized to the given value.

      Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

      Parameters:
      orchestrationTrace - Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

    • fromPostProcessingTrace

      public static Trace fromPostProcessingTrace(PostProcessingTrace postProcessingTrace)
      Create an instance of this class with postProcessingTrace() initialized to the given value.

      Details about the post-processing step, in which the agent shapes the response..

      Parameters:
      postProcessingTrace - Details about the post-processing step, in which the agent shapes the response..

    • fromPostProcessingTrace

      public static Trace fromPostProcessingTrace(Consumer<PostProcessingTrace.Builder> postProcessingTrace)
      Create an instance of this class with postProcessingTrace() initialized to the given value.

      Details about the post-processing step, in which the agent shapes the response..

      Parameters:
      postProcessingTrace - Details about the post-processing step, in which the agent shapes the response..

    • fromPreProcessingTrace

      public static Trace fromPreProcessingTrace(PreProcessingTrace preProcessingTrace)
      Create an instance of this class with preProcessingTrace() initialized to the given value.

      Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

      Parameters:
      preProcessingTrace - Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

    • fromPreProcessingTrace

      public static Trace fromPreProcessingTrace(Consumer<PreProcessingTrace.Builder> preProcessingTrace)
      Create an instance of this class with preProcessingTrace() initialized to the given value.

      Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

      Parameters:
      preProcessingTrace - Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

    • type

      public Trace.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Trace.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Trace.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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