Update Testset

Update a Testset. Only the fields provided in the request body will be updated. If a field is provided, the new content will replace the existing content. If a field is not provided, the existing content will remain unchanged.

When updating the schema:

• If field mappings are not provided and existing mappings reference fields that no longer exist, those mappings will be automatically removed
• To preserve all existing mappings, ensure all referenced fields remain in the updated schema
• For complete control, provide both schema and fieldMapping when updating the schema

PATCH /testsets/{testsetId}

JavaScript

JavaScript

import Scorecard from 'scorecard-ai';

const client = new Scorecard({
  apiKey: 'My API Key',
});

const testset = await client.testsets.update('246', {
  description: 'Updated description for the Q&A Testset.',
  name: 'Updated Q&A Testset',
});

console.log(testset.id);

200

Updated metadata only

{
  "id": "246",
  "name": "Updated Q&A Testset",
  "description": "Updated description for the Q&A Testset.",
  "jsonSchema": {
    "type": "object",
    "properties": {
      "question": {
        "type": "string"
      },
      "idealAnswer": {
        "type": "string"
      },
      "provenance": {
        "type": "string"
      },
      "geo": {
        "type": "string"
      }
    }
  },
  "fieldMapping": {
    "inputs": [
      "question"
    ],
    "expected": [
      "idealAnswer"
    ],
    "metadata": [
      "provenance",
      "geo"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

testsetId · string · required

The ID of the Testset to update.

Example:

"246"

Body

application/json

name · string

The name of the Testset.

description · string

The description of the Testset.

jsonSchema · object

The JSON schema for each Testcase in the Testset.

fieldMapping · object

Maps top-level keys of the Testcase schema to their roles (input/expected output). Unmapped fields are treated as metadata.

Show child attributes

Response

200

application/json

Testset updated successfully

A collection of Testcases that share the same schema. Each Testset defines the structure of its Testcases through a JSON schema. The fieldMapping object maps top-level keys of the Testcase schema to their roles (input/expected output). Fields not mentioned in the fieldMapping during creation or update are treated as metadata.

JSON Schema validation constraints supported:

• Required fields - Fields listed in the schema's required array must be present in Testcases.
• Type validation - Values must match the specified type (string, number, boolean, null, integer, object, array).
• Enum validation - Values must be one of the options specified in the enum array.
• Object property validation - Properties of objects must conform to their defined schemas.
• Array item validation - Items in arrays must conform to the items schema.
• Logical composition - Values must conform to at least one schema in the anyOf array.

Testcases that fail validation will still be stored, but will include validationErrors detailing the issues. Extra fields in the Testcase data that are not in the schema will be stored but are ignored during validation.

id · string · required

The ID of the Testset.

name · string · required

The name of the Testset.

description · string · required

The description of the Testset.

jsonSchema · object · required

The JSON schema for each Testcase in the Testset.

fieldMapping · object · required

Maps top-level keys of the Testcase schema to their roles (input/expected output). Unmapped fields are treated as metadata.

Show child attributes