GetEvaluationJobCommand

Suggest an Edit

Gets information about an evaluation job, such as the status of the job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BedrockClient, GetEvaluationJobCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
// const { BedrockClient, GetEvaluationJobCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
const client = new BedrockClient(config);
const input = { // GetEvaluationJobRequest
  jobIdentifier: "STRING_VALUE", // required
};
const command = new GetEvaluationJobCommand(input);
const response = await client.send(command);
// { // GetEvaluationJobResponse
//   jobName: "STRING_VALUE", // required
//   status: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped" || "Deleting", // required
//   jobArn: "STRING_VALUE", // required
//   jobDescription: "STRING_VALUE",
//   roleArn: "STRING_VALUE", // required
//   customerEncryptionKeyId: "STRING_VALUE",
//   jobType: "Human" || "Automated", // required
//   applicationType: "ModelEvaluation" || "RagEvaluation",
//   evaluationConfig: { // EvaluationConfig Union: only one key present
//     automated: { // AutomatedEvaluationConfig
//       datasetMetricConfigs: [ // EvaluationDatasetMetricConfigs // required
//         { // EvaluationDatasetMetricConfig
//           taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
//           dataset: { // EvaluationDataset
//             name: "STRING_VALUE", // required
//             datasetLocation: { // EvaluationDatasetLocation Union: only one key present
//               s3Uri: "STRING_VALUE",
//             },
//           },
//           metricNames: [ // EvaluationMetricNames // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       evaluatorModelConfig: { // EvaluatorModelConfig Union: only one key present
//         bedrockEvaluatorModels: [ // BedrockEvaluatorModels
//           { // BedrockEvaluatorModel
//             modelIdentifier: "STRING_VALUE", // required
//           },
//         ],
//       },
//     },
//     human: { // HumanEvaluationConfig
//       humanWorkflowConfig: { // HumanWorkflowConfig
//         flowDefinitionArn: "STRING_VALUE", // required
//         instructions: "STRING_VALUE",
//       },
//       customMetrics: [ // HumanEvaluationCustomMetrics
//         { // HumanEvaluationCustomMetric
//           name: "STRING_VALUE", // required
//           description: "STRING_VALUE",
//           ratingMethod: "STRING_VALUE", // required
//         },
//       ],
//       datasetMetricConfigs: [ // required
//         {
//           taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
//           dataset: {
//             name: "STRING_VALUE", // required
//             datasetLocation: {//  Union: only one key present
//               s3Uri: "STRING_VALUE",
//             },
//           },
//           metricNames: [ // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//     },
//   },
//   inferenceConfig: { // EvaluationInferenceConfig Union: only one key present
//     models: [ // EvaluationModelConfigs
//       { // EvaluationModelConfig Union: only one key present
//         bedrockModel: { // EvaluationBedrockModel
//           modelIdentifier: "STRING_VALUE", // required
//           inferenceParams: "STRING_VALUE",
//           performanceConfig: { // PerformanceConfiguration
//             latency: "standard" || "optimized",
//           },
//         },
//         precomputedInferenceSource: { // EvaluationPrecomputedInferenceSource
//           inferenceSourceIdentifier: "STRING_VALUE", // required
//         },
//       },
//     ],
//     ragConfigs: [ // RagConfigs
//       { // RAGConfig Union: only one key present
//         knowledgeBaseConfig: { // KnowledgeBaseConfig Union: only one key present
//           retrieveConfig: { // RetrieveConfig
//             knowledgeBaseId: "STRING_VALUE", // required
//             knowledgeBaseRetrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
//               vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
//                 numberOfResults: Number("int"),
//                 overrideSearchType: "HYBRID" || "SEMANTIC",
//                 filter: { // RetrievalFilter Union: only one key present
//                   equals: { // FilterAttribute
//                     key: "STRING_VALUE", // required
//                     value: "DOCUMENT_VALUE", // required
//                   },
//                   notEquals: {
//                     key: "STRING_VALUE", // required
//                     value: "DOCUMENT_VALUE", // required
//                   },
//                   greaterThan: {
//                     key: "STRING_VALUE", // required
//                     value: "DOCUMENT_VALUE", // required
//                   },
//                   greaterThanOrEquals: {
//                     key: "STRING_VALUE", // required
//                     value: "DOCUMENT_VALUE", // required
//                   },
//                   lessThan: {
//                     key: "STRING_VALUE", // required
//                     value: "DOCUMENT_VALUE", // required
//                   },
//                   lessThanOrEquals: "<FilterAttribute>",
//                   in: "<FilterAttribute>",
//                   notIn: "<FilterAttribute>",
//                   startsWith: "<FilterAttribute>",
//                   listContains: "<FilterAttribute>",
//                   stringContains: "<FilterAttribute>",
//                   andAll: [ // RetrievalFilterList
//                     {//  Union: only one key present
//                       equals: "<FilterAttribute>",
//                       notEquals: "<FilterAttribute>",
//                       greaterThan: "<FilterAttribute>",
//                       greaterThanOrEquals: "<FilterAttribute>",
//                       lessThan: "<FilterAttribute>",
//                       lessThanOrEquals: "<FilterAttribute>",
//                       in: "<FilterAttribute>",
//                       notIn: "<FilterAttribute>",
//                       startsWith: "<FilterAttribute>",
//                       listContains: "<FilterAttribute>",
//                       stringContains: "<FilterAttribute>",
//                       andAll: [
//                         "<RetrievalFilter>",
//                       ],
//                       orAll: [
//                         "<RetrievalFilter>",
//                       ],
//                     },
//                   ],
//                   orAll: [
//                     "<RetrievalFilter>",
//                   ],
//                 },
//               },
//             },
//           },
//           retrieveAndGenerateConfig: { // RetrieveAndGenerateConfiguration
//             type: "KNOWLEDGE_BASE" || "EXTERNAL_SOURCES", // required
//             knowledgeBaseConfiguration: { // KnowledgeBaseRetrieveAndGenerateConfiguration
//               knowledgeBaseId: "STRING_VALUE", // required
//               modelArn: "STRING_VALUE", // required
//               retrievalConfiguration: {
//                 vectorSearchConfiguration: {
//                   numberOfResults: Number("int"),
//                   overrideSearchType: "HYBRID" || "SEMANTIC",
//                   filter: "<RetrievalFilter>",
//                 },
//               },
//               generationConfiguration: { // GenerationConfiguration
//                 promptTemplate: { // PromptTemplate
//                   textPromptTemplate: "STRING_VALUE",
//                 },
//                 guardrailConfiguration: { // GuardrailConfiguration
//                   guardrailId: "STRING_VALUE", // required
//                   guardrailVersion: "STRING_VALUE", // required
//                 },
//                 kbInferenceConfig: { // KbInferenceConfig
//                   textInferenceConfig: { // TextInferenceConfig
//                     temperature: Number("float"),
//                     topP: Number("float"),
//                     maxTokens: Number("int"),
//                     stopSequences: [ // RAGStopSequences
//                       "STRING_VALUE",
//                     ],
//                   },
//                 },
//                 additionalModelRequestFields: { // AdditionalModelRequestFields
//                   "<keys>": "DOCUMENT_VALUE",
//                 },
//               },
//               orchestrationConfiguration: { // OrchestrationConfiguration
//                 queryTransformationConfiguration: { // QueryTransformationConfiguration
//                   type: "QUERY_DECOMPOSITION", // required
//                 },
//               },
//             },
//             externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
//               modelArn: "STRING_VALUE", // required
//               sources: [ // ExternalSources // required
//                 { // ExternalSource
//                   sourceType: "S3" || "BYTE_CONTENT", // required
//                   s3Location: { // S3ObjectDoc
//                     uri: "STRING_VALUE", // required
//                   },
//                   byteContent: { // ByteContentDoc
//                     identifier: "STRING_VALUE", // required
//                     contentType: "STRING_VALUE", // required
//                     data: new Uint8Array(), // required
//                   },
//                 },
//               ],
//               generationConfiguration: { // ExternalSourcesGenerationConfiguration
//                 promptTemplate: {
//                   textPromptTemplate: "STRING_VALUE",
//                 },
//                 guardrailConfiguration: {
//                   guardrailId: "STRING_VALUE", // required
//                   guardrailVersion: "STRING_VALUE", // required
//                 },
//                 kbInferenceConfig: {
//                   textInferenceConfig: {
//                     temperature: Number("float"),
//                     topP: Number("float"),
//                     maxTokens: Number("int"),
//                     stopSequences: [
//                       "STRING_VALUE",
//                     ],
//                   },
//                 },
//                 additionalModelRequestFields: {
//                   "<keys>": "DOCUMENT_VALUE",
//                 },
//               },
//             },
//           },
//         },
//         precomputedRagSourceConfig: { // EvaluationPrecomputedRagSourceConfig Union: only one key present
//           retrieveSourceConfig: { // EvaluationPrecomputedRetrieveSourceConfig
//             ragSourceIdentifier: "STRING_VALUE", // required
//           },
//           retrieveAndGenerateSourceConfig: { // EvaluationPrecomputedRetrieveAndGenerateSourceConfig
//             ragSourceIdentifier: "STRING_VALUE", // required
//           },
//         },
//       },
//     ],
//   },
//   outputDataConfig: { // EvaluationOutputDataConfig
//     s3Uri: "STRING_VALUE", // required
//   },
//   creationTime: new Date("TIMESTAMP"), // required
//   lastModifiedTime: new Date("TIMESTAMP"),
//   failureMessages: [ // ErrorMessages
//     "STRING_VALUE",
//   ],
// };

GetEvaluationJobCommand Input

See GetEvaluationJobCommandInput for more details

Parameter
Type
Description
jobIdentifier
Required
string | undefined

The Amazon Resource Name (ARN) of the evaluation job you want get information on.

GetEvaluationJobCommand Output

See GetEvaluationJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationTime
Required
Date | undefined

The time the evaluation job was created.

evaluationConfig
Required
EvaluationConfig | undefined

Contains the configuration details of either an automated or human-based evaluation job.

inferenceConfig
Required
EvaluationInferenceConfig | undefined

Contains the configuration details of the inference model used for the evaluation job.

jobArn
Required
string | undefined

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

jobName
Required
string | undefined

The name for the evaluation job.

jobType
Required
EvaluationJobType | undefined

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

outputDataConfig
Required
EvaluationOutputDataConfig | undefined

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

roleArn
Required
string | undefined

The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

status
Required
EvaluationJobStatus | undefined

The current status of the evaluation job.

applicationType
ApplicationType | undefined

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

customerEncryptionKeyId
string | undefined

The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

failureMessages
string[] | undefined

A list of strings that specify why the evaluation job failed to create.

jobDescription
string | undefined

The description of the evaluation job.

lastModifiedTime
Date | undefined

The time the evaluation job was last modified.

Throws

Name
Fault
Details
AccessDeniedException
client

The request is denied because of missing access permissions.

InternalServerException
server

An internal server error occurred. Retry your request.

ResourceNotFoundException
client

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

ThrottlingException
client

The number of requests exceeds the limit. Resubmit your request later.

ValidationException
client

Input validation failed. Check your request parameters and retry the request.

BedrockServiceException
Base exception class for all service exceptions from Bedrock service.