Skip to content
Adaption Adaption Adaption
SupportLogin
API Reference
Datasets

Add rows to a dataset from the curated pool

datasets.augment(strdataset_id, DatasetAugmentParams**kwargs) -> DatasetAugmentResponse
POST/api/v1/datasets/{dataset_id}/augment

Retrieves additional rows matching this dataset and returns them as a new dataset, leaving this one unchanged. The new dataset carries this dataset’s rows alongside the retrieved ones, so it can be trained on or downloaded directly. Poll GET /datasets/{dataset_id}/status on the returned id until it reaches succeeded. Set estimate=true to price the request without starting a run.

ParametersExpand Collapse
dataset_id: str
domain_rows: Optional[float]

How many additional rows to retrieve from topics matching this dataset. Defaults to 0.

minimum0
maximum100000
general_rows: Optional[float]

How many additional rows to retrieve from other topics, to broaden the dataset. Defaults to 0.

minimum0
maximum100000
training_type: Optional[Literal["instruction_dataset", "preference_pairs"]]

Shape of the rows to retrieve. instruction_dataset (default) retrieves prompt/completion pairs for SFT; preference_pairs retrieves chosen/rejected pairs for DPO.

One of the following:
"instruction_dataset"
"preference_pairs"
estimate: Optional[bool]

When true, validates the request and returns the estimated credit cost without starting a run or creating a dataset.

idempotency_key: Optional[str]

Opaque key that makes a retried request safe. A second request carrying the same key returns the dataset the first one created instead of starting and charging for a second run.

maxLength255
ReturnsExpand Collapse
class DatasetAugmentResponse: …
dataset_id: Optional[str]

The augmented dataset. It carries this dataset’s rows plus the retrieved ones, and is ready to download once its status reaches succeeded. Null for an estimate, which creates nothing.

status: Optional[Literal["pending", "running", "awaiting_input", 2 more]]

Status of the augmented dataset at the moment this response was sent, in the same vocabulary GET /datasets/{dataset_id}/status reports. Poll that endpoint until it reaches succeeded or failed. An idempotent replay of a finished run returns its terminal status here.

One of the following:
"pending"
"running"
"awaiting_input"
"succeeded"
"failed"
estimated_credits_consumed: float

Credits this run consumes, charged against the requested rows.

estimate: bool

Whether this was an estimate-only request (no run started).

Add rows to a dataset from the curated pool

import os
from adaption import Adaption

client = Adaption(
    api_key=os.environ.get("ADAPTION_API_KEY"),  # This is the default and can be omitted
)
response = client.datasets.augment(
    dataset_id="dataset_id",
)
print(response.dataset_id)
{
  "dataset_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running",
  "estimated_credits_consumed": 40,
  "estimate": true
}
Returns Examples
{
  "dataset_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running",
  "estimated_credits_consumed": 40,
  "estimate": true
}