Skip to content

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


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

Class: UpdateJobSchedulerCommand

Updates evaluation job scheduler (changes take immediate effect)

Example

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

import { GenAiEvaluationToolkitClient, UpdateJobSchedulerCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, UpdateJobSchedulerCommand } = 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 = { // UpdateJobSchedulerInput
  name: "STRING_VALUE", // required
  cron: "STRING_VALUE",
  jobType: "FULL" || "SCORE" || "APP_INVOKE",
  evaluatorName: "STRING_VALUE",
  testCases: { // TestDataSource Union: only one key present
    dataset: { // DatasetReference
      datasetId: "STRING_VALUE", // required
      datasetVersion: "STRING_VALUE",
      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>",
      },
    },
    inline: [ // InlineTestCaseList
      { // InlineTestCase
        input: "DOCUMENT_VALUE",
        expected: "DOCUMENT_VALUE",
        context: "DOCUMENT_VALUE",
        metadata: "DOCUMENT_VALUE",
      },
    ],
  },
  scorers: { // ScorerMap
    "<keys>": { // ScorerConfig
      params: "DOCUMENT_VALUE",
      scores: { // SubScoreMap
        "<keys>": "DOCUMENT_VALUE",
      },
      evaluatorName: "STRING_VALUE",
    },
  },
  app: { // AppConfig
    name: "STRING_VALUE",
    params: "DOCUMENT_VALUE",
    evaluatorName: "STRING_VALUE",
  },
  sourceReportId: "STRING_VALUE",
  testResults: [ // InlineTestResultList
    { // InlineTestResult
      input: "DOCUMENT_VALUE",
      expected: "DOCUMENT_VALUE",
      context: "DOCUMENT_VALUE",
      metadata: "DOCUMENT_VALUE",
      output: "DOCUMENT_VALUE",
    },
  ],
  experimentName: "STRING_VALUE",
};
const command = new UpdateJobSchedulerCommand(input);
const response = await client.send(command);
// { // UpdateJobSchedulerOutput
//   name: "STRING_VALUE", // required
//   cron: "STRING_VALUE", // required
//   jobType: "FULL" || "SCORE" || "APP_INVOKE", // required
//   evaluatorName: "STRING_VALUE", // required
//   testCases: { // TestDataSource Union: only one key present
//     dataset: { // DatasetReference
//       datasetId: "STRING_VALUE", // required
//       datasetVersion: "STRING_VALUE",
//       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>",
//       },
//     },
//     inline: [ // InlineTestCaseList
//       { // InlineTestCase
//         input: "DOCUMENT_VALUE",
//         expected: "DOCUMENT_VALUE",
//         context: "DOCUMENT_VALUE",
//         metadata: "DOCUMENT_VALUE",
//       },
//     ],
//   },
//   scorers: { // ScorerMap
//     "<keys>": { // ScorerConfig
//       params: "DOCUMENT_VALUE",
//       scores: { // SubScoreMap
//         "<keys>": "DOCUMENT_VALUE",
//       },
//       evaluatorName: "STRING_VALUE",
//     },
//   },
//   app: { // AppConfig
//     name: "STRING_VALUE",
//     params: "DOCUMENT_VALUE",
//     evaluatorName: "STRING_VALUE",
//   },
//   sourceReportId: "STRING_VALUE",
//   testResults: [ // InlineTestResultList
//     { // InlineTestResult
//       input: "DOCUMENT_VALUE",
//       expected: "DOCUMENT_VALUE",
//       context: "DOCUMENT_VALUE",
//       metadata: "DOCUMENT_VALUE",
//       output: "DOCUMENT_VALUE",
//     },
//   ],
//   experimentName: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"), // required
// };

Param

UpdateJobSchedulerCommandInput

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

Parameters

input

UpdateJobSchedulerCommandInput

Returns

UpdateJobSchedulerCommand

Inherited from

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

Constructor

new UpdateJobSchedulerCommand(...__namedParameters): UpdateJobSchedulerCommand

Parameters

__namedParameters

...[UpdateJobSchedulerCommandInput]

Returns

UpdateJobSchedulerCommand

Inherited from

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