Skip to main content
PATCH
/
v1
/
accounts
/
{account_id}
/
datasets
/
{dataset_id}
Update Dataset
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "exampleCount": "<string>",
  "userUploaded": {},
  "evaluationResult": {
    "evaluationJobId": "<string>"
  },
  "transformed": {
    "sourceDatasetId": "<string>",
    "filter": "<string>",
    "originalFormat": "FORMAT_UNSPECIFIED"
  },
  "splitted": {
    "sourceDatasetId": "<string>"
  },
  "evalProtocol": {},
  "externalUrl": "<string>",
  "format": "FORMAT_UNSPECIFIED",
  "sourceJobName": "<string>"
}
'
{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "exampleCount": "<string>",
  "userUploaded": {},
  "evaluationResult": {
    "evaluationJobId": "<string>"
  },
  "transformed": {
    "sourceDatasetId": "<string>",
    "filter": "<string>",
    "originalFormat": "FORMAT_UNSPECIFIED"
  },
  "splitted": {
    "sourceDatasetId": "<string>"
  },
  "evalProtocol": {},
  "externalUrl": "<string>",
  "format": "FORMAT_UNSPECIFIED",
  "createdBy": "<string>",
  "updateTime": "2023-11-07T05:31:56Z",
  "sourceJobName": "<string>",
  "estimatedTokenCount": "<string>",
  "averageTurnCount": 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

​
dataset_id
string
required

The Dataset Id

Body

application/json

The properties of the Dataset being updated. dataset.name must be populated with the updated resource's name.

​
displayName
string
​
exampleCount
string<int64>
​
userUploaded
object
​
evaluationResult
object
​
transformed
object
​
splitted
object
​
evalProtocol
object
​
externalUrl
string
​
format
enum<string>
default:FORMAT_UNSPECIFIED
Available options:
FORMAT_UNSPECIFIED,
CHAT,
COMPLETION,
RL
​
sourceJobName
string

The resource name of the job that created this dataset (e.g., batch inference job). Used for lineage tracking to understand dataset provenance.

Response

200 - application/json

A successful response.

​
name
string
​
displayName
string
​
createTime
string<date-time>
​
state
enum<string>
default:STATE_UNSPECIFIED
Available options:
STATE_UNSPECIFIED,
UPLOADING,
READY
​
status
Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object
​
exampleCount
string<int64>
​
userUploaded
object
​
evaluationResult
object
​
transformed
object
​
splitted
object
​
evalProtocol
object
​
externalUrl
string
​
format
enum<string>
default:FORMAT_UNSPECIFIED
Available options:
FORMAT_UNSPECIFIED,
CHAT,
COMPLETION,
RL
​
createdBy
string

The email address of the user who initiated this fine-tuning job.

​
updateTime
string<date-time>

The update time for the dataset.

​
sourceJobName
string

The resource name of the job that created this dataset (e.g., batch inference job). Used for lineage tracking to understand dataset provenance.

​
estimatedTokenCount
string<int64>

The estimated number of tokens in the dataset.

​
averageTurnCount
number<float>

An estimate of the average number of turns per sample in the dataset.