Update evaluation

PATCH

/api/v2/projects/:projectKey/evaluations/:id

PATCH

/api/v2/projects/:projectKey/evaluations/:id

$ curl -X PATCH https://app.launchdarkly.com/api/v2/projects/projectKey/evaluations/id \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "label": "label",
>   "messages": [
>     {
>       "content": "content",
>       "role": "role"
>     },
>     {
>       "content": "content",
>       "role": "role"
>     }
>   ],
>   "variables": {
>     "key": "variables"
>   },
>   "generationContext": {
>     "key": ""
>   },
>   "generationProvider": "generationProvider",
>   "generationModel": "generationModel",
>   "parameters": {
>     "key": ""
>   },
>   "criteria": [
>     {
>       "criterionType": "criterionType",
>       "options": {
>         "key": ""
>       }
>     },
>     {
>       "criterionType": "criterionType",
>       "options": {
>         "key": ""
>       }
>     }
>   ],
>   "evaluationProvider": "evaluationProvider",
>   "evaluationModel": "evaluationModel",
>   "state": "state",
>   "tools": [
>     {
>       "key": "key",
>       "version": 5
>     },
>     {
>       "key": "key",
>       "version": 5
>     }
>   ]
> }'

1 {
2   "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
3   "label": "label",
4   "messages": [
5     {
6       "content": "content",
7       "role": "role"
8     },
9     {
10       "content": "content",
11       "role": "role"
12     }
13   ],
14   "generationProvider": "generationProvider",
15   "generationModel": "generationModel",
16   "createdAt": 0,
17   "updatedAt": 6,
18   "variables": {
19     "key": "variables"
20   },
21   "generationContext": {
22     "key": ""
23   },
24   "archivedAt": 1,
25   "parameters": {
26     "key": ""
27   },
28   "criteria": [
29     {
30       "criterionType": "criterionType",
31       "options": {
32         "key": ""
33       }
34     },
35     {
36       "criterionType": "criterionType",
37       "options": {
38         "key": ""
39       }
40     }
41   ],
42   "evaluationProvider": "evaluationProvider",
43   "evaluationModel": "evaluationModel",
44   "tools": [
45     {
46       "key": "key",
47       "version": 5
48     },
49     {
50       "key": "key",
51       "version": 5
52     }
53   ]
54 }

Edit an existing evaluation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Any fields you omit will retain their previous values.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

idstringRequiredformat: "uuid"

Request

Evaluation fields to update

labelstringOptional

messageslist of objectsOptional

variablesmap from strings to stringsOptional

generationContextmap from strings to anyOptional

generationProviderstringOptional

generationModelstringOptional

parametersmap from strings to anyOptional

criterialist of objectsOptional

evaluationProviderstringOptional

evaluationModelstringOptional

statestringOptional

One of 'archived', 'active'

toolslist of objectsOptional

Response

Evaluation updated

idstringformat: "uuid"

labelstring

messageslist of objects

generationProviderstring

generationModelstring

createdAtlong

updatedAtlong

variablesmap from strings to stringsOptional

generationContextmap from strings to anyOptional

archivedAtlongOptional

parametersmap from strings to anyOptional

criterialist of objectsOptional

evaluationProviderstringOptional

evaluationModelstringOptional

toolslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error