List dpo jobs

GET /v1/accounts/{account_id}/dpoJobs

cURL

cURL

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

200

{
  "dpoJobs": [
    {
      "dataset": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "completedTime": "2023-11-07T05:31:56Z",
      "state": "JOB_STATE_UNSPECIFIED",
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "createdBy": "<string>",
      "trainingConfig": {
        "outputModel": "<string>",
        "baseModel": "<string>",
        "warmStartFrom": "<string>",
        "jinjaTemplate": "<string>",
        "learningRate": 123,
        "maxContextLength": 123,
        "loraRank": 123,
        "epochs": 123,
        "batchSize": 123,
        "gradientAccumulationSteps": 123,
        "learningRateWarmupSteps": 123,
        "batchSizeSamples": 123,
        "optimizerWeightDecay": 123,
        "trainerShardingScheme": {
          "tensorParallelism": 123,
          "pipelineParallelism": 123,
          "contextParallelism": 123,
          "expertParallelism": 123,
          "sequenceParallelism": true
        },
        "loraAlpha": 123,
        "loraDropout": 123,
        "loraTargetModules": [
          "<string>"
        ],
        "lrScheduler": {
          "constant": {},
          "linear": {
            "minLrRatio": 123,
            "decayRatio": 123
          },
          "cosine": {
            "minLrRatio": 123,
            "decayRatio": 123
          }
        }
      },
      "wandbConfig": {
        "enabled": true,
        "apiKey": "<string>",
        "project": "<string>",
        "entity": "<string>",
        "runId": "<string>",
        "url": "<string>"
      },
      "trainerLogsSignedUrl": "<string>",
      "lossConfig": {
        "method": "METHOD_UNSPECIFIED",
        "klBeta": 123,
        "dpo": {
          "beta": 123,
          "refCacheConcurrency": 123,
          "refCacheBatchSize": 123
        },
        "orpo": {
          "lambda": 123
        }
      },
      "awsS3Config": {
        "credentialsSecret": "<string>",
        "iamRoleArn": "<string>"
      },
      "azureBlobStorageConfig": {
        "credentialsSecret": "<string>",
        "managedIdentityClientId": "<string>",
        "tenantId": "<string>"
      },
      "purpose": "PURPOSE_UNSPECIFIED",
      "useReservation": true
    }
  ],
  "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>

The maximum number of dpo jobs to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageToken · string

A page token, received from a previous ListDpoJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDpoJobs must match the call that provided the page token.

filter · string

Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification.

orderBy · string

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "name".

readMask · string

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

includeArchived · boolean

If true, include archived (post-delete retention) jobs in the response. Archived jobs are inert (no resources running, no further billing) but their checkpoints remain promotable until the retention window expires.

Response

200 - application/json

A successful response.

dpoJobs · object[]

Show child attributes

nextPageToken · string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize · integer<int32>