Class OrchestrationTrace

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

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

See Also:

  • Method Details

    • rationale

      public final Rationale rationale()

      Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

      Returns:
      Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

    • invocationInput

      public final InvocationInput invocationInput()

      Contains information pertaining to the action group or knowledge base that is being invoked.

      Returns:
      Contains information pertaining to the action group or knowledge base that is being invoked.

    • observation

      public final Observation observation()

      Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

      Returns:
      Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

    • modelInvocationInput

      public final ModelInvocationInput modelInvocationInput()

      The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

      Returns:
      The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

    • modelInvocationOutput

      public final OrchestrationModelInvocationOutput modelInvocationOutput()

      Contains information pertaining to the output from the foundation model that is being invoked.

      Returns:
      Contains information pertaining to the output from the foundation model that is being invoked.

    • toBuilder

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

    • builder

      public static OrchestrationTrace.Builder builder()

    • serializableBuilderClass

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

    • fromRationale

      public static OrchestrationTrace fromRationale(Rationale rationale)
      Create an instance of this class with rationale() initialized to the given value.

      Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

      Parameters:
      rationale - Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

    • fromRationale

      public static OrchestrationTrace fromRationale(Consumer<Rationale.Builder> rationale)
      Create an instance of this class with rationale() initialized to the given value.

      Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

      Parameters:
      rationale - Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

    • fromInvocationInput

      public static OrchestrationTrace fromInvocationInput(InvocationInput invocationInput)
      Create an instance of this class with invocationInput() initialized to the given value.

      Contains information pertaining to the action group or knowledge base that is being invoked.

      Parameters:
      invocationInput - Contains information pertaining to the action group or knowledge base that is being invoked.

    • fromInvocationInput

      public static OrchestrationTrace fromInvocationInput(Consumer<InvocationInput.Builder> invocationInput)
      Create an instance of this class with invocationInput() initialized to the given value.

      Contains information pertaining to the action group or knowledge base that is being invoked.

      Parameters:
      invocationInput - Contains information pertaining to the action group or knowledge base that is being invoked.

    • fromObservation

      public static OrchestrationTrace fromObservation(Observation observation)
      Create an instance of this class with observation() initialized to the given value.

      Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

      Parameters:
      observation - Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

    • fromObservation

      public static OrchestrationTrace fromObservation(Consumer<Observation.Builder> observation)
      Create an instance of this class with observation() initialized to the given value.

      Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

      Parameters:
      observation - Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

    • fromModelInvocationInput

      public static OrchestrationTrace fromModelInvocationInput(ModelInvocationInput modelInvocationInput)
      Create an instance of this class with modelInvocationInput() initialized to the given value.

      The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

      Parameters:
      modelInvocationInput - The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

    • fromModelInvocationInput

      public static OrchestrationTrace fromModelInvocationInput(Consumer<ModelInvocationInput.Builder> modelInvocationInput)
      Create an instance of this class with modelInvocationInput() initialized to the given value.

      The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

      Parameters:
      modelInvocationInput - The input for the orchestration step.

      • The type is ORCHESTRATION.

      • The text contains the prompt.

      • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

    • fromModelInvocationOutput

      public static OrchestrationTrace fromModelInvocationOutput(OrchestrationModelInvocationOutput modelInvocationOutput)
      Create an instance of this class with modelInvocationOutput() initialized to the given value.

      Contains information pertaining to the output from the foundation model that is being invoked.

      Parameters:
      modelInvocationOutput - Contains information pertaining to the output from the foundation model that is being invoked.

    • fromModelInvocationOutput

      public static OrchestrationTrace fromModelInvocationOutput(Consumer<OrchestrationModelInvocationOutput.Builder> modelInvocationOutput)
      Create an instance of this class with modelInvocationOutput() initialized to the given value.

      Contains information pertaining to the output from the foundation model that is being invoked.

      Parameters:
      modelInvocationOutput - Contains information pertaining to the output from the foundation model that is being invoked.

    • type

      public OrchestrationTrace.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 OrchestrationTrace.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 OrchestrationTrace.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.

    • sdkFieldNameToField

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