Create Evaluation Job

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evaluationJob": {
    "evaluator": "<string>",
    "inputDataset": "<string>",
    "outputDataset": "<string>",
    "displayName": "<string>",
    "outputStats": "<string>",
    "awsS3Config": {
      "credentialsSecret": "<string>",
      "iamRoleArn": "<string>"
    }
  },
  "evaluationJobId": "<string>"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs"

payload = {
    "evaluationJob": {
        "evaluator": "<string>",
        "inputDataset": "<string>",
        "outputDataset": "<string>",
        "displayName": "<string>",
        "outputStats": "<string>",
        "awsS3Config": {
            "credentialsSecret": "<string>",
            "iamRoleArn": "<string>"
        }
    },
    "evaluationJobId": "<string>"
}
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({
    evaluationJob: {
      evaluator: '<string>',
      inputDataset: '<string>',
      outputDataset: '<string>',
      displayName: '<string>',
      outputStats: '<string>',
      awsS3Config: {credentialsSecret: '<string>', iamRoleArn: '<string>'}
    },
    evaluationJobId: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs', 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.fireworks.ai/v1/accounts/{account_id}/evaluationJobs",
  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([
    'evaluationJob' => [
        'evaluator' => '<string>',
        'inputDataset' => '<string>',
        'outputDataset' => '<string>',
        'displayName' => '<string>',
        'outputStats' => '<string>',
        'awsS3Config' => [
                'credentialsSecret' => '<string>',
                'iamRoleArn' => '<string>'
        ]
    ],
    'evaluationJobId' => '<string>'
  ]),
  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://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs"

	payload := strings.NewReader("{\n  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\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://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs")

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  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\n}"

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

{
  "evaluator": "<string>",
  "inputDataset": "<string>",
  "outputDataset": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "state": "JOB_STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "metrics": {},
  "outputStats": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  }
}

POST

accounts

{account_id}

evaluationJobs

Create Evaluation Job

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evaluationJob": {
    "evaluator": "<string>",
    "inputDataset": "<string>",
    "outputDataset": "<string>",
    "displayName": "<string>",
    "outputStats": "<string>",
    "awsS3Config": {
      "credentialsSecret": "<string>",
      "iamRoleArn": "<string>"
    }
  },
  "evaluationJobId": "<string>"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs"

payload = {
    "evaluationJob": {
        "evaluator": "<string>",
        "inputDataset": "<string>",
        "outputDataset": "<string>",
        "displayName": "<string>",
        "outputStats": "<string>",
        "awsS3Config": {
            "credentialsSecret": "<string>",
            "iamRoleArn": "<string>"
        }
    },
    "evaluationJobId": "<string>"
}
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({
    evaluationJob: {
      evaluator: '<string>',
      inputDataset: '<string>',
      outputDataset: '<string>',
      displayName: '<string>',
      outputStats: '<string>',
      awsS3Config: {credentialsSecret: '<string>', iamRoleArn: '<string>'}
    },
    evaluationJobId: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs', 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.fireworks.ai/v1/accounts/{account_id}/evaluationJobs",
  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([
    'evaluationJob' => [
        'evaluator' => '<string>',
        'inputDataset' => '<string>',
        'outputDataset' => '<string>',
        'displayName' => '<string>',
        'outputStats' => '<string>',
        'awsS3Config' => [
                'credentialsSecret' => '<string>',
                'iamRoleArn' => '<string>'
        ]
    ],
    'evaluationJobId' => '<string>'
  ]),
  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://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs"

	payload := strings.NewReader("{\n  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\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://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs")

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  \"evaluationJob\": {\n    \"evaluator\": \"<string>\",\n    \"inputDataset\": \"<string>\",\n    \"outputDataset\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"outputStats\": \"<string>\",\n    \"awsS3Config\": {\n      \"credentialsSecret\": \"<string>\",\n      \"iamRoleArn\": \"<string>\"\n    }\n  },\n  \"evaluationJobId\": \"<string>\"\n}"

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

{
  "evaluator": "<string>",
  "inputDataset": "<string>",
  "outputDataset": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "state": "JOB_STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "metrics": {},
  "outputStats": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

Body

application/json

evaluationJob

object

required

Show child attributes

evaluationJobId

string

Response

200 - application/json

A successful response.

evaluator

string

required

The fully-qualified resource name of the Evaluation used by this job.

Format: accounts/{account_id}/evaluators/{evaluator_id}

inputDataset

string

required

The fully-qualified resource name of the input Dataset used by this job.

Format: accounts/{account_id}/datasets/{dataset_id}

outputDataset

string

required

The fully-qualified resource name of the output Dataset created by this job.

Format: accounts/{account_id}/datasets/{output_dataset_id}

name

string

read-only

displayName

string

createTime

string<date-time>

read-only

createdBy

string

read-only

state

enum<string>

default:JOB_STATE_UNSPECIFIED

read-only

JobState represents the state an asynchronous job can be in.

JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
JOB_STATE_DELETED: Job has been deleted.
JOB_STATE_ARCHIVED: User-facing state for jobs whose row is retained post-delete (e.g. RLOR trainers within the checkpoint retention window). The internal row is still in JOB_STATE_DELETED; the gateway translates it to ARCHIVED on public responses.

Available options:

JOB_STATE_UNSPECIFIED,

JOB_STATE_CREATING,

JOB_STATE_RUNNING,

JOB_STATE_COMPLETED,

JOB_STATE_FAILED,

JOB_STATE_CANCELLED,

JOB_STATE_DELETING,

JOB_STATE_WRITING_RESULTS,

JOB_STATE_VALIDATING,

JOB_STATE_DELETING_CLEANING_UP,

JOB_STATE_PENDING,

JOB_STATE_EXPIRED,

JOB_STATE_RE_QUEUEING,

JOB_STATE_CREATING_INPUT_DATASET,

JOB_STATE_IDLE,

JOB_STATE_CANCELLING,

JOB_STATE_EARLY_STOPPED,

JOB_STATE_PAUSED,

JOB_STATE_DELETED,

JOB_STATE_ARCHIVED

status

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

read-only

Show child attributes

metrics

object

read-only

Show child attributes

outputStats

string

The output dataset's aggregated stats for the evaluation job.

updateTime

string<date-time>

read-only

The update time for the evaluation job.

awsS3Config

object

The AWS configuration for S3 dataset access.

Show child attributes

Resume Dpo Job

List Evaluation Jobs

⌘I

API Reference

Inference

Deployments

Fine-tuning

Evals

Multimedia

Admin

Create Evaluation Job

Authorizations

Path Parameters

Body

Response