Class EvaluationsApiClient

Index

Constructors

Methods

evaluate getEvaluatorSpec

Constructors

constructor

new EvaluationsApiClient(
    auth: EvaluationsApiAuth,
    options?: {
        fetchFn?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
        timeoutMs?: number;
    },
): EvaluationsApiClient
Parameters
- auth: EvaluationsApiAuth
- Optionaloptions: {
      fetchFn?: (
          input: string | URL | Request,
          init?: RequestInit,
      ) => Promise<Response>;
      timeoutMs?: number;
  }
Returns EvaluationsApiClient
- Defined in work/scenario/scenario/javascript/src/evaluators/evaluations-api.ts:95

Methods

evaluate

evaluate(
    __namedParameters: {
        data: Record<string, unknown>;
        evaluatorRef: string;
        settings?: Record<string, unknown>;
        traceId?: string;
    },
): Promise<EvaluateApiResponse>
Runs one evaluator over the resolved inputs. Throws on a transport or HTTP failure; an evaluator failure comes back as status: "error".
Parameters
- __namedParameters: {
      data: Record<string, unknown>;
      evaluatorRef: string;
      settings?: Record<string, unknown>;
      traceId?: string;
  }
Returns Promise<EvaluateApiResponse>
- Defined in work/scenario/scenario/javascript/src/evaluators/evaluations-api.ts:203

getEvaluatorSpec

getEvaluatorSpec(evaluatorRef: string): Promise<EvaluatorSpec | undefined>
Which inputs an evaluator takes and what to call it. A built-in type is read from the catalogue; a saved evaluator from the fields its record declares, then from the catalogue entry of its type. Undefined when the evaluator is unknown.
Parameters
- evaluatorRef: string
Returns Promise<EvaluatorSpec | undefined>
- Defined in work/scenario/scenario/javascript/src/evaluators/evaluations-api.ts:169