@gentrace/core/models/create-evaluation-v2.ts

Core Gentrace Node.JS library

/* tslint:disable */
/* eslint-disable */
/**
 * Gentrace API
 * These API routes are designed to ingest events from clients.
 *
 * The version of the OpenAPI document: 0.27.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

/**
 *
 * @export
 * @interface CreateEvaluationV2
 */
export interface CreateEvaluationV2 {
  /**
   * Optionally add a note to the evaluation
   * @type {string}
   * @memberof CreateEvaluationV2
   */
  note?: string;
  /**
   * The ID of the evaluator. The evaluator and run must be in the same pipeline.
   * @type {string}
   * @memberof CreateEvaluationV2
   */
  evaluatorId: string;
  /**
   * The ID of the run. The evaluator and run must be in the same pipeline.
   * @type {string}
   * @memberof CreateEvaluationV2
   */
  runId: string;
  /**
   * If the evaluator output type is an enum, the label of the enum value.
   * @type {string}
   * @memberof CreateEvaluationV2
   */
  evalLabel?: string;
  /**
   * If the evaluator output type is a percentage, a number between 0 and 1 representing the percentage.
   * @type {number}
   * @memberof CreateEvaluationV2
   */
  evalValue?: number;
}