Datasets

Create a dataset

Changed on

Create a new dataset with JSON examples. Empty datasets are not allowed.

Payload Requirements

  • The dataset name must be unique within the given space.
  • Each item in examples[] may contain any user-defined fields.
  • Do not include system-managed fields on input: id, created_at, updated_at. Requests that contain these fields in any example will be rejected.
  • Each example must contain at least one property (i.e., {} is invalid).

Valid example (create)

{
  "name": "my-dataset",
  "space_id": "spc_123",
  "examples": [
    {
      "question": "What is 2+2?",
      "answer": "4",
      "topic": "math"
    },
    {
      "question": "What is the capital of Spain?",
      "answer": "Madrid",
      "topic": "geography"
    },
  ]
}

Invalid example ('id' not allowed on create)

{
  "name": "my-dataset",
  "space_id": "spc_123",
  "examples": [
    {
      "id": "ex_1",
      "input": "Hello"
    }
  ]
}

<Note>This endpoint is in beta, read more here.</Note>

post/v2/datasets

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/datasets
  • Auth
    HTTP bearer

Request body

namestring required

Name of the new dataset. Must be unique within the space.

space_idstring required

ID of the space the dataset will belong to

examplesCreateDatasetExampleInput[] required

Array of examples for the new dataset

Response

A dataset object

idstring required

Unique identifier for the dataset

namestring required

Name of the dataset

space_idstring required

Unique identifier for the space this dataset belongs to

created_atstring date-time required

Timestamp for when the dataset was created

updated_atstring date-time required

Timestamp for the last update of the dataset

Changes

    • info

      added the non-success response with the status

    • breaking

      the request property's minItems was increased to 1

    • info

      api operation id datasets_create removed and replaced with create_dataset

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status