Skip to content

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


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

Class: ListTestCasesCommand

Lists test cases within the requested dataset version.

Example

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

import { GenAiEvaluationToolkitClient, ListTestCasesCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListTestCasesCommand } = 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 = { // ListTestCasesRequest
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  datasetId: "STRING_VALUE", // required
  version: "STRING_VALUE", // required
  filter: { // AnnotationConditionExpression Union: only one key present
    condition: { // AnnotationCondition Union: only one key present
      numericCondition: { // NumericAnnotationCondition
        name: "STRING_VALUE", // required
        value: Number("float"), // required
        comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
      },
      stringEnumCondition: { // StringEnumAnnotationCondition
        name: "STRING_VALUE", // required
        value: "STRING_VALUE", // required
        comparator: "=" || "!=", // required
      },
    },
    and: [ // AnnotationConditionExpressionList
      {//  Union: only one key present
        condition: {//  Union: only one key present
          numericCondition: {
            name: "STRING_VALUE", // required
            value: Number("float"), // required
            comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
          },
          stringEnumCondition: {
            name: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
            comparator: "=" || "!=", // required
          },
        },
        and: [
          "<AnnotationConditionExpression>",
        ],
        or: [
          "<AnnotationConditionExpression>",
        ],
        not: "<AnnotationConditionExpression>",
      },
    ],
    or: [
      "<AnnotationConditionExpression>",
    ],
    not: "<AnnotationConditionExpression>",
  },
};
const command = new ListTestCasesCommand(input);
const response = await client.send(command);
// { // ListTestCasesResponse
//   nextToken: "STRING_VALUE",
//   testCases: [ // TestCaseReferences // required
//     { // TestCaseReference
//       id: "STRING_VALUE", // required
//       url: "STRING_VALUE",
//     },
//   ],
// };

Param

ListTestCasesCommandInput

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

Parameters

input

ListTestCasesCommandInput

Returns

ListTestCasesCommand

Inherited from

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

Constructor

new ListTestCasesCommand(...__namedParameters): ListTestCasesCommand

Parameters

__namedParameters

...[ListTestCasesCommandInput]

Returns

ListTestCasesCommand

Inherited from

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