POST
/
evaluations
Authorization
Body
curl --request POST \
  --url https://api.honeyhive.ai/evaluations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "comments": [
    {}
  ],
  "dataset": [
    {}
  ],
  "datasetName": "<string>",
  "description": "<string>",
  "generations": [
    {}
  ],
  "id": "<string>",
  "metrics": [
    []
  ],
  "metrics_to_compute": [
    "<string>"
  ],
  "name": "<string>",
  "prompts": [
    {}
  ],
  "results": [
    {}
  ],
  "summary": [
    {}
  ],
  "task": "<string>",
  "user": "<string>"
}'
{
  "id": "<string>",
  "success": true
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
comments
object[]

The comments for the evaluation

dataset
object[]

The dataset for which the evaluation is being created

datasetName
string

The name of the dataset for which the evaluation is being created

description
string

The description of the evaluation

generations
object[]

The completions for prompts that are being evaluated

id
string

The id of the evaluation

metrics
array

The metrics that are computed for the completions

metrics_to_compute
string[]

The metrics that are computed for the completions

name
string

The name of the evaluation

prompts
object[]

The prompts for which the evaluation is being created

results
object[]

The results of the evaluation

summary
object[]

The metric summary of the evaluation

task
string

The task for which the evaluation is being created

user
string

The user running the evaluation

Response

200 - application/json
id
string

The ID of the created object

success
boolean

Indicates whether the request was successful