Evaluation Read

Get an evaluation object.

GET /v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}

Evaluation Read

cURL

curl --request GET \
  --url https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "object_id": "<string>",
  "digest": "<string>",
  "version_index": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "dataset": "<string>",
  "scorers": [
    "<string>"
  ],
  "trials": 123,
  "description": "<string>",
  "evaluation_name": "<string>",
  "evaluate_op": "<string>",
  "predict_and_score_op": "<string>",
  "summarize_op": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

entity · string · required

project · string · required

object_id · string · required

digest · string · required

Response

200

application/json

Successful Response

object_id · string · required

The evaluation ID

digest · string · required

The digest of the evaluation

version_index · integer · required

The version index of the evaluation

created_at · string<date-time> · required

When the evaluation was created

name · string · required

The name of the evaluation

dataset · string · required

Dataset reference (weave:// URI)

scorers · string[] · required

List of scorer references (weave:// URIs)

trials · integer · required

Number of trials

description · string | null

A description of the evaluation

evaluation_name · string | null

Name for the evaluation run

evaluate_op · string | null

Evaluate op reference (weave:// URI)

predict_and_score_op · string | null

Predict and score op reference (weave:// URI)

summarize_op · string | null

Summarize op reference (weave:// URI)