GetDatasetDetails

post https://api.us-east-1.relevance.ai/latest/datasets/{dataset_id}/details

Returns a page of datasets and in detail the dataset's associated information that you are authorized to read/write. The information includes:

Information	Description
schema	Data schema of a dataset. (returns same data as /dataset/{dataset_id}/schema)
metadata	Metadata of a dataset. (returns same data as /dataset/{dataset_id}/metadata)
stats	Statistics of number of documents and size of a dataset. (returns same data as /dataset/{dataset_id}/monitor/stats)
vector_health	Number of zero vectors stored. (returns same data as /dataset/{dataset_id}/monitor/health)
schema_stats	Fields and number of documents missing/not missing for that field. (returns same data as /dataset/{dataset_id}/monitor/stats)
active_jobs	All active jobs/tasks on the dataset. (returns same data as /dataset/{dataset_id}/tasks/list)

Response

Language

Credentials

Header


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/details \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "include_schema": true,
8
  "include_stats": true,
9
  "include_metadata": true,
10
  "include_schema_stats": false,
11
  "include_vector_health": false,
12
  "include_active_jobs": false,
13
  "include_settings": false
14
}
15
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation