1---
2id: post-eval
3title: "Run Eval"
4description: "Evaluate a model against a eval spice specification"
5sidebar_label: "Run Eval"
6hide_title: true
7hide_table_of_contents: true
8api: eJzVV1+P2zYM/yoCn1pMl1xy7bDzW1fcQ4GiK7Lry5Igp5OZWJ0tuZKca+D4uxe07NhOvLth2EvzEpmi+OdHiiJL8GLnIFrC3V6khfDKaAdrDjE6aVVO3xC1m8gEy0yMKRM7obTzTDDci5S5XElkLkeptkrWUoCDydHW6w8xRJAb5zfEDRxyYUWGHi2pLkGLDCEKfxwUacyFT+DcjE8iQ2a2zCdY6w32Mm+YLUihxW+FshhD5G2BHJxMMBMQleAPOWlw3iq9g6paB2Z0/ncTH4hjqOnzycBG+plO4CCN9qg9nRV5njZuT786ElBe6jaPX1H6C58+6LzwLB/oc15Yz4TuO0k2bI1lgu3UHnWIw2Tg9BJqIoUvtwS+V+jIgkAegYGDVz4l0qLQFGSoOOB3keVEPB1sSZvwXdHBIdY1weVGu6Bxfn19Cerd0BtXSInObYs0Pfx/eC4wt+hQe1eHrLUqYHeO6Bl8uVWZsIfN30gGeZXhRpq0yIgvFl44JH0BBA7OC184WkhjKZU5ZOitku4yAu3pixicm3+fINO9NG8OssJhXPtwlocUL2uN3WTonNhhp2HZqdBFml5ealJVn2XNWaYurtZWqBRjzoxP0D4ph+zhk9H4QHpbZ18MyTuWiZwcCidq/+o89wkqy6SxIUqx0jtGupGwFHGsSIBIPw+gbHTpIntECxy2xmbCQwSxKR5TJMsa7A9UL9x43v/DlRjDKFS8ZwLQT5sXJX7R6luBTMWovdoqtCNC69SsusTqhAprBeWm8piNeXau7aNynpBvJAUv1EU1q07Z/K8QCbwjlfgVTnYTzlYgDdULj/EK6DOkEa3Ry8lrqIa362WlKkPnRZYzpeO6Mugde0rw3BH2JByTFoXHmBkbcOxVOapAi0IvmqJwVu0GcQSSupnNb968PasFEcyv52+uZvOr2e39bB7dvIne/vpXr0REkB025/XivIh2iHdgwcVlppvby4Nls5ydqs6c7nXvJjb7UyFlYYU8QHQ9uX174h7Sb+pK7vG7n0q3p+MnNPpg8J73vPGL117w4AMfWM0bc3lj1kp3UPIx6HgHFx+AxE/IcL6C5QpWrX+0pMRqCXNarlfAV1D22E7uEi0g0T90sX1TrQBaSPJUKD0E5Zer/m/4NUY953hub0zcuIYRvpVmvd+R9aLHjqwXvx5P+7TQOtS4bq+54fV6EFwi1L+2ogSeJtTs+d9xaOZPg2aXv/Q1lsJH1uXwkQ2SmB3ZKY1b8PrCm1TlzWLOjqxcQZeZEWvzNrcolVNGN8Sb6qdBlHrG0DIkph0G6jnAJxDBdD+bEsZuWlJvUFF1Q7tvx4PCUvlMvM+j6TQ1UqSJcT767fr2+uKl+EjbLMY9pibPUHsWJE3Ye6O3aldYZE/KJ+zh6ookPkyAhgGHsrDKH2p9IlfhDViuaY860EU3LNxdtsfd66v01tTPWfPg2ELT5Rt/RWloilnHkiqJ9CpFp4noXS5kglfzCTnatQzDnYoDQRUEzya3k3ndlBjnM6F7whaFZndh/hoYU3at938c9JrHu1c1Kx6iVjYhXsKe3qw6yMAhqk1ac6BA0m5ZPgqHX2xaVUT+VqCt8eewF1YJ6usoMrFytI4h2orU4TOOvFo0ff1r9tLUOGp9229p6rbqnhQiAA6hN6jNr9YVhwRFTAFZls3W+2DC1T0J6I5ejDQVb0+8kxJz/yzvund1Pv/x5z1weGzmVgoTJZp4omFGPAUzTR4m+agMtBJSoXdF3VNAkEm/H4M1Ht8=
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Run Eval"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/evals/{name}"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Evaluate a model against a eval spice specification
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"name","in":"path","description":"Name of the evaluation to run","required":true,"schema":{"type":"string"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Parameters to run the evaluation","content":{"application/json":{"schema":{"type":"object","description":"Input parameters to start an evaluation run for a given model.","required":["model"],"properties":{"model":{"type":"string"}},"title":"RunEval"},"example":{"model":"example_model"}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Evaluation run successfully","content":{"application/json":{"schema":{"type":"object","description":"Represents the response for an evaluation run","required":["primary_key","time_column","dataset","model","status","scorers","metrics"],"properties":{"dataset":{"type":"string","description":"The name of the dataset used for the evaluation"},"error_message":{"type":["string","null"],"description":"The error message if the evaluation failed, otherwise `None`"},"metrics":{"type":"object","description":"A map of metric names to their corresponding values","additionalProperties":{"type":"number","format":"double"},"propertyNames":{"type":"string"}},"model":{"type":"string","description":"The model used for the evaluation"},"primary_key":{"type":"string","description":"Unique identifier for the evaluation run"},"scorers":{"type":"array","items":{"type":"string"},"description":"List of scorers used in the evaluation"},"status":{"type":"string","description":"The status of the evaluation (e.g., \"completed\", \"failed\", etc.)"},"time_column":{"type":"string","description":"Timestamp indicating when the evaluation was created or run"}},"title":"EvalRunResponse"},"example":{"primary_key":"eval_12345","time_column":"2024-12-19T12:34:56Z","dataset":"my_dataset","model":"example_model","status":"completed","error_message":null,"scorers":["scorer1","scorer2"],"metrics":{"scorer1/accuracy":0.95,"scorer2/accuracy":0.93}}},"text/csv":{"example":"primary_key,time_column,dataset,model,status,error_message,scorers,metrics\neval_12345,2024-12-19T12:34:56Z,my_dataset,example_model,completed,,\"[\"\"scorer1\"\", \"\"scorer2\"\"]\",\"{\"\"scorer1/accuracy\"\":0.95, \"\"scorer2/accuracy\"\":0.93}\""},"text/plain":{"example":"+-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | primary_key | time_column | dataset | model | status | error_message | scorers | metrics |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | eval_12345 | 2024-12-19T12:34:56Z| my_dataset| example_model | completed | | scorer1, scorer2 | {\"accuracy\": 0.95, \"precision\": 0.93} |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+"}}}}}
67>
68
69</StatusCodes>
70
71
72
1---
2id: post-eval
3title: "Run Eval"
4description: "Evaluate a model against a eval spice specification"
5sidebar_label: "Run Eval"
6hide_title: true
7hide_table_of_contents: true
8api: eJzVV1+P2zYM/yoCn1pMl1xy7bDzW1fcQ4GiK7Lry5Igp5OZWJ0tuZKca+D4uxe07NhOvLth2EvzEpmi+OdHiiJL8GLnIFrC3V6khfDKaAdrDjE6aVVO3xC1m8gEy0yMKRM7obTzTDDci5S5XElkLkeptkrWUoCDydHW6w8xRJAb5zfEDRxyYUWGHi2pLkGLDCEKfxwUacyFT+DcjE8iQ2a2zCdY6w32Mm+YLUihxW+FshhD5G2BHJxMMBMQleAPOWlw3iq9g6paB2Z0/ncTH4hjqOnzycBG+plO4CCN9qg9nRV5njZuT786ElBe6jaPX1H6C58+6LzwLB/oc15Yz4TuO0k2bI1lgu3UHnWIw2Tg9BJqIoUvtwS+V+jIgkAegYGDVz4l0qLQFGSoOOB3keVEPB1sSZvwXdHBIdY1weVGu6Bxfn19Cerd0BtXSInObYs0Pfx/eC4wt+hQe1eHrLUqYHeO6Bl8uVWZsIfN30gGeZXhRpq0yIgvFl44JH0BBA7OC184WkhjKZU5ZOitku4yAu3pixicm3+fINO9NG8OssJhXPtwlocUL2uN3WTonNhhp2HZqdBFml5ealJVn2XNWaYurtZWqBRjzoxP0D4ph+zhk9H4QHpbZ18MyTuWiZwcCidq/+o89wkqy6SxIUqx0jtGupGwFHGsSIBIPw+gbHTpIntECxy2xmbCQwSxKR5TJMsa7A9UL9x43v/DlRjDKFS8ZwLQT5sXJX7R6luBTMWovdoqtCNC69SsusTqhAprBeWm8piNeXau7aNynpBvJAUv1EU1q07Z/K8QCbwjlfgVTnYTzlYgDdULj/EK6DOkEa3Ry8lrqIa362WlKkPnRZYzpeO6Mugde0rw3BH2JByTFoXHmBkbcOxVOapAi0IvmqJwVu0GcQSSupnNb968PasFEcyv52+uZvOr2e39bB7dvIne/vpXr0REkB025/XivIh2iHdgwcVlppvby4Nls5ydqs6c7nXvJjb7UyFlYYU8QHQ9uX174h7Sb+pK7vG7n0q3p+MnNPpg8J73vPGL117w4AMfWM0bc3lj1kp3UPIx6HgHFx+AxE/IcL6C5QpWrX+0pMRqCXNarlfAV1D22E7uEi0g0T90sX1TrQBaSPJUKD0E5Zer/m/4NUY953hub0zcuIYRvpVmvd+R9aLHjqwXvx5P+7TQOtS4bq+54fV6EFwi1L+2ogSeJtTs+d9xaOZPg2aXv/Q1lsJH1uXwkQ2SmB3ZKY1b8PrCm1TlzWLOjqxcQZeZEWvzNrcolVNGN8Sb6qdBlHrG0DIkph0G6jnAJxDBdD+bEsZuWlJvUFF1Q7tvx4PCUvlMvM+j6TQ1UqSJcT767fr2+uKl+EjbLMY9pibPUHsWJE3Ye6O3aldYZE/KJ+zh6ookPkyAhgGHsrDKH2p9IlfhDViuaY860EU3LNxdtsfd66v01tTPWfPg2ELT5Rt/RWloilnHkiqJ9CpFp4noXS5kglfzCTnatQzDnYoDQRUEzya3k3ndlBjnM6F7whaFZndh/hoYU3at938c9JrHu1c1Kx6iVjYhXsKe3qw6yMAhqk1ac6BA0m5ZPgqHX2xaVUT+VqCt8eewF1YJ6usoMrFytI4h2orU4TOOvFo0ff1r9tLUOGp9229p6rbqnhQiAA6hN6jNr9YVhwRFTAFZls3W+2DC1T0J6I5ejDQVb0+8kxJz/yzvund1Pv/x5z1weGzmVgoTJZp4omFGPAUzTR4m+agMtBJSoXdF3VNAkEm/H4M1Ht8=
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Run Eval"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/evals/{name}"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Evaluate a model against a eval spice specification
41
42<Heading
43 id={"request"}
44 as={"h2"}
45 className={"openapi-tabs__heading"}
46 children={"Request"}
47>
48</Heading>
49
50<ParamsDetails
51 parameters={[{"name":"name","in":"path","description":"Name of the evaluation to run","required":true,"schema":{"type":"string"}}]}
52>
53
54</ParamsDetails>
55
56<RequestSchema
57 title={"Body"}
58 body={{"description":"Parameters to run the evaluation","content":{"application/json":{"schema":{"type":"object","description":"Input parameters to start an evaluation run for a given model.","required":["model"],"properties":{"model":{"type":"string"}},"title":"RunEval"},"example":{"model":"example_model"}}},"required":true}}
59>
60
61</RequestSchema>
62
63<StatusCodes
64 id={undefined}
65 label={undefined}
66 responses={{"200":{"description":"Evaluation run successfully","content":{"application/json":{"schema":{"type":"object","description":"Represents the response for an evaluation run","required":["primary_key","time_column","dataset","model","status","scorers","metrics"],"properties":{"dataset":{"type":"string","description":"The name of the dataset used for the evaluation"},"error_message":{"type":["string","null"],"description":"The error message if the evaluation failed, otherwise `None`"},"metrics":{"type":"object","description":"A map of metric names to their corresponding values","additionalProperties":{"type":"number","format":"double"},"propertyNames":{"type":"string"}},"model":{"type":"string","description":"The model used for the evaluation"},"primary_key":{"type":"string","description":"Unique identifier for the evaluation run"},"scorers":{"type":"array","items":{"type":"string"},"description":"List of scorers used in the evaluation"},"status":{"type":"string","description":"The status of the evaluation (e.g., \"completed\", \"failed\", etc.)"},"time_column":{"type":"string","description":"Timestamp indicating when the evaluation was created or run"}},"title":"EvalRunResponse"},"example":{"primary_key":"eval_12345","time_column":"2024-12-19T12:34:56Z","dataset":"my_dataset","model":"example_model","status":"completed","error_message":null,"scorers":["scorer1","scorer2"],"metrics":{"scorer1/accuracy":0.95,"scorer2/accuracy":0.93}}},"text/csv":{"example":"primary_key,time_column,dataset,model,status,error_message,scorers,metrics\neval_12345,2024-12-19T12:34:56Z,my_dataset,example_model,completed,,\"[\"\"scorer1\"\", \"\"scorer2\"\"]\",\"{\"\"scorer1/accuracy\"\":0.95, \"\"scorer2/accuracy\"\":0.93}\""},"text/plain":{"example":"+-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | primary_key | time_column | dataset | model | status | error_message | scorers | metrics |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+\n | eval_12345 | 2024-12-19T12:34:56Z| my_dataset| example_model | completed | | scorer1, scorer2 | {\"accuracy\": 0.95, \"precision\": 0.93} |\n +-------------+---------------------+-----------+---------------+-----------+----------------+------------------+---------------------------------------+"}}}}}
67>
68
69</StatusCodes>
70
71
72