Class EvaluationRagConfigSummary

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

A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.

See Also:

  • Method Details

    • hasBedrockKnowledgeBaseIdentifiers

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

    • bedrockKnowledgeBaseIdentifiers

      public final List<String> bedrockKnowledgeBaseIdentifiers()

      The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.

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

      Returns:
      The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.

    • hasPrecomputedRagSourceIdentifiers

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

    • precomputedRagSourceIdentifiers

      public final List<String> precomputedRagSourceIdentifiers()

      A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.

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

      Returns:
      A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.

    • toBuilder

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

    • builder

      public static EvaluationRagConfigSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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