POST /v1/datasets

Create a dataset by uploading a file. See 'Dataset Creation' for more information.

Servers

Request headers

Name Type Required Description
X-Client-Name String No

The name of the project that is making the request.

Query parameters

Name Type Required Description
keep_fields[] Array No

List of names of fields that will be persisted in the Dataset. By default the Dataset will retain only the required fields indicated in the schema for the corresponding Dataset type. For example, datasets of type embed-input will drop all fields other than the required text field. If any of the fields in keep_fields are missing from the uploaded file, Dataset validation will fail.

name String Yes

The name of the uploaded dataset.

keep_original_file Boolean No

Indicates if the original file should be stored.

csv_delimiter String No

The delimiter used for .csv uploads.

type String Yes

The dataset type, which is used to validate the data. Valid types are embed-input, reranker-finetune-input, single-label-classification-finetune-input, chat-finetune-input, and multi-label-classification-finetune-input.

Possible values:

  • "chat-finetune-input"
  • "single-label-classification-finetune-input"
  • "reranker-finetune-input"
  • "embed-result"
  • "cluster-outliers"
  • "multi-label-classification-finetune-input"
  • "embed-input"
  • "cluster-result"
text_separator String No

Raw .txt uploads will be split into entries using the text_separator value.

optional_fields[] Array No

List of names of fields that will be persisted in the Dataset. By default the Dataset will retain only the required fields indicated in the schema for the corresponding Dataset type. For example, Datasets of type embed-input will drop all fields other than the required text field. If any of the fields in optional_fields are missing from the uploaded file, Dataset validation will pass.

skip_malformed_input Boolean No

Indicates whether rows with malformed input should be dropped (instead of failing the validation check). Dropped rows will be returned in the warnings field.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.