Scale API | Training Datasets › List Training Datasets

Training Datasets

training_datasets

Methods

Create Training Dataset ->

TrainingDataset

post/v4/training-datasets

Create Training Dataset

Delete Training Dataset ->

GenericDeleteResponse

delete/v4/training-datasets/{training_dataset_id}

Description

Deletes a training dataset

Details

This API can be used to delete a training dataset by ID. To use this API, pass in the id that was returned from your Create Training Dataset API call as a path parameter.

List Training Datasets -> PageResponse<

TrainingDataset

get/v4/training-datasets

Description

Lists all training datasets accessible to the user.

Details

This API can be used to list training datasets. If a user has access to multiple accounts, all training datasets from all accounts the user is associated with will be returned.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id:

Optional

UnionMember0 = number

UnionMember1 = string

limit: number

Optional

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

page: number

Optional

Page number for pagination to be returned by the given endpoint. Starts at page 1

Response fields

PaginatedTrainingDatasets

Request example

curl https://api.egp.scale.com/v4/training-datasets \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "data_source": "S3",
      "name": "name",
      "schema_type": "GENERATION"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Training Dataset ->

TrainingDataset

get/v4/training-datasets/{training_dataset_id}

Description

Gets the details of a training dataset

Details

This API can be used to get information about a single training dataset by ID. To use this API, pass in the id that was returned from your Create Training Dataset API call as a path parameter.

Review the response schema to see the fields that will be returned.

Domain types

PaginatedTrainingDatasets = { current_page, items, items_per_page, 1 more... }

TrainingDataset = { id, account_id, created_at, 4 more... }

TrainingDatasetGenerationItem = { input, output, schema_type }

Training Datasets

training_datasets.contents

Methods

Get Training Dataset Contents -> TopLevelArray<

TrainingDatasetGenerationItem

get/v4/training-datasets/{training_dataset_id}/contents

Get Training Dataset Contents