Skip to main content
PATCH
/
systems
/
{systemId}
JavaScript
import Scorecard from 'scorecard-ai';  const client = new Scorecard({  apiKey: 'My API Key', });  const system = await client.systems.update('12345678-0a8b-4f66-b6f3-2ddcfa097257', {  productionVersionId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf3', });  console.log(system.id);
{  "id": "12345678-0a8b-4f66-b6f3-2ddcfa097257",  "name": "GPT-4 Turbo Chatbot",  "description": "Updated production chatbot powered by GPT-4 Turbo",  "productionVersion": {  "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf3",  "systemId": "12345678-0a8b-4f66-b6f3-2ddcfa097257",  "name": "Version 3 (with system prompt)",  "config": {  "temperature": 0.5,  "maxTokens": 1024,  "systemPrompt": "You are an extremely helpful assistant."  }  },  "versions": [  {  "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf3",  "name": "Version 3 (with system prompt)"  },  {  "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",  "name": "Version 2 (Low Temperature)"  },  {  "id": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf1",  "name": "Version 1 (High Temperature)"  }  ] }

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
systemId
string<uuid>
required

The ID of the system to update.

Example:

"12345678-0a8b-4f66-b6f3-2ddcfa097257"

Body

application/json
​
name
string

The name of the system. Unique within the project.

​
description
string
default:""

The description of the system.

​
productionVersionId
string<uuid>

The ID of the production version of the system.

Response

System updated successfully

A System Under Test (SUT).

Systems are templates - to run evaluations, pair them with a SystemVersion that provides specific parameter values.

​
id
string<uuid>
required

The ID of the system.

​
name
string
required

The name of the system. Unique within the project.

​
description
string
default:""
required

The description of the system.

​
productionVersion
object
required

The production version of the system.

​
versions
object[]
required

The versions of the system.

⌘I