Dataset

Update dataset

post/dataset/{datasetId}/update

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/dataset/{datasetId}/update
  • Auth: HTTP bearer

Path parameters

datasetIdstring required

Request body

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

blueprintIdstring nullable

The ID of the blueprint

rerankerstring

The reranker class for the dataset

recordMaxTokensnumber

The total number of tokens to 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

visibility'private' | 'protected' | 'public'

The dataset visibility

Response

The dataset was updated successfully

idstring required

The ID of the updated dataset

Changes

No recorded changes to this operation across all 1 revision of this API.