Update Annotation Template

PATCH /v2/projects/{project_id}/annotation/templates/{template_id}

Update Annotation Template

cURL

curl --request PATCH \
  --url https://api.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "criteria": "<string>"
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}"

payload = {
    "name": "<string>",
    "criteria": "<string>"
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', criteria: '<string>'})
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}', 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.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'criteria' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-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.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}"

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

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

	req.Header.Add("Galileo-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.patch("https://api.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"criteria\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/annotation/templates/{template_id}")

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

request = Net::HTTP::Patch.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"criteria\": \"<string>\"\n}"

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

200

{
  "name": "<string>",
  "include_explanation": true,
  "constraints": {
    "annotation_type": "<string>"
  },
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "position": 123,
  "usage_count": 123,
  "criteria": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

project_id · string<uuid4> · required

template_id · string<uuid4> · required

Body

application/json

name · string · required

Required string length: 1 - 255

criteria · string | null · required

Minimum string length: 1

Response

200

application/json

Successful Response

name · string · required

Required string length: 1 - 255

include_explanation · boolean · required

constraints · LikeDislikeConstraints · object · required

LikeDislikeConstraints

StarConstraints

ScoreConstraints

TagsConstraints

TextConstraints

ChoiceConstraints

TreeChoiceDBConstraints

Show child attributes

id · string<uuid4> · required

created_at · string<date-time> · required

created_by · string<uuid4> | null · required

position · integer · required

usage_count · integer · required

Number of annotation ratings using the template.

criteria · string | null

Minimum string length: 1