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}

import requests

url = "https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/{entity}/{project}/evaluations/{object_id}/versions/{digest}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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)