Skip to content

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


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

Class: ListDatasetVersionsCommand

Lists available dataset versions for the requested dataset.

Example

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

import { GenAiEvaluationToolkitClient, ListDatasetVersionsCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListDatasetVersionsCommand } = 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 = { // ListDatasetVersionsRequest
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  datasetId: "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 ListDatasetVersionsCommand(input);
const response = await client.send(command);
// { // ListDatasetVersionsResponse
//   nextToken: "STRING_VALUE",
//   versions: [ // Versions // required
//     { // DatasetVersion
//       datasetId: "STRING_VALUE", // required
//       version: Number("int"), // required
//       createdAt: new Date("TIMESTAMP"), // required
//       createdBy: "STRING_VALUE", // required
//       s3Location: "STRING_VALUE",
//       annotations: [ // Annotations
//         { // Annotation
//           name: "STRING_VALUE", // required
//           value: { // AnnotationValue Union: only one key present
//             stringValue: "STRING_VALUE",
//             numericValue: Number("double"),
//           },
//           comment: "STRING_VALUE",
//           annotatedBy: "STRING_VALUE", // required
//           annotatedAt: new Date("TIMESTAMP"), // required
//         },
//       ],
//     },
//   ],
// };

Param

ListDatasetVersionsCommandInput

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

Parameters

input

ListDatasetVersionsCommandInput

Returns

ListDatasetVersionsCommand

Inherited from

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

Constructor

new ListDatasetVersionsCommand(...__namedParameters): ListDatasetVersionsCommand

Parameters

__namedParameters

...[ListDatasetVersionsCommandInput]

Returns

ListDatasetVersionsCommand

Inherited from

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