Update Dataset - Maxim Docs

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

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

import requests

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

payload = {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<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>', workspaceId: '<string>', name: '<string>'})
};

fetch('https://api.getmaxim.ai/v1/datasets', 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",
  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>',
    'workspaceId' => '<string>',
    'name' => '<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"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<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")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{}

PUT

datasets

Update Dataset

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

import requests

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

payload = {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<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>', workspaceId: '<string>', name: '<string>'})
};

fetch('https://api.getmaxim.ai/v1/datasets', 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",
  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>',
    'workspaceId' => '<string>',
    'name' => '<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"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<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")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{}

Authorizations

x-maxim-api-key

string

header

required

API key for authentication

Body

application/json

string

required

Unique identifier for the alert

Minimum string length: 1

workspaceId

string

required

Unique identifier for the workspace

Minimum string length: 1

name

string

required

Name of the dataset

Minimum string length: 1

Response

Dataset updated successfully

The response is of type object.

⌘I