dify/web/types/evaluation.ts

export type EvaluationTargetType = 'app' | 'snippets'

export type EvaluationConfig = {
  evaluation_model: string | null
  evaluation_model_provider: string | null
  metrics_config: Record<string, unknown> | null
  judgement_conditions: Record<string, unknown> | null
}

export type NodeInfo = {
  node_id: string
  type: string
  title: string
}

export type EvaluationDefaultMetric = {
  metric?: string
  node_info_list?: NodeInfo[]
}

export type EvaluationCustomizedMetric = {
  evaluation_workflow_id?: string
  input_fields?: Record<string, unknown>
  output_fields?: Record<string, unknown>[]
}

export type EvaluationConfigData = {
  evaluation_model?: string
  evaluation_model_provider?: string
  default_metrics?: EvaluationDefaultMetric[]
  customized_metrics?: EvaluationCustomizedMetric | null
  judgment_config?: Record<string, unknown> | null
}

export type EvaluationRunRequest = EvaluationConfigData & {
  file_id: string
}

export type EvaluationRunStatus = 'pending' | 'running' | 'completed' | 'failed' | 'cancelled'

export type EvaluationRun = {
  id: string
  tenant_id: string
  target_type: string
  target_id: string
  evaluation_config_id: string
  status: EvaluationRunStatus
  dataset_file_id: string | null
  result_file_id: string | null
  total_items: number
  completed_items: number
  failed_items: number
  progress: number
  metrics_summary: Record<string, unknown>
  error: string | null
  created_by: string
  started_at: number | null
  completed_at: number | null
  created_at: number
}

export type EvaluationRunMetric = {
  name?: string
  value?: unknown
  details?: Record<string, unknown>
}

export type EvaluationRunItem = {
  id: string
  item_index: number
  inputs: Record<string, unknown>
  expected_output: string | null
  actual_output: string | null
  metrics: EvaluationRunMetric[]
  judgment: Record<string, unknown>
  metadata: Record<string, unknown>
  error: string | null
  overall_score: number | null
}

export type EvaluationLogsResponse = {
  data: EvaluationRun[]
  total: number
  page: number
  page_size: number
}

export type EvaluationRunItemsPagination = {
  data: EvaluationRunItem[]
  total: number
  page: number
  page_size: number
}

export type EvaluationRunDetailResponse = {
  run: EvaluationRun
  items: EvaluationRunItemsPagination
}

export type EvaluationMetricsMapResponse = {
  metrics: Record<string, string[]>
}

export type EvaluationMetricsListResponse = {
  metrics: string[]
}

export type EvaluationNodeInfoRequest = {
  metrics?: string[]
}

export type EvaluationNodeInfoResponse = Record<string, NodeInfo[]>

export type EvaluationFileInfo = {
  id: string
  name: string
  size: number
  extension: string
  mime_type: string
  created_at: number
  download_url: string
}

export type EvaluationVersionDetailResponse = {
  graph: Record<string, unknown>
}