Skip to main content

Get Dataset

The get_dataset_details tool retrieves full metadata, sample statistics, format, and processing status for a specific dataset ID.


Tool Overview​

  • Tool Name: get_dataset_details
  • Underlying Endpoint: GET /datasets/{dataset_id}/
  • SDK Methods: kg.datasets.get (Python) / kg.datasets.get (TypeScript)

Parameters​

ParameterTypeRequiredDescription
dataset_idStringYesUnique identifier of the dataset to retrieve.

Example Usage​

Natural Language Prompt to Agent​

"Check the status and details of dataset 'ds-8924b1a4-92ef'."

Tool Call Arguments​

{
"name": "get_dataset_details",
"arguments": {
"dataset_id": "ds-8924b1a4-92ef"
}
}

Tool Response​

{
"id": "ds-8924b1a4-92ef",
"name": "ecommerce_reviews_ner",
"type": "ner",
"format": "jsonl",
"status": "ready",
"description": "Synthetic product review annotations",
"created_at": "2024-02-10T14:20:00Z",
"updated_at": "2024-02-10T14:25:00Z",
"file_count": 1,
"total_size": 204800,
"num_samples": 250
}