Skip to main content
PATCH
/
v1
/
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>"
}
'
{
  "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[]
​
requirements
string
​
entryPoint
string
​
commitHash
string
​
source
object

Source information for the evaluator codebase.

​
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[]
​
requirements
string
​
entryPoint
string
​
status
Status of the evaluator, used to expose build status to the user · object
read-only
​
commitHash
string
​
source
object

Source information for the evaluator codebase.

​
defaultDataset
string