PATCH
/
v4
/
evaluations
/
{evaluation_id}
/
tasks
/
{task_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const task = await client.evaluations.tasks.update('evaluation_id', 'task_id');

  console.log(task.id);
}

main();
{
  "id": "<string>",
  "task_type": "EVALUATION_ANNOTATION",
  "task_entity_parent_id": "<string>",
  "task_entity_id": "<string>",
  "account_id": "<string>",
  "assigned_to": "<string>",
  "assignment_expires_at": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "priority": 123,
  "task_entity": {
    "label_status": "PENDING",
    "audit_status": "UNAUDITED",
    "audit_required": true,
    "audit_comment": "<string>",
    "application_spec_id": "<string>",
    "evaluation_id": "<string>",
    "evaluation_dataset_id": "<string>",
    "evaluation_dataset_version_num": "<string>",
    "test_case_id": "<string>",
    "test_case_evaluation_data": {
      "generation_output": "<string>",
      "generation_extra_info": {
        "schema_type": "CHUNKS",
        "chunks": [
          {
            "text": "<string>",
            "metadata": {}
          }
        ]
      }
    },
    "test_case_evaluation_data_schema": "GENERATION",
    "result": {},
    "completed_at": "2023-11-07T05:31:56Z",
    "time_spent_labeling_s": 123,
    "application_test_case_output_id": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "created_by_user_id": "<string>",
    "annotated_by_user_id": "<string>",
    "archived_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
evaluation_id
string
required
​
task_id
string
required

Body

application/json
​
assigned_to
string

The ID of the user that the task is assigned to.

Response

200
application/json
Successful Response
​
id
string
required
​
task_type
enum<string>
required
Available options:
EVALUATION_ANNOTATION
​
task_entity_parent_id
string
required
​
task_entity_id
string
required
​
account_id
string
required

The ID of the account that owns the given entity.

​
status
enum<string>
required
Available options:
PENDING,
COMPLETED
​
priority
integer
required
​
assigned_to
string

The ID of the user that the task is assigned to.

​
assignment_expires_at
string

The date and time when the task assignment expires in ISO format.

​
task_entity
object

The entity that the task is associated with.

Batch assign tasks to userGet Contributor Metrics