Create a Dataset

POST/v1/datasetsCreate a Dataset

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

Parameters

namestringqueryrequired

The name of the uploaded dataset.

typestringqueryrequired

The dataset type, which is used to validate the data. The only valid type is `embed-input` used in conjunction with the Embed Jobs API.

one of "embed-input", "embed-result", "cluster-result", "cluster-outliers", "reranker-finetune-input", "single-label-classification-finetune-input", "chat-finetune-input", "multi-label-classification-finetune-input", "batch-chat-input", "batch-openai-chat-input", "batch-embed-v2-input", "batch-chat-v2-input"

keep_original_filebooleanquery

Indicates if the original file should be stored.

skip_malformed_inputbooleanquery

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

keep_fieldsarrayquery

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](https://docs.cohere.com/docs/datasets#dataset-types). 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.

optional_fieldsarrayquery

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](https://docs.cohere.com/docs/datasets#dataset-types). 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.

text_separatorstringquery

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

csv_delimiterstringquery

The delimiter used for .csv uploads.

X-Client-Namestringheader

The name of the project that is making the request.

Request body

multipart/form-data

object

datastring · binaryrequired

The file to upload

eval_datastring · binary

An optional evaluation file to upload

Example request

{
  "data": "binary",
  "eval_data": "binary"
}

Responses

object

idstring

The dataset ID

Example response

{
  "id": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

Examples

namerequiredquery parameter

typerequiredquery parameter

keep_original_filequery parameter

skip_malformed_inputquery parameter

keep_fieldsquery parameter

optional_fieldsquery parameter

text_separatorquery parameter

csv_delimiterquery parameter

X-Client-Nameheader parameter

curl -X POST 'https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input' \
  -H 'Content-Type: application/json' \
  -d '{"data":"binary","eval_data":"binary"}'

const response = await fetch('https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"data":"binary","eval_data":"binary"}),
});
const data = await response.json();

const response = await fetch('https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"data\":\"binary\",\"eval_data\":\"binary\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input",
    headers={"Content-Type": "application/json"},
    data='{"data":"binary","eval_data":"binary"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"data":"binary","eval_data":"binary"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"data\":\"binary\",\"eval_data\":\"binary\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"data\":\"binary\",\"eval_data\":\"binary\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"data\":\"binary\",\"eval_data\":\"binary\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cohere.com/v1/datasets?csv_delimiter=string&keep_fields=%5B%22string%22%5D&keep_original_file=true&name=string&optional_fields=%5B%22string%22%5D&skip_malformed_input=true&text_separator=string&type=batch-chat-input");
request.Content = new StringContent("{\"data\":\"binary\",\"eval_data\":\"binary\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

Search documentation

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations

Create a Dataset

Parameters

Request body

Responses

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations