Passer au contenu principal
PUT
/
annotation_queues
/
{queue_id}
Mise à jour de la file d’annotation
curl --request PUT \
  --url https://api.example.com/annotation_queues/{queue_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "description": "Updated description",
  "name": "Updated Queue Name",
  "scorer_refs": [
    "weave:///entity/project/scorer/error_severity:abc123",
    "weave:///entity/project/scorer/resolution_quality:def456"
  ]
}
'
import requests

url = "https://api.example.com/annotation_queues/{queue_id}"

payload = {
"project_id": "<string>",
"description": "Updated description",
"name": "Updated Queue Name",
"scorer_refs": ["weave:///entity/project/scorer/error_severity:abc123", "weave:///entity/project/scorer/resolution_quality:def456"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '<string>',
description: 'Updated description',
name: 'Updated Queue Name',
scorer_refs: [
'weave:///entity/project/scorer/error_severity:abc123',
'weave:///entity/project/scorer/resolution_quality:def456'
]
})
};

fetch('https://api.example.com/annotation_queues/{queue_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.example.com/annotation_queues/{queue_id}",
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([
'project_id' => '<string>',
'description' => 'Updated description',
'name' => 'Updated Queue Name',
'scorer_refs' => [
'weave:///entity/project/scorer/error_severity:abc123',
'weave:///entity/project/scorer/resolution_quality:def456'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$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.example.com/annotation_queues/{queue_id}"

payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"description\": \"Updated description\",\n \"name\": \"Updated Queue Name\",\n \"scorer_refs\": [\n \"weave:///entity/project/scorer/error_severity:abc123\",\n \"weave:///entity/project/scorer/resolution_quality:def456\"\n ]\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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.example.com/annotation_queues/{queue_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"description\": \"Updated description\",\n \"name\": \"Updated Queue Name\",\n \"scorer_refs\": [\n \"weave:///entity/project/scorer/error_severity:abc123\",\n \"weave:///entity/project/scorer/resolution_quality:def456\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/annotation_queues/{queue_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"<string>\",\n \"description\": \"Updated description\",\n \"name\": \"Updated Queue Name\",\n \"scorer_refs\": [\n \"weave:///entity/project/scorer/error_severity:abc123\",\n \"weave:///entity/project/scorer/resolution_quality:def456\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "queue": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "project_id": "<string>",
    "scorer_refs": [
      "<string>"
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Autorisations

Authorization
string
header
requis

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Paramètres de chemin

queue_id
string
requis

Corps

application/json

Corps de la requête pour la mise à jour d’une file d’annotation (queue_id provient du chemin).

Tous les champs sauf project_id sont facultatifs : seuls les champs fournis seront mis à jour.

project_id
string
requis
Exemple:

"entity/project"

description
string | null
Exemple:

"Updated description"

name
string | null
Exemple:

"Updated Queue Name"

scorer_refs
string[] | null
Exemple:
[
"weave:///entity/project/scorer/error_severity:abc123",
"weave:///entity/project/scorer/resolution_quality:def456"
]

Réponse

Réponse réussie

Réponse à la mise à jour d’une file d’annotation.

queue
AnnotationQueueSchema · object
requis

Schéma des réponses de file d'attente d'annotation.