PATCH
/
v4
/
evaluations
/
{evaluation_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 evaluation = await client.evaluations.update('evaluation_id');

  console.log(evaluation.id);
}

main();
{
  "name": "<string>",
  "description": "<string>",
  "status": "PENDING",
  "application_spec_id": "<string>",
  "application_variant_id": "<string>",
  "tags": {},
  "evaluation_config": {},
  "evaluation_config_id": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "total_test_case_result_count": 123,
  "completed_test_case_result_count": 123,
  "annotation_config": {
    "annotation_config_type": "generation",
    "components": [
      [
        {
          "optional": true,
          "data_loc": [
            "<string>"
          ],
          "label": "<string>"
        }
      ]
    ],
    "direction": "col",
    "llm_prompt": {
      "variables": [
        {
          "name": "<string>",
          "optional": true,
          "data_loc": [
            "<string>"
          ]
        }
      ],
      "template": "<string>"
    }
  },
  "question_id_to_annotation_config": {},
  "metric_config": {
    "components": [
      {
        "type": "rouge",
        "name": "<string>",
        "mappings": {},
        "params": {}
      }
    ]
  },
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

evaluation_id
string
required

Body

application/json

Response

200
application/json
Successful Response

The response is of type object.