Create Dataset

Create dataset

post

/v1/dataset/create

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

namestring

The name of the dataset

descriptionstring

A description of the dataset

storestring

The storage class for this dataset

recordMaxTokensnumber

The total number of tokens for each record

searchMinScorenumber

The minimum score to filter search results by

searchMaxRecordsnumber

The total number of records to return during search

searchMaxTokensnumber

The total number of tokens to use during search

matchInstructionstring

An instruction to include before found records

mismatchInstructionstring

An instruction to include if no records where found

separatorsstring

A list of separators to use when tokenizing text

visibilitystring

The dataset visibility

metaobject

Meta data information


curl -X POST "https://api.chatbotkit.com/v1/dataset/create" \
-H "Authorization: Bearer $CHATBOTKIT_API_SECRET" \
-H "Content-Type: application/json" \
--data-binary @- << EOF
{"name":"string",
"description":"string",
"store":"string",
"recordMaxTokens":"number",
"searchMinScore":"number",
"searchMaxRecords":"number",
"searchMaxTokens":"number",
"matchInstruction":"string",
"mismatchInstruction":"string",
"separators":"string",
"visibility":"string",
"meta":"object"
}
EOF

{"id":"string"
}

The dataset was created successfully