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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEvaluationRagConfigSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.static EvaluationRagConfigSummary.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasBedrockKnowledgeBaseIdentifiers()For responses, this returns true if the service returned a value for the BedrockKnowledgeBaseIdentifiers property.inthashCode()booleanhasPrecomputedRagSourceIdentifiers()For responses, this returns true if the service returned a value for the PrecomputedRagSourceIdentifiers property.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.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends EvaluationRagConfigSummary.Builder>serializableBuilderClass()EvaluationRagConfigSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EvaluationRagConfigSummary.Builder,EvaluationRagConfigSummary>
-
builder
public static EvaluationRagConfigSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends EvaluationRagConfigSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-