Skip to content

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


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

Class: PutDatasetVersionAnnotationCommand

Creates or updates an annotation on the given dataset version.

Example

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

import { GenAiEvaluationToolkitClient, PutDatasetVersionAnnotationCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, PutDatasetVersionAnnotationCommand } = 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 = { // PutDatasetVersionAnnotationRequest
  datasetId: "STRING_VALUE", // required
  version: Number("int"), // required
  name: "STRING_VALUE", // required
  value: { // AnnotationValue Union: only one key present
    stringValue: "STRING_VALUE",
    numericValue: Number("double"),
  },
  comment: "STRING_VALUE",
};
const command = new PutDatasetVersionAnnotationCommand(input);
const response = await client.send(command);
// { // 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

PutDatasetVersionAnnotationCommandInput

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

UnprocessableEntityException (client fault) Unprocessable entity exception is thrown when request violates business logic

Throws

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

Constructors

Constructor

new PutDatasetVersionAnnotationCommand(input): PutDatasetVersionAnnotationCommand

Parameters

input

PutDatasetVersionAnnotationCommandInput

Returns

PutDatasetVersionAnnotationCommand

Inherited from

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

Constructor

new PutDatasetVersionAnnotationCommand(...__namedParameters): PutDatasetVersionAnnotationCommand

Parameters

__namedParameters

...[PutDatasetVersionAnnotationCommandInput]

Returns

PutDatasetVersionAnnotationCommand

Inherited from

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