Skip to content

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


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

Class: BatchUpdateScoresCommand

Add scores to multiple results in a batch. Returns 200 with separate success and error lists even if some items fail.

Example

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

import { GenAiEvaluationToolkitClient, BatchUpdateScoresCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, BatchUpdateScoresCommand } = 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 = { // BatchUpdateScoresInput
  reportId: "STRING_VALUE", // required
  items: [ // BatchScoreItemList // required
    { // BatchScoreItem
      resultId: "STRING_VALUE", // required
      scores: { // ScoreInputMap // required
        "<keys>": { // ScoreInput
          value: Number("float"),
          reason: "STRING_VALUE",
          error: "STRING_VALUE",
          context: "DOCUMENT_VALUE",
        },
      },
    },
  ],
};
const command = new BatchUpdateScoresCommand(input);
const response = await client.send(command);
// { // BatchUpdateScoresOutput
//   updatedCount: Number("int"), // required
//   errors: [ // BatchItemErrorList // required
//     { // BatchItemError
//       id: "STRING_VALUE", // required
//       code: "STRING_VALUE", // required
//       message: "STRING_VALUE", // required
//       index: Number("int"),
//     },
//   ],
// };

Param

BatchUpdateScoresCommandInput

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 BatchUpdateScoresCommand(input): BatchUpdateScoresCommand

Parameters

input

BatchUpdateScoresCommandInput

Returns

BatchUpdateScoresCommand

Inherited from

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

Constructor

new BatchUpdateScoresCommand(...__namedParameters): BatchUpdateScoresCommand

Parameters

__namedParameters

...[BatchUpdateScoresCommandInput]

Returns

BatchUpdateScoresCommand

Inherited from

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