Deployments.ai Docs
Evaluations

Publish a new score definition revision

POST /v1/score-definitions/{scoreDefinitionId}/revisions · SDK reviseScoreDefinition · CLI deployments eval score-definition revise

POST
/v1/score-definitions/{scoreDefinitionId}/revisions

Requires observability:write.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

scoreDefinitionId*string

Score definition ID.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-organization*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Request Body

application/json
  1. body
evaluator*||||||||
sampling?
target?string
Value in"root-run""trace"
threshold?number
Range0 <= value <= 1
weight?number
Range0 < value <= 100
expectedRevision*integer
Range1 <= value <= 9007199254740991

Response Body

ScoreDefinitionResponse

application/json
  1. response
archivedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
currentRevision*integer
Range1 <= value <= 9007199254740991
description?string
Length1 <= length <= 500
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
name*string
Match^[a-z0-9][a-z0-9._-]{0,63}$
ownerPrincipalId*string
revision*
status*string
Value in"active""archived"
type*string
Value in"deterministic""human""imported""model-judged"
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*integer
Range0 <= value <= 9007199254740991
curl -X POST "https://example.com/v1/score-definitions/string/revisions" \  -H "x-deployments-organization: string" \  -H "x-deployments-project: string" \  -H "x-deployments-environment: string" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "evaluator": {      "kind": "contains"    },    "expectedRevision": 1  }'
{  "archivedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "currentRevision": 1,  "description": "string",  "id": "string",  "name": "string",  "ownerPrincipalId": "string",  "revision": {    "createdAt": "2019-08-24T14:15:22Z",    "evaluator": {      "caseSensitive": true,      "kind": "contains",      "mode": "all",      "values": [        "string"      ]    },    "evaluatorVersionHash": "string",    "judgeModelId": "string",    "judgePromptHash": "string",    "revision": 1,    "sampling": {      "rate": 0    },    "status": "active",    "supersededAt": "2019-08-24T14:15:22Z",    "target": "root-run",    "threshold": 0,    "weight": 1  },  "status": "active",  "type": "deterministic",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0}