Start an evaluation job
curl --request POST \
--url https://api.scale.com/v2/autoevals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"libraryName": "<string>",
"modelVersionConfig": "<string>",
"evaluationType": {
"chatCompletion": {
"solutions": 1,
"shots": 0,
"chainOfThought": false
}
},
"modelParams": {}
}
'import requests
url = "https://api.scale.com/v2/autoevals"
payload = {
"libraryName": "<string>",
"modelVersionConfig": "<string>",
"evaluationType": { "chatCompletion": {
"solutions": 1,
"shots": 0,
"chainOfThought": False
} },
"modelParams": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
libraryName: '<string>',
modelVersionConfig: '<string>',
evaluationType: {chatCompletion: {solutions: 1, shots: 0, chainOfThought: false}},
modelParams: {}
})
};
fetch('https://api.scale.com/v2/autoevals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scale.com/v2/autoevals"
payload := strings.NewReader("{\n \"libraryName\": \"<string>\",\n \"modelVersionConfig\": \"<string>\",\n \"evaluationType\": {\n \"chatCompletion\": {\n \"solutions\": 1,\n \"shots\": 0,\n \"chainOfThought\": false\n }\n },\n \"modelParams\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scale.com/v2/autoevals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"libraryName\": \"<string>\",\n \"modelVersionConfig\": \"<string>\",\n \"evaluationType\": {\n \"chatCompletion\": {\n \"solutions\": 1,\n \"shots\": 0,\n \"chainOfThought\": false\n }\n },\n \"modelParams\": {}\n}")
.asString();{
"jobId": "<string>",
"status": "Pending",
"libraryName": "<string>",
"libraryVersion": "<string>",
"evaluationOptions": {},
"modelVersionConfig": "<string>",
"modelParams": {},
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"status_code": 500,
"error": "Internal server error."
}Evaluation
Start an evaluation job
Submits an evaluation job for a model version config.
POST
/
v2
/
autoevals
Start an evaluation job
curl --request POST \
--url https://api.scale.com/v2/autoevals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"libraryName": "<string>",
"modelVersionConfig": "<string>",
"evaluationType": {
"chatCompletion": {
"solutions": 1,
"shots": 0,
"chainOfThought": false
}
},
"modelParams": {}
}
'import requests
url = "https://api.scale.com/v2/autoevals"
payload = {
"libraryName": "<string>",
"modelVersionConfig": "<string>",
"evaluationType": { "chatCompletion": {
"solutions": 1,
"shots": 0,
"chainOfThought": False
} },
"modelParams": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
libraryName: '<string>',
modelVersionConfig: '<string>',
evaluationType: {chatCompletion: {solutions: 1, shots: 0, chainOfThought: false}},
modelParams: {}
})
};
fetch('https://api.scale.com/v2/autoevals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scale.com/v2/autoevals"
payload := strings.NewReader("{\n \"libraryName\": \"<string>\",\n \"modelVersionConfig\": \"<string>\",\n \"evaluationType\": {\n \"chatCompletion\": {\n \"solutions\": 1,\n \"shots\": 0,\n \"chainOfThought\": false\n }\n },\n \"modelParams\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scale.com/v2/autoevals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"libraryName\": \"<string>\",\n \"modelVersionConfig\": \"<string>\",\n \"evaluationType\": {\n \"chatCompletion\": {\n \"solutions\": 1,\n \"shots\": 0,\n \"chainOfThought\": false\n }\n },\n \"modelParams\": {}\n}")
.asString();{
"jobId": "<string>",
"status": "Pending",
"libraryName": "<string>",
"libraryVersion": "<string>",
"evaluationOptions": {},
"modelVersionConfig": "<string>",
"modelParams": {},
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}{
"status_code": 500,
"error": "Internal server error."
}Authorizations
bearerAuthbasicAuth
Your API Key is the Bearer token. See the Authentication section to learn how to access your key.
Body
application/json
Response
Auto-evaluation job successfully started.
Unique identifier for the evaluation job.
Current job status.
Available options:
Pending, InProgress, Errored, Completed Name of the evaluation library.
Version of the evaluation library.
Options used for evaluation.
ID of the Model Version Config
Model params overrides.
Timestamp when the job was created.
Timestamp when the job was completed.

