Update Prompt Test Case

Modify an existing test case’s inputs, output, or metadata. Use to change ground truth output values or correct errors.

PATCH /api/v2/projects/{project_id}/prompt-datasets/{dataset_id}/test-cases/{test_case_id}

Update Prompt Test Case

cURL

curl --request PATCH \
  --url https://api.example.com/api/v2/projects/{project_id}/prompt-datasets/{dataset_id}/test-cases/{test_case_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": null,
  "output": null,
  "metadata": null,
  "history": null,
  "media_inputs": null
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inputs": {},
  "output": null,
  "output_message": {
    "content": [
      {
        "text": "<string>",
        "type": "text"
      }
    ],
    "role": "user"
  },
  "metadata": null,
  "media_inputs": null,
  "history": null
}

Authorizations

Authorization · string · header · required

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

Path Parameters

project_id · string · required

dataset_id · string · required

test_case_id · string · required

Body

application/json

inputs · Inputs · object | null

output · string | null

metadata · Metadata · object | null

Show child attributes

history · (UserMessage · object | SystemMessage · object | DeveloperMessage · object | AssistantMessage · object)[] | null

UserMessage

SystemMessage

DeveloperMessage

AssistantMessage

Show child attributes

media_inputs · Media Inputs · object | null

Show child attributes

Response

200 - application/json

PromptTestCaseResponse(test_case: shared.sqlalchemy.models.TestCase, media_inputs: Optional[dict[str, server.project_sessions.types.MediaInputBase64]])

id · string<uuid> · required

inputs · Inputs · object · required

output · string | null

output_message · UserMessageInfo · object

UserMessageInfo

SystemMessageInfo

DeveloperMessageInfo

AssistantMessageInfo

UserMessage

AssistantMessage

SystemMessage

DeveloperMessage

Show child attributes

metadata · Metadata · object | null

Show child attributes

media_inputs · Media Inputs · object | null

Show child attributes

history · (UserMessageInfo · object | SystemMessageInfo · object | DeveloperMessageInfo · object | AssistantMessageInfo · object | UserMessage · object | AssistantMessage · object | SystemMessage · object | DeveloperMessage · object)[] | null

UserMessageInfo

SystemMessageInfo

DeveloperMessageInfo

AssistantMessageInfo

UserMessage

AssistantMessage

SystemMessage

DeveloperMessage

Show child attributes