/agents/{id}/datasets/tune

Create Tuning Dataset

Create a new tuning Dataset for the specified Agent using the provided JSONL or CSV file. A Dataset is a versioned collection of samples conforming to a particular schema, and can be used as a source of training and test data for tuning jobs.

Each Dataset is versioned and validated against its schema during creation and subsequent updates. The provided Dataset file must conform to the schema defined for the dataset_type.

File schema for dataset_type tuning_set is a CSV file or a JSONL file where each line is one JSON object. The following keys are required:

knowledge (list[str]): Retrieved knowledge used to generate the reference answer. knowledge is a list of retrieved text chunks.
reference (str): The gold-standard answer to the prompt.
guideline (str): Guidelines for model output. If you do not have special guidelines for the model’s output, you can use the System Prompt defined in your Agent configuration as the guideline.
prompt (str): Question for the model to respond to.

For examples of what tuning_set should look like, check out our Tune & Evaluation Guide.

POST

agents

{agent_id}

datasets

tune

Copy
curl --request POST \
  --url https://api.contextual.ai/v1/agents/{agent_id}/datasets/tune \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'dataset_name=<string>' \
  --form dataset_type=tuning_set

Copy
{
  "version": "<string>",
  "name": "<string>",
  "type": "tuning_set"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id

string

required

Agent ID to associate with the tune dataset

Body

multipart/form-data

dataset_name

string

required

Name of the tune dataset

dataset_type

enum<string>

required

Type of tune dataset which determines its schema and validation rules.

Available options:

tuning_set,

evaluation_set,

evaluation_set_prediction,

evaluation_run_result

file

required

JSONL or CSV file containing the tune dataset

Response

200

application/json

Successful Response

Response to POST /datasets request

version

string

required

Version number of the dataset

name

string

required

Name of the dataset

type

enum<string>

required

Type of the dataset

Available options:

tuning_set,

evaluation_set,

evaluation_set_prediction,

evaluation_run_result

Was this page helpful?

List Tuning Datasets Get Tuning Dataset

Copy
curl --request POST \
  --url https://api.contextual.ai/v1/agents/{agent_id}/datasets/tune \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'dataset_name=<string>' \
  --form dataset_type=tuning_set

Copy
{
  "version": "<string>",
  "name": "<string>",
  "type": "tuning_set"
}

/datastores

/datastores/{id}/documents

/agents

/agents/{id}/query

/agents/{id}/evaluate

/agents/{id}/datasets/evaluate

/agents/{id}/datasets/tune

/agents/{id}/tune

/lmunit

/users

/generate

/rerank

Create Tuning Dataset

Authorizations

Path Parameters

Body

Response