Update Dataset

Update a specific dataset.

PATCH /api/v1/datasets/{dataset_id}

Error

A valid request URL is required to generate request examples

200

{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "inputs_schema_definition": {},
  "outputs_schema_definition": {},
  "externally_managed": false,
  "transformations": [
    {
      "path": [
        "<string>"
      ]
    }
  ],
  "data_type": "kv"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid> · required

Body

application/json

Update class for Dataset.

name · string Missing · object · default: {"__missing__":"__missing__"}

description · string Missing · object · default: {"__missing__":"__missing__"}

inputs_schema_definition · Inputs Schema Definition · object

Inputs Schema Definition

Missing

outputs_schema_definition · Outputs Schema Definition · object

Outputs Schema Definition

Missing

patch_examples · Patch Examples · object | null

Show child attributes

transformations · DatasetTransformation · object

DatasetTransformation · object[]

Missing · object

Show child attributes

metadata · Metadata · object

Metadata

Missing

baseline_experiment_id · string<uuid> Missing · object · default: {"__missing__":"__missing__"}

Response

200

application/json

Dataset updated successfully

name · string · required

id · string<uuid> · required

tenant_id · string<uuid> · required

description · string | null

created_at · string<date-time>

inputs_schema_definition · Inputs Schema Definition · object | null

outputs_schema_definition · Outputs Schema Definition · object | null

externally_managed · boolean | null · default: false

transformations · DatasetTransformation · object[] | null

Show child attributes

data_type · enum<string> | null · default: kv

Enum for dataset data types.

Available options: kv, llm, chat