Class Observation

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

Contains the result or output of an action group or knowledge base, or the response to the user.

See Also:

  • Method Details

    • actionGroupInvocationOutput

      public final ActionGroupInvocationOutput actionGroupInvocationOutput()

      Contains the JSON-formatted string returned by the API invoked by the action group.

      Returns:
      Contains the JSON-formatted string returned by the API invoked by the action group.

    • codeInterpreterInvocationOutput

      public final CodeInterpreterInvocationOutput codeInterpreterInvocationOutput()

      Contains the JSON-formatted string returned by the API invoked by the code interpreter.

      Returns:
      Contains the JSON-formatted string returned by the API invoked by the code interpreter.

    • finalResponse

      public final FinalResponse finalResponse()

      Contains details about the response to the user.

      Returns:
      Contains details about the response to the user.

    • knowledgeBaseLookupOutput

      public final KnowledgeBaseLookupOutput knowledgeBaseLookupOutput()

      Contains details about the results from looking up the knowledge base.

      Returns:
      Contains details about the results from looking up the knowledge base.

    • repromptResponse

      public final RepromptResponse repromptResponse()

      Contains details about the response to reprompt the input.

      Returns:
      Contains details about the response to reprompt the input.

    • traceId

      public final String traceId()

      The unique identifier of the trace.

      Returns:
      The unique identifier of the trace.

    • type

      public final Type type()

      Specifies what kind of information the agent returns in the observation. The following values are possible.

      • ACTION_GROUP – The agent returns the result of an action group.

      • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

      • FINISH – The agent returns a final response to the user with no follow-up.

      • ASK_USER – The agent asks the user a question.

      • REPROMPT – The agent prompts the user again for the same information.

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies what kind of information the agent returns in the observation. The following values are possible.

      • ACTION_GROUP – The agent returns the result of an action group.

      • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

      • FINISH – The agent returns a final response to the user with no follow-up.

      • ASK_USER – The agent asks the user a question.

      • REPROMPT – The agent prompts the user again for the same information.

      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies what kind of information the agent returns in the observation. The following values are possible.

      • ACTION_GROUP – The agent returns the result of an action group.

      • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

      • FINISH – The agent returns a final response to the user with no follow-up.

      • ASK_USER – The agent asks the user a question.

      • REPROMPT – The agent prompts the user again for the same information.

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies what kind of information the agent returns in the observation. The following values are possible.

      • ACTION_GROUP – The agent returns the result of an action group.

      • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

      • FINISH – The agent returns a final response to the user with no follow-up.

      • ASK_USER – The agent asks the user a question.

      • REPROMPT – The agent prompts the user again for the same information.

      See Also:

    • toBuilder

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

    • builder

      public static Observation.Builder builder()

    • serializableBuilderClass

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