Evaluation

curl --request POST \
  --url https://inference-service-433968519479.us-central1.run.app/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hf_token": "<string>",
  "model_source": "<string>",
  "base_model_id": "<string>",
  "dataset_id": "<string>",
  "metrics": [],
  "max_samples": 123,
  "num_sample_results": 3,
  "use_vllm": false
}
'

import requests

url = "https://inference-service-433968519479.us-central1.run.app/evaluation"

payload = {
    "hf_token": "<string>",
    "model_source": "<string>",
    "base_model_id": "<string>",
    "dataset_id": "<string>",
    "metrics": [],
    "max_samples": 123,
    "num_sample_results": 3,
    "use_vllm": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hf_token: '<string>',
    model_source: '<string>',
    base_model_id: '<string>',
    dataset_id: '<string>',
    metrics: [],
    max_samples: 123,
    num_sample_results: 3,
    use_vllm: false
  })
};

fetch('https://inference-service-433968519479.us-central1.run.app/evaluation', 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://inference-service-433968519479.us-central1.run.app/evaluation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hf_token' => '<string>',
    'model_source' => '<string>',
    'base_model_id' => '<string>',
    'dataset_id' => '<string>',
    'metrics' => [
        
    ],
    'max_samples' => 123,
    'num_sample_results' => 3,
    'use_vllm' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://inference-service-433968519479.us-central1.run.app/evaluation"

	payload := strings.NewReader("{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://inference-service-433968519479.us-central1.run.app/evaluation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inference-service-433968519479.us-central1.run.app/evaluation")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}"

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

{
  "metrics": {},
  "num_samples": 123,
  "dataset_id": "<string>",
  "samples": [
    {
      "prediction": "<string>",
      "reference": "<string>",
      "sample_index": 123,
      "input": [
        {}
      ]
    }
  ]
}

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

POST

evaluation

Evaluation

curl --request POST \
  --url https://inference-service-433968519479.us-central1.run.app/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hf_token": "<string>",
  "model_source": "<string>",
  "base_model_id": "<string>",
  "dataset_id": "<string>",
  "metrics": [],
  "max_samples": 123,
  "num_sample_results": 3,
  "use_vllm": false
}
'

import requests

url = "https://inference-service-433968519479.us-central1.run.app/evaluation"

payload = {
    "hf_token": "<string>",
    "model_source": "<string>",
    "base_model_id": "<string>",
    "dataset_id": "<string>",
    "metrics": [],
    "max_samples": 123,
    "num_sample_results": 3,
    "use_vllm": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hf_token: '<string>',
    model_source: '<string>',
    base_model_id: '<string>',
    dataset_id: '<string>',
    metrics: [],
    max_samples: 123,
    num_sample_results: 3,
    use_vllm: false
  })
};

fetch('https://inference-service-433968519479.us-central1.run.app/evaluation', 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://inference-service-433968519479.us-central1.run.app/evaluation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hf_token' => '<string>',
    'model_source' => '<string>',
    'base_model_id' => '<string>',
    'dataset_id' => '<string>',
    'metrics' => [
        
    ],
    'max_samples' => 123,
    'num_sample_results' => 3,
    'use_vllm' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://inference-service-433968519479.us-central1.run.app/evaluation"

	payload := strings.NewReader("{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://inference-service-433968519479.us-central1.run.app/evaluation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inference-service-433968519479.us-central1.run.app/evaluation")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hf_token\": \"<string>\",\n  \"model_source\": \"<string>\",\n  \"base_model_id\": \"<string>\",\n  \"dataset_id\": \"<string>\",\n  \"metrics\": [],\n  \"max_samples\": 123,\n  \"num_sample_results\": 3,\n  \"use_vllm\": false\n}"

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

{
  "metrics": {},
  "num_samples": 123,
  "dataset_id": "<string>",
  "samples": [
    {
      "prediction": "<string>",
      "reference": "<string>",
      "sample_index": 123,
      "input": [
        {}
      ]
    }
  ]
}

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

Authorizations

Authorization

string

header

required

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

Body

application/json

hf_token

string

required

model_source

string

required

model_type

enum<string>

required

Available options:

adapter,

merged,

base

base_model_id

string

required

dataset_id

string

required

task_type

enum<string> | null

Available options:

conversation,

qa,

summarization,

translation,

classification,

general

metrics

enum<string>[] | null

Available options:

rouge,

bertscore,

accuracy,

exact_match,

bleu,

meteor,

recall,

precision,

f1

max_samples

integer | null

num_sample_results

integer | null

default:3

use_vllm

boolean | null

default:false

Response

Successful Response

metrics

Metrics · object

required

Show child attributes

num_samples

integer

required

dataset_id

string

required

samples

SampleResult · object[]

required

Show child attributes

Batch inference Health

API documentation

Dataset preprocessing

Training

Inference

Export

Evaluation

Authorizations

Body

Response