Skip to content

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


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

Class: GetGenerationCommand

Gets generation job details

Example

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

import { GenAiEvaluationToolkitClient, GetGenerationCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, GetGenerationCommand } = 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 = { // GetGenerationInput
  id: "STRING_VALUE", // required
};
const command = new GetGenerationCommand(input);
const response = await client.send(command);
// { // GetGenerationOutput
//   experimentName: "STRING_VALUE",
//   configVersion: Number("int"),
//   steps: [ // GenerationStepList // required
//     { // GenerationStep
//       plugin: "STRING_VALUE", // required
//       configuration: "DOCUMENT_VALUE", // required
//     },
//   ],
//   cause: "STRING_VALUE",
//   error: "STRING_VALUE",
//   id: "STRING_VALUE", // required
//   status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE", // required
//   createdAt: new Date("TIMESTAMP"), // required
//   stoppedAt: new Date("TIMESTAMP"),
//   output: "DOCUMENT_VALUE",
// };

Param

GetGenerationCommandInput

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

ResourceNotFoundException (client fault) ResourceNotFoundException is thrown when request references a resource which does not exist

Throws

ThrottlingException (client fault) ThrottlingException is thrown when request was denied due to request throttling

Throws

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

Constructors

Constructor

new GetGenerationCommand(input): GetGenerationCommand

Parameters

input

GetGenerationCommandInput

Returns

GetGenerationCommand

Inherited from

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

Constructor

new GetGenerationCommand(...__namedParameters): GetGenerationCommand

Parameters

__namedParameters

...[GetGenerationCommandInput]

Returns

GetGenerationCommand

Inherited from

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