Update Evaluator

curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "description": "<string>",
  "criteria": [
    {
      "type": "TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "codeSnippets": {
        "language": "<string>",
        "fileContents": {},
        "entryFile": "<string>",
        "entryFunc": "<string>"
      }
    }
  ],
  "requirements": "<string>",
  "entryPoint": "<string>",
  "commitHash": "<string>",
  "source": {
    "type": "TYPE_UNSPECIFIED",
    "githubRepositoryName": "<string>"
  },
  "defaultDataset": "<string>"
}
'

import requests

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

payload = {
    "displayName": "<string>",
    "description": "<string>",
    "criteria": [
        {
            "type": "TYPE_UNSPECIFIED",
            "name": "<string>",
            "description": "<string>",
            "codeSnippets": {
                "language": "<string>",
                "fileContents": {},
                "entryFile": "<string>",
                "entryFunc": "<string>"
            }
        }
    ],
    "requirements": "<string>",
    "entryPoint": "<string>",
    "commitHash": "<string>",
    "source": {
        "type": "TYPE_UNSPECIFIED",
        "githubRepositoryName": "<string>"
    },
    "defaultDataset": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    description: '<string>',
    criteria: [
      {
        type: 'TYPE_UNSPECIFIED',
        name: '<string>',
        description: '<string>',
        codeSnippets: {
          language: '<string>',
          fileContents: {},
          entryFile: '<string>',
          entryFunc: '<string>'
        }
      }
    ],
    requirements: '<string>',
    entryPoint: '<string>',
    commitHash: '<string>',
    source: {type: 'TYPE_UNSPECIFIED', githubRepositoryName: '<string>'},
    defaultDataset: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id}', 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}/evaluators/{evaluator_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'description' => '<string>',
    'criteria' => [
        [
                'type' => 'TYPE_UNSPECIFIED',
                'name' => '<string>',
                'description' => '<string>',
                'codeSnippets' => [
                                'language' => '<string>',
                                'fileContents' => [
                                                                
                                ],
                                'entryFile' => '<string>',
                                'entryFunc' => '<string>'
                ]
        ]
    ],
    'requirements' => '<string>',
    'entryPoint' => '<string>',
    'commitHash' => '<string>',
    'source' => [
        'type' => 'TYPE_UNSPECIFIED',
        'githubRepositoryName' => '<string>'
    ],
    'defaultDataset' => '<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}/evaluators/{evaluator_id}"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}"

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

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "criteria": [
    {
      "type": "TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "codeSnippets": {
        "language": "<string>",
        "fileContents": {},
        "entryFile": "<string>",
        "entryFunc": "<string>"
      }
    }
  ],
  "requirements": "<string>",
  "entryPoint": "<string>",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "commitHash": "<string>",
  "source": {
    "type": "TYPE_UNSPECIFIED",
    "githubRepositoryName": "<string>"
  },
  "defaultDataset": "<string>"
}

PATCH

accounts

{account_id}

evaluators

{evaluator_id}

Update Evaluator

curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "description": "<string>",
  "criteria": [
    {
      "type": "TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "codeSnippets": {
        "language": "<string>",
        "fileContents": {},
        "entryFile": "<string>",
        "entryFunc": "<string>"
      }
    }
  ],
  "requirements": "<string>",
  "entryPoint": "<string>",
  "commitHash": "<string>",
  "source": {
    "type": "TYPE_UNSPECIFIED",
    "githubRepositoryName": "<string>"
  },
  "defaultDataset": "<string>"
}
'

import requests

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

payload = {
    "displayName": "<string>",
    "description": "<string>",
    "criteria": [
        {
            "type": "TYPE_UNSPECIFIED",
            "name": "<string>",
            "description": "<string>",
            "codeSnippets": {
                "language": "<string>",
                "fileContents": {},
                "entryFile": "<string>",
                "entryFunc": "<string>"
            }
        }
    ],
    "requirements": "<string>",
    "entryPoint": "<string>",
    "commitHash": "<string>",
    "source": {
        "type": "TYPE_UNSPECIFIED",
        "githubRepositoryName": "<string>"
    },
    "defaultDataset": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    description: '<string>',
    criteria: [
      {
        type: 'TYPE_UNSPECIFIED',
        name: '<string>',
        description: '<string>',
        codeSnippets: {
          language: '<string>',
          fileContents: {},
          entryFile: '<string>',
          entryFunc: '<string>'
        }
      }
    ],
    requirements: '<string>',
    entryPoint: '<string>',
    commitHash: '<string>',
    source: {type: 'TYPE_UNSPECIFIED', githubRepositoryName: '<string>'},
    defaultDataset: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id}', 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}/evaluators/{evaluator_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'description' => '<string>',
    'criteria' => [
        [
                'type' => 'TYPE_UNSPECIFIED',
                'name' => '<string>',
                'description' => '<string>',
                'codeSnippets' => [
                                'language' => '<string>',
                                'fileContents' => [
                                                                
                                ],
                                'entryFile' => '<string>',
                                'entryFunc' => '<string>'
                ]
        ]
    ],
    'requirements' => '<string>',
    'entryPoint' => '<string>',
    'commitHash' => '<string>',
    'source' => [
        'type' => 'TYPE_UNSPECIFIED',
        'githubRepositoryName' => '<string>'
    ],
    'defaultDataset' => '<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}/evaluators/{evaluator_id}"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"criteria\": [\n    {\n      \"type\": \"TYPE_UNSPECIFIED\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"codeSnippets\": {\n        \"language\": \"<string>\",\n        \"fileContents\": {},\n        \"entryFile\": \"<string>\",\n        \"entryFunc\": \"<string>\"\n      }\n    }\n  ],\n  \"requirements\": \"<string>\",\n  \"entryPoint\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"source\": {\n    \"type\": \"TYPE_UNSPECIFIED\",\n    \"githubRepositoryName\": \"<string>\"\n  },\n  \"defaultDataset\": \"<string>\"\n}"

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

{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "criteria": [
    {
      "type": "TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "codeSnippets": {
        "language": "<string>",
        "fileContents": {},
        "entryFile": "<string>",
        "entryFunc": "<string>"
      }
    }
  ],
  "requirements": "<string>",
  "entryPoint": "<string>",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "commitHash": "<string>",
  "source": {
    "type": "TYPE_UNSPECIFIED",
    "githubRepositoryName": "<string>"
  },
  "defaultDataset": "<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

evaluator_id

string

required

The Evaluator Id

Query Parameters

prepareCodeUpload

boolean

If true, prepare a new code upload/build attempt by transitioning the evaluator to BUILDING state. Can be used without update_mask.

Body

application/json

The evaluator to update. The name must be set.

displayName

string

description

string

criteria

Criteria for the evaluator, it should produce a score for the metric (name of criteria) Used for eval3 with UI upload path · object[]

Show child attributes

requirements

string

entryPoint

string

commitHash

string

source

object

Source information for the evaluator codebase.

Show child attributes

defaultDataset

string

Response

200 - application/json

A successful response.

name

string

read-only

displayName

string

description

string

createTime

string<date-time>

read-only

createdBy

string

read-only

updateTime

string<date-time>

read-only

state

enum<string>

default:STATE_UNSPECIFIED

read-only

Available options:

STATE_UNSPECIFIED,

ACTIVE,

BUILDING,

BUILD_FAILED

criteria

Criteria for the evaluator, it should produce a score for the metric (name of criteria) Used for eval3 with UI upload path · object[]

Show child attributes

requirements

string

entryPoint

string

status

Status of the evaluator, used to expose build status to the user · object

read-only

Show child attributes

commitHash

string

source

object

Source information for the evaluator codebase.

Show child attributes

defaultDataset

string

Get Evaluator Source Code Endpoint

Delete Evaluator

⌘I

API Reference

Inference

Deployments

Fine-tuning

Evals

Multimedia

Admin

Update Evaluator

Authorizations

Path Parameters

Query Parameters

Body

Response