Package software.amazon.awssdk.services.bedrock.model

Class EvaluationInferenceConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.EvaluationInferenceConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EvaluationInferenceConfig.Builder,EvaluationInferenceConfig>

@Generated("software.amazon.awssdk:codegen")
public final class EvaluationInferenceConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EvaluationInferenceConfig.Builder,EvaluationInferenceConfig>

The configuration details of the inference model for an evaluation job.

For automated model evaluation jobs, only a single model is supported.

For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EvaluationInferenceConfig.Builder
static class	EvaluationInferenceConfig.Type

Method Summary

Modifier and Type	Method	Description
static EvaluationInferenceConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static EvaluationInferenceConfig	fromModels(List<EvaluationModelConfig> models)	Create an instance of this class with models() initialized to the given value.
static EvaluationInferenceConfig	fromRagConfigs(List<RAGConfig> ragConfigs)	Create an instance of this class with ragConfigs() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasModels()	For responses, this returns true if the service returned a value for the Models property.
boolean	hasRagConfigs()	For responses, this returns true if the service returned a value for the RagConfigs property.
List<EvaluationModelConfig>	models()	Specifies the inference models.
List<RAGConfig>	ragConfigs()	Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluationInferenceConfig.Builder>	serializableBuilderClass()
EvaluationInferenceConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EvaluationInferenceConfig.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

hasModels

public final boolean hasModels()

For responses, this returns true if the service returned a value for the Models 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.

models

public final List<EvaluationModelConfig> models()

Specifies the inference models.

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

Returns:

Specifies the inference models.

hasRagConfigs

public final boolean hasRagConfigs()

For responses, this returns true if the service returned a value for the RagConfigs 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.

ragConfigs

public final List<RAGConfig> ragConfigs()

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

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

Returns:

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

toBuilder

public EvaluationInferenceConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluationInferenceConfig.Builder,EvaluationInferenceConfig>

builder

public static EvaluationInferenceConfig.Builder builder()

serializableBuilderClass

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

fromModels

public static EvaluationInferenceConfig fromModels(List<EvaluationModelConfig> models)

Create an instance of this class with models() initialized to the given value.

Specifies the inference models.

Parameters:

models - Specifies the inference models.

fromRagConfigs

public static EvaluationInferenceConfig fromRagConfigs(List<RAGConfig> ragConfigs)

Create an instance of this class with ragConfigs() initialized to the given value.

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

Parameters:

ragConfigs - Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

type

public EvaluationInferenceConfig.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be EvaluationInferenceConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be EvaluationInferenceConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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