PATCH
/
v4
/
evaluation-datasets
/
{evaluation_dataset_id}
/
test-cases
/
{test_case_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 testCase = await client.evaluationDatasets.testCases.update('evaluation_dataset_id', 'test_case_id');

  console.log(testCase);
}

main();
{
  "evaluation_dataset_id": "<string>",
  "schema_type": "GENERATION",
  "test_case_data": {
    "input": "<string>",
    "expected_output": "<string>",
    "expected_extra_info": {
      "schema_type": "CHUNKS",
      "chunks": [
        {
          "text": "<string>",
          "metadata": {}
        }
      ]
    },
    "artifact_ids_filter": [
      "<string>"
    ]
  },
  "chat_history": {},
  "autogenerated": true,
  "test_case_metadata": {},
  "invalidated_at": "2023-11-07T05:31:56Z",
  "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_dataset_id
string
required
​
test_case_id
string
required

Body

application/json
​
test_case_data
object
​
chat_history
object
​
test_case_metadata
object
​
account_id
string
​
restore
boolean
default:false

Set to true to restore the entity from the database.

Response

200
application/json
Successful Response
​
evaluation_dataset_id
string
required

The ID of the associated evaluation dataset.

​
test_case_data
object
required
​
autogenerated
boolean
required

Boolean to track whether or not the test case is autogenerated

​
id
string
required

The unique identifier of the entity.

​
created_at
string
required

The date and time when the entity was created in ISO format.

​
account_id
string
required

The ID of the account that owns the given entity.

​
created_by_user_id
string
required

The user who originally created the entity.

​
schema_type
enum<string>
default:FLEXIBLE
​
chat_history
object

Used for tracking previous chat interactions for multi-chat test cases

​
test_case_metadata
object

Metadata for the test case

​
invalidated_at
string

The date and time when the entity was overwritten or deleted in ISO format.

​
archived_at
string

The date and time when the entity was archived in ISO format.