PATCH
/
v1
/
testset
/
{testset_id}
/
testcase
/
{testcase_id}
curl --request PATCH \
  --url https://api.getscorecard.ai/v1/testset/{testset_id}/testcase/{testcase_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "user_query": "What is the moon made of?",
  "context": "After the Apollo missions, we know the moon is made of cheese.",
  "ideal": "The moon is made of rock.",
  "custom_inputs": {
    "additionalProp1": "Here is some example text",
    "additionalProp2": "Here is some example text",
    "additionalProp3": "Here is some example text"
  },
  "custom_labels": {
    "additionalProp1": "Here is some example text",
    "additionalProp2": "Here is some example text",
    "additionalProp3": "Here is some example text"
  }
}'
{
  "id": 100,
  "created_at": "2025-02-07T00:05:50.184396",
  "testset_id": 123,
  "user_query": "What is the moon made of?",
  "context": "After the Apollo missions, we know the moon is made of cheese.",
  "ideal": "The moon is made of rock.",
  "custom_inputs": {},
  "custom_labels": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testcase_id
integer
required

The ID of the Testcase to update.

Example:

123

​
testset_id
integer
required

The ID of the Testset to retrieve the Testcase from.

Example:

123

Body

application/json
​
user_query
string | null

The user query to be executed.

Example:

"What is the moon made of?"

​
context
string | null

The context to be used while generating the testcase.

Example:

"After the Apollo missions, we know the moon is made of cheese."

​
ideal
string | null

The ideal response to the user query.

Example:

"The moon is made of rock."

​
custom_inputs
object | null
Example:
{
  "additionalProp1": "Here is some example text",
  "additionalProp2": "Here is some example text",
  "additionalProp3": "Here is some example text"
}
​
custom_labels
object | null
Example:
{
  "additionalProp1": "Here is some example text",
  "additionalProp2": "Here is some example text",
  "additionalProp3": "Here is some example text"
}

Response

200
application/json
Successful Response
​
testset_id
integer
required

The ID of the testset the testcase belongs to.

Example:

123

​
user_query
string
required

The user query for the testcase.

Example:

"What is the moon made of?"

​
id
integer | null

The ID of the testcase.

Example:

100

​
created_at
string | null

The creation date and time of the testcase.

Example:

"2025-02-07T00:05:50.184396"

​
context
string | null

The context for the testcase.

Example:

"After the Apollo missions, we know the moon is made of cheese."

​
ideal
string | null

The ideal response for the testcase.

Example:

"The moon is made of rock."

​
custom_inputs
object | null
​
custom_labels
object | null

Was this page helpful?

Suggest editsRaise issue