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

Interface EvaluationSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EvaluationSummary.Builder,EvaluationSummary>, SdkBuilder<EvaluationSummary.Builder,EvaluationSummary>, SdkPojo

Enclosing class:

EvaluationSummary

@Mutable
@NotThreadSafe
public static interface EvaluationSummary.Builder
extends SdkPojo, CopyableBuilder<EvaluationSummary.Builder,EvaluationSummary>

Method Summary

Modifier and Type	Method	Description
EvaluationSummary.Builder	applicationType(String applicationType)	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
EvaluationSummary.Builder	applicationType(ApplicationType applicationType)	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
EvaluationSummary.Builder	creationTime(Instant creationTime)	The time the evaluation job was created.
EvaluationSummary.Builder	customMetricsEvaluatorModelIdentifiers(String... customMetricsEvaluatorModelIdentifiers)	The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
EvaluationSummary.Builder	customMetricsEvaluatorModelIdentifiers(Collection<String> customMetricsEvaluatorModelIdentifiers)	The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
EvaluationSummary.Builder	evaluationTaskTypes(Collection<EvaluationTaskType> evaluationTaskTypes)	The type of task for model evaluation.
EvaluationSummary.Builder	evaluationTaskTypes(EvaluationTaskType... evaluationTaskTypes)	The type of task for model evaluation.
EvaluationSummary.Builder	evaluationTaskTypesWithStrings(String... evaluationTaskTypes)	The type of task for model evaluation.
EvaluationSummary.Builder	evaluationTaskTypesWithStrings(Collection<String> evaluationTaskTypes)	The type of task for model evaluation.
EvaluationSummary.Builder	evaluatorModelIdentifiers(String... evaluatorModelIdentifiers)	The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
EvaluationSummary.Builder	evaluatorModelIdentifiers(Collection<String> evaluatorModelIdentifiers)	The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
default EvaluationSummary.Builder	inferenceConfigSummary(Consumer<EvaluationInferenceConfigSummary.Builder> inferenceConfigSummary)	Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
EvaluationSummary.Builder	inferenceConfigSummary(EvaluationInferenceConfigSummary inferenceConfigSummary)	Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
EvaluationSummary.Builder	jobArn(String jobArn)	The Amazon Resource Name (ARN) of the evaluation job.
EvaluationSummary.Builder	jobName(String jobName)	The name for the evaluation job.
EvaluationSummary.Builder	jobType(String jobType)	Specifies whether the evaluation job is automated or human-based.
EvaluationSummary.Builder	jobType(EvaluationJobType jobType)	Specifies whether the evaluation job is automated or human-based.
EvaluationSummary.Builder	modelIdentifiers(String... modelIdentifiers)	Deprecated. Inference identifiers should be retrieved from the inferenceConfigSummary
EvaluationSummary.Builder	modelIdentifiers(Collection<String> modelIdentifiers)	Deprecated. Inference identifiers should be retrieved from the inferenceConfigSummary
EvaluationSummary.Builder	ragIdentifiers(String... ragIdentifiers)	Deprecated. Inference identifiers should be retrieved from the inferenceConfigSummary
EvaluationSummary.Builder	ragIdentifiers(Collection<String> ragIdentifiers)	Deprecated. Inference identifiers should be retrieved from the inferenceConfigSummary
EvaluationSummary.Builder	status(String status)	The current status of the evaluation job.
EvaluationSummary.Builder	status(EvaluationJobStatus status)	The current status of the evaluation job.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

jobArn

EvaluationSummary.Builder jobArn(String jobArn)

The Amazon Resource Name (ARN) of the evaluation job.

Parameters:

jobArn - The Amazon Resource Name (ARN) of the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobName

EvaluationSummary.Builder jobName(String jobName)

The name for the evaluation job.

Parameters:

jobName - The name for the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

EvaluationSummary.Builder status(String status)

The current status of the evaluation job.

Parameters:

status - The current status of the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationJobStatus, EvaluationJobStatus

status

EvaluationSummary.Builder status(EvaluationJobStatus status)

The current status of the evaluation job.

Parameters:

status - The current status of the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationJobStatus, EvaluationJobStatus

creationTime

EvaluationSummary.Builder creationTime(Instant creationTime)

The time the evaluation job was created.

Parameters:

creationTime - The time the evaluation job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobType

EvaluationSummary.Builder jobType(String jobType)

Specifies whether the evaluation job is automated or human-based.

Parameters:

jobType - Specifies whether the evaluation job is automated or human-based.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationJobType, EvaluationJobType

jobType

EvaluationSummary.Builder jobType(EvaluationJobType jobType)

Specifies whether the evaluation job is automated or human-based.

Parameters:

jobType - Specifies whether the evaluation job is automated or human-based.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationJobType, EvaluationJobType

evaluationTaskTypesWithStrings

EvaluationSummary.Builder evaluationTaskTypesWithStrings(Collection<String> evaluationTaskTypes)

The type of task for model evaluation.

Parameters:

evaluationTaskTypes - The type of task for model evaluation.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluationTaskTypesWithStrings

EvaluationSummary.Builder evaluationTaskTypesWithStrings(String... evaluationTaskTypes)

The type of task for model evaluation.

Parameters:

evaluationTaskTypes - The type of task for model evaluation.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluationTaskTypes

EvaluationSummary.Builder evaluationTaskTypes(Collection<EvaluationTaskType> evaluationTaskTypes)

The type of task for model evaluation.

Parameters:

evaluationTaskTypes - The type of task for model evaluation.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluationTaskTypes

EvaluationSummary.Builder evaluationTaskTypes(EvaluationTaskType... evaluationTaskTypes)

The type of task for model evaluation.

Parameters:

evaluationTaskTypes - The type of task for model evaluation.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelIdentifiers

@Deprecated
EvaluationSummary.Builder modelIdentifiers(Collection<String> modelIdentifiers)

Deprecated.

Inference identifiers should be retrieved from the inferenceConfigSummary

The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

Parameters:

modelIdentifiers - The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelIdentifiers

@Deprecated
EvaluationSummary.Builder modelIdentifiers(String... modelIdentifiers)

Deprecated.

Inference identifiers should be retrieved from the inferenceConfigSummary

The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

Parameters:

modelIdentifiers - The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

ragIdentifiers

@Deprecated
EvaluationSummary.Builder ragIdentifiers(Collection<String> ragIdentifiers)

Deprecated.

Inference identifiers should be retrieved from the inferenceConfigSummary

The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

Parameters:

ragIdentifiers - The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

ragIdentifiers

@Deprecated
EvaluationSummary.Builder ragIdentifiers(String... ragIdentifiers)

Deprecated.

Inference identifiers should be retrieved from the inferenceConfigSummary

The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

Parameters:

ragIdentifiers - The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluatorModelIdentifiers

EvaluationSummary.Builder evaluatorModelIdentifiers(Collection<String> evaluatorModelIdentifiers)

The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

Parameters:

evaluatorModelIdentifiers - The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluatorModelIdentifiers

EvaluationSummary.Builder evaluatorModelIdentifiers(String... evaluatorModelIdentifiers)

The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

Parameters:

evaluatorModelIdentifiers - The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

customMetricsEvaluatorModelIdentifiers

EvaluationSummary.Builder customMetricsEvaluatorModelIdentifiers(Collection<String> customMetricsEvaluatorModelIdentifiers)

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

Parameters:

customMetricsEvaluatorModelIdentifiers - The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

customMetricsEvaluatorModelIdentifiers

EvaluationSummary.Builder customMetricsEvaluatorModelIdentifiers(String... customMetricsEvaluatorModelIdentifiers)

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

Parameters:

customMetricsEvaluatorModelIdentifiers - The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

inferenceConfigSummary

EvaluationSummary.Builder inferenceConfigSummary(EvaluationInferenceConfigSummary inferenceConfigSummary)

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

Parameters:

inferenceConfigSummary - Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

inferenceConfigSummary

default EvaluationSummary.Builder inferenceConfigSummary(Consumer<EvaluationInferenceConfigSummary.Builder> inferenceConfigSummary)

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

This is a convenience method that creates an instance of the EvaluationInferenceConfigSummary.Builder avoiding the need to create one manually via EvaluationInferenceConfigSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceConfigSummary(EvaluationInferenceConfigSummary).

Parameters:

inferenceConfigSummary - a consumer that will call methods on EvaluationInferenceConfigSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

inferenceConfigSummary(EvaluationInferenceConfigSummary)

applicationType

EvaluationSummary.Builder applicationType(String applicationType)

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Parameters:

applicationType - Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApplicationType, ApplicationType

applicationType

EvaluationSummary.Builder applicationType(ApplicationType applicationType)

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Parameters:

applicationType - Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApplicationType, ApplicationType