Datasets

Fetch Dataset

Fetch a dataset

get
/v1/dataset/{datasetId}/fetch

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

datasetIdstring* Required

The ID of the dataset to retrieve

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.dataset.fetch(

datasetId
)
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"store":"string",
"reranker":"string",
"recordMaxTokens":"number",
"searchMinScore":"number",
"searchMaxRecords":"number",
"searchMaxTokens":"number",
"matchInstruction":"string",
"mismatchInstruction":"string",
"separators":"string",
"visibility":"string"
}
The dataset was retrieved successfully