HoneyHive TypeScript API SDK
    Preparing search index...

    Type Alias RunMetricRequest

    type RunMetricRequest = {
        event: {
            event_name?: string;
            event_type?: string;
            feedback?: { ground_truth?: unknown } & { [key: string]: unknown };
            inputs?: { [key: string]: unknown };
            outputs?: { [key: string]: unknown };
            workspace_id?: string;
        } & { [key: string]: unknown };
        metric: {
            categories?: { category: string; score: number | null }[] | null;
            child_metrics?:
                | { id?: string; name: string; scale?: number
                | null; weight: number }[]
                | null;
            criteria: string;
            description?: string;
            enabled_in_prod?: boolean;
            filters?: {
                filterArray: {
                    field: string;
                    operator:
                        | "exists"
                        | "not exists"
                        | "is"
                        | "is not"
                        | "contains"
                        | "not contains"
                        | "greater than"
                        | "less than"
                        | "after"
                        | "before";
                    type: "string"
                    | "number"
                    | "boolean"
                    | "datetime";
                    value: string | number | boolean | null;
                }[];
            };
            model_name?: string
            | null;
            model_provider?: string | null;
            name: string;
            needs_ground_truth?: boolean;
            return_type?: "float" | "boolean" | "string" | "categorical";
            sampling_percentage?: number;
            scale?: number | null;
            threshold?:
                | {
                    max?: number;
                    min?: number;
                    pass_when?: boolean
                    | number;
                    passing_categories?: string[];
                }
                | null;
            type: "LLM"
            | "PYTHON";
        };
    }
    Index

    Properties

    event metric

    Properties

    event: {
        event_name?: string;
        event_type?: string;
        feedback?: { ground_truth?: unknown } & { [key: string]: unknown };
        inputs?: { [key: string]: unknown };
        outputs?: { [key: string]: unknown };
        workspace_id?: string;
    } & { [key: string]: unknown }
    metric: {
        categories?: { category: string; score: number | null }[] | null;
        child_metrics?:
            | { id?: string; name: string; scale?: number
            | null; weight: number }[]
            | null;
        criteria: string;
        description?: string;
        enabled_in_prod?: boolean;
        filters?: {
            filterArray: {
                field: string;
                operator:
                    | "exists"
                    | "not exists"
                    | "is"
                    | "is not"
                    | "contains"
                    | "not contains"
                    | "greater than"
                    | "less than"
                    | "after"
                    | "before";
                type: "string"
                | "number"
                | "boolean"
                | "datetime";
                value: string | number | boolean | null;
            }[];
        };
        model_name?: string
        | null;
        model_provider?: string | null;
        name: string;
        needs_ground_truth?: boolean;
        return_type?: "float" | "boolean" | "string" | "categorical";
        sampling_percentage?: number;
        scale?: number | null;
        threshold?:
            | {
                max?: number;
                min?: number;
                pass_when?: boolean
                | number;
                passing_categories?: string[];
            }
            | null;
        type: "LLM"
        | "PYTHON";
    }

    Type Declaration

    • Optionalcategories?: { category: string; score: number | null }[] | null
    • Optionalchild_metrics?: { id?: string; name: string; scale?: number | null; weight: number }[] | null
    • criteria: string
    • Optionaldescription?: string
    • Optionalenabled_in_prod?: boolean
      false
    • Optionalfilters?: {
          filterArray: {
              field: string;
              operator:
                  | "exists"
                  | "not exists"
                  | "is"
                  | "is not"
                  | "contains"
                  | "not contains"
                  | "greater than"
                  | "less than"
                  | "after"
                  | "before";
              type: "string"
              | "number"
              | "boolean"
              | "datetime";
              value: string | number | boolean | null;
          }[];
      }
      {
           *       "filterArray": []
           *     }
    • Optionalmodel_name?: string | null
    • Optionalmodel_provider?: string | null
    • name: string
    • Optionalneeds_ground_truth?: boolean
      false
    • Optionalreturn_type?: "float" | "boolean" | "string" | "categorical"
      float
      @enum {string}
    • Optionalsampling_percentage?: number
      100
    • Optionalscale?: number | null
    • Optionalthreshold?:
          | {
              max?: number;
              min?: number;
              pass_when?: boolean
              | number;
              passing_categories?: string[];
          }
          | null
    • type: "LLM" | "PYTHON"

    Settings

    Member Visibility

    On This Page

    Properties