Apply Bulk Annotation

POST /v2/projects/{project_id}/annotation/ratings

Apply Bulk Annotation

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/annotation/ratings \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "operations": [
    {
      "rating": {
        "value": true,
        "annotation_type": "like_dislike"
      },
      "annotation_template_id": "<string>",
      "explanation": "<string>",
      "operation_type": "create"
    }
  ],
  "selector": {
    "traces": [
      "<string>"
    ],
    "selector_type": "traces"
  }
}
'

import requests

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

payload = {
    "operations": [
        {
            "rating": {
                "value": True,
                "annotation_type": "like_dislike"
            },
            "annotation_template_id": "<string>",
            "explanation": "<string>",
            "operation_type": "create"
        }
    ],
    "selector": {
        "traces": ["<string>"],
        "selector_type": "traces"
    }
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operations: [
      {
        rating: {value: true, annotation_type: 'like_dislike'},
        annotation_template_id: '<string>',
        explanation: '<string>',
        operation_type: 'create'
      }
    ],
    selector: {traces: ['<string>'], selector_type: 'traces'}
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/annotation/ratings', 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/ratings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'operations' => [
        [
                'rating' => [
                                'value' => true,
                                'annotation_type' => 'like_dislike'
                ],
                'annotation_template_id' => '<string>',
                'explanation' => '<string>',
                'operation_type' => 'create'
        ]
    ],
    'selector' => [
        'traces' => [
                '<string>'
        ],
        'selector_type' => 'traces'
    ]
  ]),
  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/ratings"

	payload := strings.NewReader("{\n  \"operations\": [\n    {\n      \"rating\": {\n        \"value\": true,\n        \"annotation_type\": \"like_dislike\"\n      },\n      \"annotation_template_id\": \"<string>\",\n      \"explanation\": \"<string>\",\n      \"operation_type\": \"create\"\n    }\n  ],\n  \"selector\": {\n    \"traces\": [\n      \"<string>\"\n    ],\n    \"selector_type\": \"traces\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.galileo.ai/v2/projects/{project_id}/annotation/ratings")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operations\": [\n    {\n      \"rating\": {\n        \"value\": true,\n        \"annotation_type\": \"like_dislike\"\n      },\n      \"annotation_template_id\": \"<string>\",\n      \"explanation\": \"<string>\",\n      \"operation_type\": \"create\"\n    }\n  ],\n  \"selector\": {\n    \"traces\": [\n      \"<string>\"\n    ],\n    \"selector_type\": \"traces\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operations\": [\n    {\n      \"rating\": {\n        \"value\": true,\n        \"annotation_type\": \"like_dislike\"\n      },\n      \"annotation_template_id\": \"<string>\",\n      \"explanation\": \"<string>\",\n      \"operation_type\": \"create\"\n    }\n  ],\n  \"selector\": {\n    \"traces\": [\n      \"<string>\"\n    ],\n    \"selector_type\": \"traces\"\n  }\n}"

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

200

[
  {
    "success": true,
    "message": "<string>",
    "selector": "traces",
    "index": 123,
    "trace": "<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

Body

application/json

operations · (BulkAnnotationRatingCreate · object | BulkAnnotationRatingDelete · object)[] · required

BulkAnnotationRatingCreate

BulkAnnotationRatingDelete

Show child attributes

selector · Selector · object · required

Choose specific traces to apply the bulk operation to.

Show child attributes

Response

200

application/json

Successful Response

operation · enum<string> · required

Operation type for bulk annotation rating operations.

Available options: create, delete

success · boolean · required

message · string | null · required

selector · enum<string> · default: traces

Available options: traces

index · integer | null

trace · string<uuid4> | null