Update Dataset Split

Overview

Prompts

Prompt Tools

Prompt Partials

Datasets

Evaluators

Log repositories

Folders

Workflows

Integrations

Alerts

Models

Test runs

Test run entries

Test run reports

Logging

Workspaces

Update Dataset Split

curl --request PUT \
  --url https://api.getmaxim.ai/v1/datasets/splits \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "id": "<string>",
  "datasetId": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.getmaxim.ai/v1/datasets/splits"

payload = {
    "id": "<string>",
    "datasetId": "<string>",
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    datasetId: '<string>',
    name: '<string>',
    description: '<string>'
  })
};

fetch('https://api.getmaxim.ai/v1/datasets/splits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmaxim.ai/v1/datasets/splits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'datasetId' => '<string>',
    'name' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmaxim.ai/v1/datasets/splits"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.getmaxim.ai/v1/datasets/splits")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/datasets/splits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "meta": {
        "columnDataType": "<string>",
        "delimiter": "<string>"
      },
      "columnType": "<string>"
    }
  ]
}

PUT

datasets

splits

Update Dataset Split

curl --request PUT \
  --url https://api.getmaxim.ai/v1/datasets/splits \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "id": "<string>",
  "datasetId": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.getmaxim.ai/v1/datasets/splits"

payload = {
    "id": "<string>",
    "datasetId": "<string>",
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    datasetId: '<string>',
    name: '<string>',
    description: '<string>'
  })
};

fetch('https://api.getmaxim.ai/v1/datasets/splits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmaxim.ai/v1/datasets/splits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'datasetId' => '<string>',
    'name' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmaxim.ai/v1/datasets/splits"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.getmaxim.ai/v1/datasets/splits")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/datasets/splits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "meta": {
        "columnDataType": "<string>",
        "delimiter": "<string>"
      },
      "columnType": "<string>"
    }
  ]
}

Authorizations

x-maxim-api-key

string

header

required

API key for authentication

Body

application/json

string

required

Unique identifier for the dataset split to update

datasetId

string

required

Unique identifier for the dataset

name

string

Name of the dataset split

Required string length: 1 - 255

description

string

Description of the dataset split

Maximum string length: 255

Response

Dataset split updated successfully

data

object[]

required

Show child attributes

⌘I