Skip to main content

Get Dataset

Retrieve detailed information about a specific dataset using the Knowledgator TypeScript SDK.


Configuration Template​

  • dataset_id ("<DATASET_ID>"): The unique UUID of the dataset, obtained from kg.datasets.list() or returned when creating a dataset with kg.datasets.create().
import { createClient } from '@knowledgator/typescript-sdk';

const kg = createClient('YOUR_API_KEY');

const dataset = await kg.datasets.get('<DATASET_ID>');

Concrete Example​

Retrieve metadata and status for a specific dataset:

import { createClient } from '@knowledgator/typescript-sdk';

const kg = createClient('YOUR_API_KEY');

const dataset = await kg.datasets.get('6babd48a-2256-4466-b16b-9fd45ba59688');
console.log(dataset.name, dataset.status);

Expected Output​

My NER Dataset ready

Result Object Structure​

{
"id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"name": "My NER Dataset",
"type": "ner",
"format": "jsonl",
"status": "ready",
"short_description": "Dataset for named entity recognition",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"file_count": 5,
"total_size": 1048576
}