List Evaluation Jobs

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs \
  --header 'Authorization: Bearer <token>'

{
  "evaluationJobs": [
    {
      "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"
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

GET

accounts

{account_id}

evaluationJobs

List Evaluation Jobs

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/evaluationJobs \
  --header 'Authorization: Bearer <token>'

{
  "evaluationJobs": [
    {
      "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"
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

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

Query Parameters

pageSize

integer<int32>

pageToken

string

filter

string

orderBy

string

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.

evaluationJobs

Next ID: 18 · object[]

Show child attributes

evaluationJobs.evaluator

string

required

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

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

evaluationJobs.inputDataset

string

required

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

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

evaluationJobs.outputDataset

string

required

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

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

evaluationJobs.name

string

evaluationJobs.displayName

string

evaluationJobs.createTime

string<date-time>

evaluationJobs.createdBy

string

evaluationJobs.state

enum<string>

default:JOB_STATE_UNSPECIFIED

JobState represents the state an asynchronous job can be in.

JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.

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

evaluationJobs.status

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

Show child attributes

evaluationJobs.status.code

enum<string>

default:OK

The status code.

Available options:

OK,

CANCELLED,

UNKNOWN,

INVALID_ARGUMENT,

DEADLINE_EXCEEDED,

NOT_FOUND,

ALREADY_EXISTS,

PERMISSION_DENIED,

UNAUTHENTICATED,

RESOURCE_EXHAUSTED,

FAILED_PRECONDITION,

ABORTED,

OUT_OF_RANGE,

UNIMPLEMENTED,

INTERNAL,

UNAVAILABLE,

DATA_LOSS

evaluationJobs.status.message

string

A developer-facing error message in English.

evaluationJobs.metrics

object

Show child attributes

evaluationJobs.metrics.{key}

number<double>

evaluationJobs.outputStats

string

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

evaluationJobs.updateTime

string<date-time>

The update time for the evaluation job.

nextPageToken

string

totalSize

integer<int32>

Create Evaluation Job

Get Evaluation Job

⌘I

API Reference

Inference

Deployments

Fine-tuning

Evals

Multimedia

Admin

Build SDK (Deprecated)

List Evaluation Jobs

Authorizations

Path Parameters

Query Parameters

Response