Skip to main content
POST
Create Evaluation

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json
name
string
required
data
Data · object[]
required

Items to be evaluated

Minimum array length: 1
description
string
tags
string[]

The tags associated with the entity

tasks
(ChatCompletionEvaluationTask · object | GenericInferenceEvaluationTask · object | ApplicationVariantV1EvaluationTask · object | AgentexOutputEvaluationTask · object | MetricEvaluationTask · object | AutoEvaluationQuestionTask · object | AutoEvaluationGuidedDecodingEvaluationTask · object | AutoEvaluationAgentEvaluationTask · object | ContributorEvaluationQuestionTask · object | CustomFunctionEvaluationTask · object)[]

Tasks allow you to augment and evaluate your data

metadata
Metadata · object

Optional metadata key-value pairs for the evaluation

taxonomy_params
Taxonomy Params · object

Taxonomy params from the task builder. When provided, stores directly as evaluation taxonomy.

files
Files · object[]

Files to be associated to the evaluation

Minimum array length: 1

Response

Successful Response

id
string
required
name
string
required
created_at
string<date-time>
required
created_by
Identity · object
required

The identity that created the entity.

tags
string[]
required

The tags associated with the entity

datasets
Datasets · object[]
required
status
enum<string>
required
Available options:
failed,
completed,
running
object
string
default:evaluation
Allowed value: "evaluation"
description
string
archived_at
string<date-time>
status_reason
string

Reason for evaluation status

progress
EvaluationTasksProgressSchema · object

Progress of the evaluation's underlying async job

tasks
(ChatCompletionEvaluationTask · object | GenericInferenceEvaluationTask · object | ApplicationVariantV1EvaluationTask · object | AgentexOutputEvaluationTask · object | MetricEvaluationTask · object | AutoEvaluationQuestionTask · object | AutoEvaluationGuidedDecodingEvaluationTask · object | AutoEvaluationAgentEvaluationTask · object | ContributorEvaluationQuestionTask · object | CustomFunctionEvaluationTask · object)[]

Tasks executed during evaluation. Populated with optional task view.

metadata
Metadata · object

Metadata key-value pairs for the evaluation

error_count
integer

Number of task errors across all items in this evaluation.