EvaluationSummary
Summary information of an evaluation job.
Contents
- creationTime
-
The time the evaluation job was created.
Type: Timestamp
Required: Yes
- evaluationTaskTypes
-
The type of task for model evaluation.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[A-Za-z0-9]+$Valid Values:
Summarization | Classification | QuestionAndAnswer | Generation | CustomRequired: Yes
- jobArn
-
The Amazon Resource Name (ARN) of the evaluation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$Required: Yes
- jobName
-
The name for the evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-z0-9](-*[a-z0-9]){0,62}$Required: Yes
- jobType
-
Specifies whether the evaluation job is automated or human-based.
Type: String
Valid Values:
Human | AutomatedRequired: Yes
- status
-
The current status of the evaluation job.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | Stopped | DeletingRequired: Yes
- applicationType
-
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Type: String
Valid Values:
ModelEvaluation | RagEvaluationRequired: No
- evaluatorModelIdentifiers
-
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$Required: No
- modelIdentifiers
-
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+)))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}$Required: No
- ragIdentifiers
-
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
