AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock CreateEvaluationJob API operation.

Syntax

New-BDREvaluationJob
-ApplicationType <ApplicationType>
-EvaluationConfig_Automated_CustomMetricConfig_EvaluatorModelConfig_BedrockEvaluatorModels <CustomMetricBedrockEvaluatorModel[]>
-EvaluatorModelConfig_BedrockEvaluatorModel <BedrockEvaluatorModel[]>
-ClientRequestToken <String>
-CustomerEncryptionKeyId <String>
-CustomMetricConfig_CustomMetric <AutomatedEvaluationCustomMetricSource[]>
-Human_CustomMetric <HumanEvaluationCustomMetric[]>
-Automated_DatasetMetricConfig <EvaluationDatasetMetricConfig[]>
-Human_DatasetMetricConfig <EvaluationDatasetMetricConfig[]>
-HumanWorkflowConfig_FlowDefinitionArn <String>
-HumanWorkflowConfig_Instruction <String>
-JobDescription <String>
-JobName <String>
-JobTag <Tag[]>
-InferenceConfig_Model <EvaluationModelConfig[]>
-InferenceConfig_RagConfig <RAGConfig[]>
-RoleArn <String>
-OutputDataConfig_S3Uri <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockConfig>

Description

Creates an evaluation job.

Parameters

-ApplicationType <ApplicationType>
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Automated_DatasetMetricConfig <EvaluationDatasetMetricConfig[]>
Configuration details of the prompt datasets and metrics you want to use for your evaluation job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Automated_DatasetMetricConfigs
-ClientConfig <AmazonBedrockConfig>
Amazon.PowerShell.Cmdlets.BDR.AmazonBedrockClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerEncryptionKeyId <String>
Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomMetricConfig_CustomMetric <AutomatedEvaluationCustomMetricSource[]>
Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Automated_CustomMetricConfig_CustomMetrics
-EvaluationConfig_Automated_CustomMetricConfig_EvaluatorModelConfig_BedrockEvaluatorModels <CustomMetricBedrockEvaluatorModel[]>
Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluatorModelConfig_CustomMetricConfig_BedrockEvaluatorModel
-EvaluatorModelConfig_BedrockEvaluatorModel <BedrockEvaluatorModel[]>
The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Automated_EvaluatorModelConfig_BedrockEvaluatorModels
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Human_CustomMetric <HumanEvaluationCustomMetric[]>
A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Human_CustomMetrics
-Human_DatasetMetricConfig <EvaluationDatasetMetricConfig[]>
Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Human_DatasetMetricConfigs
-HumanWorkflowConfig_FlowDefinitionArn <String>
The Amazon Resource Number (ARN) for the flow definition
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Human_HumanWorkflowConfig_FlowDefinitionArn
-HumanWorkflowConfig_Instruction <String>
Instructions for the flow definition
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationConfig_Human_HumanWorkflowConfig_Instructions
-InferenceConfig_Model <EvaluationModelConfig[]>
Specifies the inference models. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceConfig_Models
-InferenceConfig_RagConfig <RAGConfig[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceConfig_RagConfigs
-JobDescription <String>
A description of the evaluation job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobTag <Tag[]>
Tags to attach to the model evaluation job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobTags
-OutputDataConfig_S3Uri <String>
The Amazon S3 URI where the results of the evaluation job are saved.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Bedrock.Model.CreateEvaluationJobResponse). Specifying the name of a property of type Amazon.Bedrock.Model.CreateEvaluationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Bedrock.Model.CreateEvaluationJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Bedrock.Model.CreateEvaluationJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z