Package software.amazon.awssdk.services.bedrockagentruntime.model

Class KnowledgeBaseLookupOutput

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

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

See Also:

  • Method Details

    • metadata

      public final Metadata metadata()

      Contains information about the knowledge base output.

      Returns:
      Contains information about the knowledge base output.

    • hasRetrievedReferences

      public final boolean hasRetrievedReferences()
      For responses, this returns true if the service returned a value for the RetrievedReferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • retrievedReferences

      public final List<RetrievedReference> retrievedReferences()

      Contains metadata about the sources cited for the generated response.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRetrievedReferences() method.

      Returns:
      Contains metadata about the sources cited for the generated response.

    • toBuilder

      public KnowledgeBaseLookupOutput.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<KnowledgeBaseLookupOutput.Builder,KnowledgeBaseLookupOutput>

    • builder

      public static KnowledgeBaseLookupOutput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KnowledgeBaseLookupOutput.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo