Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
evaluators
/
{evaluator_id}
cURL
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluators/{evaluator_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "multiMetrics": true,
  "criteria": [
    {
      "type": "TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "codeSnippets": {
        "language": "<string>",
        "fileContents": {},
        "entryFile": "<string>",
        "entryFunc": "<string>"
      }
    }
  ],
  "requirements": "<string>",
  "rollupSettings": {
    "criteriaWeights": {},
    "pythonCode": "<string>",
    "successThreshold": 123,
    "skipRollup": true
  },
  "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

​
readMask
string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

​
name
string
​
displayName
string
​
description
string
​
createTime
string<date-time>
​
createdBy
string
​
updateTime
string<date-time>
​
state
enum<string>
default:STATE_UNSPECIFIED
Available options:
STATE_UNSPECIFIED,
ACTIVE,
BUILDING,
BUILD_FAILED
​
multiMetrics
boolean

If true, the criteria will report multiple metric-score pairs Otherwise, each criteria will report the score assigned to the criteria name as metric.

​
criteria
Criteria for the evaluator, it should produce a score for the metric (name of criteria) · object[]
​
requirements
string
​
rollupSettings
object

Strategy for metrics reports summary/rollup. e.g. {metric1: 1, metric2: 0.3}, rollup_settings could be criteria_weights: {metric1: 0.5, metric2: 0.5}, then final score will be 0.5 * 1 + 0.5 * 0.3 = 0.65 If skip_rollup is true, the rollup step will be skipped since the criteria will also report the rollup score and metrics altogether.

​
entryPoint
string
​
status
Status of the evaluator, used to expose build status to the user · object
​
commitHash
string
​
source
object

Source information for the evaluator codebase.

​
defaultDataset
string