Skip to content

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


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

Class: BatchCreateResultsCommand

Create multiple test 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, BatchCreateResultsCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, BatchCreateResultsCommand } = 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 = { // BatchCreateResultsInput
  reportId: "STRING_VALUE", // required
  results: [ // BatchResultInputList // required
    { // BatchResultInput
      input: "DOCUMENT_VALUE",
      expected: "DOCUMENT_VALUE",
      context: "DOCUMENT_VALUE",
      metadata: "DOCUMENT_VALUE",
      output: "DOCUMENT_VALUE",
      appMetrics: "DOCUMENT_VALUE",
      error: "STRING_VALUE",
      resultId: "STRING_VALUE",
      testcaseId: "STRING_VALUE",
    },
  ],
};
const command = new BatchCreateResultsCommand(input);
const response = await client.send(command);
// { // BatchCreateResultsOutput
//   results: [ // BatchResultOutputList // required
//     { // BatchResultOutput
//       resultId: "STRING_VALUE", // required
//       testcaseId: "STRING_VALUE",
//       index: Number("int"), // required
//     },
//   ],
//   errors: [ // BatchItemErrorList // required
//     { // BatchItemError
//       id: "STRING_VALUE", // required
//       code: "STRING_VALUE", // required
//       message: "STRING_VALUE", // required
//       index: Number("int"),
//     },
//   ],
//   count: Number("int"), // required
// };

Param

BatchCreateResultsCommandInput

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

Parameters

input

BatchCreateResultsCommandInput

Returns

BatchCreateResultsCommand

Inherited from

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

Constructor

new BatchCreateResultsCommand(...__namedParameters): BatchCreateResultsCommand

Parameters

__namedParameters

...[BatchCreateResultsCommandInput]

Returns

BatchCreateResultsCommand

Inherited from

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