Skip to content

@awssolutions/gen-ai-evaluation-toolkit-ts-client


@awssolutions/gen-ai-evaluation-toolkit-ts-client / GetEvaluatorJobCommand

Class: GetEvaluatorJobCommand

Get details of an evaluation job (v2)

Example

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

import { GenAiEvaluationToolkitClient, GetEvaluatorJobCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, GetEvaluatorJobCommand } = require("@awssolutions/gen-ai-evaluation-toolkit-ts-client"); // CommonJS import
// import type { GenAiEvaluationToolkitClientConfig } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client";
const config = {}; // type is GenAiEvaluationToolkitClientConfig
const client = new GenAiEvaluationToolkitClient(config);
const input = { // GetEvaluatorJobInput
  jobId: "STRING_VALUE", // required
};
const command = new GetEvaluatorJobCommand(input);
const response = await client.send(command);
// { // GetEvaluatorJobOutput
//   jobId: "STRING_VALUE", // required
//   evaluatorName: "STRING_VALUE", // required
//   jobType: "FULL" || "SCORE" || "APP_INVOKE", // required
//   status: "PENDING" || "RUNNING" || "SUCCESS" || "PARTIAL_FAILURE" || "FAILURE", // required
//   reportId: "STRING_VALUE", // required
//   sourceReportId: "STRING_VALUE",
//   scorers: { // ScorerMap
//     "<keys>": { // ScorerConfig
//       params: "DOCUMENT_VALUE",
//       scores: { // SubScoreMap
//         "<keys>": "DOCUMENT_VALUE",
//       },
//       evaluatorName: "STRING_VALUE",
//     },
//   },
//   app: { // AppConfig
//     name: "STRING_VALUE",
//     params: "DOCUMENT_VALUE",
//     evaluatorName: "STRING_VALUE",
//   },
//   tasks: { // TaskMap // required
//     "<keys>": { // TaskState
//       status: "PENDING" || "RUNNING" || "COMPLETED" || "FAILED", // required
//       evaluatorName: "STRING_VALUE",
//       error: "STRING_VALUE",
//       checkpoint: "DOCUMENT_VALUE",
//       scorers: {
//         "<keys>": {
//           params: "DOCUMENT_VALUE",
//           scores: {
//             "<keys>": "DOCUMENT_VALUE",
//           },
//           evaluatorName: "STRING_VALUE",
//         },
//       },
//     },
//   },
//   stage: "PENDING" || "INVOKING" || "SCORING" || "COMPLETE", // required
//   result: "DOCUMENT_VALUE",
//   error: { // JobError
//     code: "STRING_VALUE", // required
//     message: "STRING_VALUE", // required
//     stackTrace: "STRING_VALUE",
//   },
//   experimentName: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
// };

Param

GetEvaluatorJobCommandInput

See

Throws

ValidationException (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

UnauthorizedException (client fault) UnauthorizedException is thrown when request is missing or has bad auth

Throws

ThrottlingException (client fault) ThrottlingException is thrown when request was denied due to request throttling

Throws

InternalServerException (server fault) InternalServerException is thrown when unexpected error occurs during processing of request

Throws

ResourceNotFoundException (client fault) ResourceNotFoundException is thrown when request references a resource which does not exist

Throws

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

Constructors

Constructor

new GetEvaluatorJobCommand(input): GetEvaluatorJobCommand

Parameters

input

GetEvaluatorJobCommandInput

Returns

GetEvaluatorJobCommand

Inherited from

$Command .classBuilder< GetEvaluatorJobCommandInput, GetEvaluatorJobCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep(commonParams) .m(function (this: any, Command: any, cs: any, config: GenAiEvaluationToolkitClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("GenAiEtk", "GetEvaluatorJob", {}) .n("GenAiEvaluationToolkitClient", "GetEvaluatorJobCommand") .sc(GetEvaluatorJob$) .build().constructor

Constructor

new GetEvaluatorJobCommand(...__namedParameters): GetEvaluatorJobCommand

Parameters

__namedParameters

...[GetEvaluatorJobCommandInput]

Returns

GetEvaluatorJobCommand

Inherited from

$Command .classBuilder< GetEvaluatorJobCommandInput, GetEvaluatorJobCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep(commonParams) .m(function (this: any, Command: any, cs: any, config: GenAiEvaluationToolkitClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("GenAiEtk", "GetEvaluatorJob", {}) .n("GenAiEvaluationToolkitClient", "GetEvaluatorJobCommand") .sc(GetEvaluatorJob$) .build().constructor