Passer au contenu principal
POST
/
annotation_queues
/
{queue_id}
/
items
/
{item_id}
/
progress
Mise à jour de la progression d'un élément de la file d'attente d'annotation
curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items/{item_id}/progress \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annotation_state": "<string>",
  "project_id": "<string>"
}
'
import requests

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

payload = {
"annotation_state": "<string>",
"project_id": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({annotation_state: '<string>', project_id: '<string>'})
};

fetch('https://api.example.com/annotation_queues/{queue_id}/items/{item_id}/progress', 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}/items/{item_id}/progress",
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([
'annotation_state' => '<string>',
'project_id' => '<string>'
]),
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}/items/{item_id}/progress"

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

req, _ := http.NewRequest("POST", 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.post("https://api.example.com/annotation_queues/{queue_id}/items/{item_id}/progress")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"annotation_state\": \"<string>\",\n \"project_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"annotation_state\": \"<string>\",\n \"project_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "item": {
    "call_id": "<string>",
    "call_op_name": "<string>",
    "call_started_at": "2023-11-07T05:31:56Z",
    "call_trace_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "display_fields": [
      "<string>"
    ],
    "id": "<string>",
    "project_id": "<string>",
    "queue_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "added_by": "<string>",
    "annotator_user_id": "<string>",
    "call_ended_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "position_in_queue": 123
  }
}
{
"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
item_id
string
requis

Corps

application/json

Corps de la requête pour mettre à jour la progression de l’annotation (queue_id et item_id proviennent du chemin).

Remarque : wb_user_id n’est pas inclus dans le corps de la requête ; il est défini côté serveur à partir de la session authentifiée.

annotation_state
string
requis

Nouvel état : 'in_progress', 'completed' ou 'skipped'

Exemples:

"in_progress"

"completed"

"skipped"

project_id
string
requis
Exemple:

"entity/project"

Réponse

Réponse réussie

Réponse après mise à jour de l’état de l’annotation.

item
AnnotationQueueItemSchema · object
requis

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