Arize Phoenix TS
    Preparing search index...

    Function toExperimentEvaluationRequestBody

    • Build the body for POST /v1/experiment_evaluations.

      The endpoint reads metadata from the top level of the body and ignores any other key under result. client.POST infers its body type, so TypeScript does not flag unknown keys there; copying each field explicitly into a value of the declared request type here restores that check. Do not spread evaluator output into the body.

      Parameters

      • __namedParameters: {
            annotatorKind: "LLM" | "CODE" | "HUMAN";
            endTime: Date;
            error: string | null;
            experimentRunId: string;
            name: string;
            result: EvaluationResult | null;
            startTime: Date;
            traceId: string | null;
        }

      Returns {
          annotator_kind: "LLM" | "CODE" | "HUMAN";
          end_time: string;
          error?: string | null;
          experiment_run_id: string;
          metadata?: { [key: string]: unknown } | null;
          name: string;
          result?:
              | {
                  explanation?: string
                  | null;
                  label?: string | null;
                  score?: number | null;
              }
              | null;
          start_time: string;
          trace_id?: string
          | null;
      }

      • annotator_kind: "LLM" | "CODE" | "HUMAN"

        Annotator Kind

        The kind of annotator used for the evaluation

      • end_time: string

        End Time Format: date-time

        The end time of the evaluation in ISO format

      • Optionalerror?: string | null

        Error

        Error message if the evaluation encountered an error. Either result or error must be provided.

      • experiment_run_id: string

        Experiment Run Id

        The ID of the experiment run being evaluated

      • Optionalmetadata?: { [key: string]: unknown } | null

        Metadata

        Metadata for the evaluation

      • name: string

        Name

        The name of the evaluation

      • Optionalresult?:
            | {
                explanation?: string
                | null;
                label?: string | null;
                score?: number | null;
            }
            | null

        The result of the evaluation. Either result or error must be provided.

      • start_time: string

        Start Time Format: date-time

        The start time of the evaluation in ISO format

      • Optionaltrace_id?: string | null

        Trace Id

        Optional trace ID for tracking

    Settings
    Member Visibility