Update annotation queue | Opik Documentation

PATCH/v1/private/annotation-queues/{id}Update annotation queue

Update annotation queue by id

Parameters

idstring · uuidpathrequired

Request body

application/json

objectAnnotationQueueUpdate

annotators_per_iteminteger · int32

maximum 1000 · minimum 1

automationobject

Show child attributes

conditionsobject

Show child attributes

groupsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

conditionsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

operatorstringrequired

one of ">", "<", "="

score_namestringrequired

maxLength 255 · minLength 0

valuenumber · doublerequired

enabledboolean

max_items_in_queueinteger · int32

comments_enabledboolean

descriptionstring

feedback_definition_namesarray of string

Show child attributes

instructionsstring

lock_timeout_secondsinteger · int32

maximum 3600 · minimum 1

namestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

Example request

{
  "annotators_per_item": 0,
  "automation": {
    "conditions": {
      "groups": [
        {
          "conditions": [
            {
              "operator": "<",
              "score_name": "string",
              "value": 0
            }
          ]
        }
      ]
    },
    "enabled": true,
    "max_items_in_queue": 0
  },
  "comments_enabled": true,
  "description": "string",
  "feedback_definition_names": [
    "string"
  ],
  "instructions": "string",
  "lock_timeout_seconds": 0,
  "name": "string"
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

idrequiredpath parameter

curl -X PATCH 'http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"instructions":"string","lock_timeout_seconds":0,"name":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"instructions":"string","lock_timeout_seconds":0,"name":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"instructions":"string","lock_timeout_seconds":0,"name":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"annotators_per_item":0,"automation":{"conditions":{"groups":[{"conditions":[{"operator":"<","score_name":"string","value":0}]}]},"enabled":true,"max_items_in_queue":0},"comments_enabled":true,"description":"string","feedback_definition_names":["string"],"instructions":"string","lock_timeout_seconds":0,"name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000", 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("http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\"}"
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.Patch, "http://localhost:5173/api/v1/private/annotation-queues/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"annotators_per_item\":0,\"automation\":{\"conditions\":{\"groups\":[{\"conditions\":[{\"operator\":\"<\",\"score_name\":\"string\",\"value\":0}]}]},\"enabled\":true,\"max_items_in_queue\":0},\"comments_enabled\":true,\"description\":\"string\",\"feedback_definition_names\":[\"string\"],\"instructions\":\"string\",\"lock_timeout_seconds\":0,\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}