Skip to main content

Create Experiment

Create Experiment

POST 
/api/2/auto_eval/experiment/create

Create a new Experiment

Request​

Body

    name stringrequired

    Human-readable name for the experiment

    description string

    Succint description of the experiment, if one exists.

    projectId stringrequired

    Project the experiment is associated with

    metadata

    object

    Metadata relevant to the application configuration from which all experiment evaluation runs are derived. E.g. 'llm_model', 'chunk_size'

    fields

    object

    required

    property name*

    object

    Ordered row values with length always equal to num_rows on the corresponding view.

    property name* any

    Ordered row values with length always equal to num_rows on the corresponding view.

Responses​

Successful operation

Schema

    experiment

    object

    required

    id stringrequired
    createdAt date-timerequired

    A summary is retrieved for a time range from start_time to end_time If no end_time is provided, current time is used

    updatedAt date-timerequired

    A summary is retrieved for a time range from start_time to end_time If no end_time is provided, current time is used

    creatorId string
    name stringrequired
    description string
    projectId stringrequired

    metadata

    object

    fields

    object

    required

    property name*

    object

    Ordered row values with length always equal to num_rows on the corresponding view.

    property name* any

    Ordered row values with length always equal to num_rows on the corresponding view.

Loading...