admin/evaluation/dataset

Create Evaluation Dataset

Create a dataset for a given question and chat engine. This API depends on the /admin/uploads API to upload the evaluation data. The evaluation data is expected to be a CSV file with the following columns:

  • query: The query to evaluate
  • reference: The expected response to the query

You can add more columns to the CSV file, and the extra columns will adhere to the results.

Args: evaluation_dataset.name: The name of the evaluation dataset. evaluation_dataset.upload_id: The ID of the uploaded CSV file of the evaluation dataset.

Returns: True if the evaluation dataset is created successfully.

post/api/v1/admin/evaluation/datasets

Request

  • Base URL: https://tidb.ai (the document declares no server; this is the origin it was published from)
  • URL: https://tidb.ai/api/v1/admin/evaluation/datasets
  • Auth: API key in cookie session

Request body

namestring required
upload_idinteger nullable

Response

Successful Response

created_atstring date-time nullable
updated_atstring date-time nullable
idinteger nullable
namestring required
user_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.