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

Class KnowledgeBaseRetrievalResult

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

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

See Also:

  • Method Details

    • content

      public final RetrievalResultContent content()

      Contains information about the content of the chunk.

      Returns:
      Contains information about the content of the chunk.

    • location

      public final RetrievalResultLocation location()

      Contains information about the location of the data source.

      Returns:
      Contains information about the location of the data source.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata 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.

    • metadata

      public final Map<String,Document> metadata()

      Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

      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 hasMetadata() method.

      Returns:
      Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

    • score

      public final Double score()

      The level of relevance of the result to the query.

      Returns:
      The level of relevance of the result to the query.

    • toBuilder

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

    • builder

      public static KnowledgeBaseRetrievalResult.Builder builder()

    • serializableBuilderClass

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