1---
2id: get-model-predict
3title: "ML Prediction"
4description: "Make a ML prediction using a specific model."
5sidebar_label: "ML Prediction"
6hide_title: true
7hide_table_of_contents: true
8api: eJztV99v2zYQ/leIe1kKKP6RNcCmt2wohgAJVqTdw2AYLkOdLDYUqZJHr4ah/304SomkOFibAX3zQ2BHx/vB7/vurDsAyW2AfAVX17DOoMCgvG5IOws53MoHFFLc3ojGY6EVPxYxaLsVUoQGlS61ErUr0MwgA9egl3zmuoActkibZNr0zpBBI72skdBzygNYWSPk3UcGmlM2kip4XsfHCgUfEq4UVGGXUZATdVfgqLp/NFVci8cvUXssICcfMYOgKqwl5AegfcNJA3ltt9C2az4cGmcDBrZfLBb8Ma3g/ZChlgWKEJXCEMpozB4yUM4SWmI/2TRGqwTD/HNg58Nxcnf/GRMgQ5krCCQpBsigQ61HpYgdpps6MEGNZ5RJd7WOjUN0bQm36F+EkXSNguQDWsZPuboxSJhQHaF4pq2otTE6oHK2CG+4Km11HWvIF20G6L3zmxpDkFscUq8eYc3ARmOOFcUlJF/R+wrdUcpAYCBRSm2wgHaCwhFr3yeQGLAQpfPPbjcE36EPuqPoFfX3Xse5OPAozSiq9F7uR0E14YQxG+v7RFjpfC0JciiNk8QBj/OPePIYoqFM0L7RShqzF9KKlIyrSzECB+mldSRrDtfZHm8zqj87Ah0t87+CD536IYPfZHHXMQcZXFtCb6V5xwTzNUmTwaF7PnRVtO2R5a5vQK4Vv0oWZeqbvuxRwrEqoN5vJr3yjFVYzhYwpWS1mL29zBaz9He5nrZXvrz4uW25vLcvzYBru5NGF09SJTfwf5oBpxlwmgE/dAZM0jzTHvztotjKHYqa3wfu5dCl+dm3psazEdBNgMuXJ0B3ORHQ79D3KnZKRe+xEEVkjKbwnabCaSqcpsKPmwrTyMeD4U/XhCzV3/esctEU9icSw1by2unAKkGqXL/lpL2GKshhvlvOk3OYH9i9nQ9JuvTd3hO9gRwqoiafz41T0lQuUP7L4tfFkYBv2CwK3KFxTY2W+ovMxO/OlnobPaalR3w6P+eIn2bAK01AFb2mfconG715QP6+Zpu2pUsS66H20XLzv9g7odEKCzEcMVoh85E/rW9XjVQVnl+kly1doCVdavRTS5vB+L1suZwtzqMNJO9N4rZxgWppR2Fvb8T7seQmtR2GwfraLbWXLuFXmjdG6tT1iZFDz+MKdstHWbCU814Kj2SuM2C++ODhcC8D/uVN2/LjLxF9gjmDnfQ6XY4JKHTg7wXkpTQB/+MyZ3f93H8j/sfW++Ld+ofS8pzZSRP5P8ggKaJDu123GVQoC6ZtdehNV0phQyOno18wVtNTK/zx7iO07b/+bq2l
9sidebar_class_name: "get 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={"ML Prediction"}
27>
28</Heading>
29
30<MethodEndpoint
31  method={"get"}
32  path={"/v1/models/{name}/predict"}
33  context={"endpoint"}
34>
35  
36</MethodEndpoint>
37
38
39
40Make a ML prediction using a specific model.
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":"The name of the model to make a prediction with.","required":true,"schema":{"type":"string"}}]}
52>
53  
54</ParamsDetails>
55
56<RequestSchema
57  title={"Body"}
58  body={undefined}
59>
60  
61</RequestSchema>
62
63<StatusCodes
64  id={undefined}
65  label={undefined}
66  responses={{"200":{"description":"Prediction made successfully","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"Success","model_name":"my_model_name","model_version":"1.0","prediction":[0.45,0.5,0.55],"duration_ms":123}}}},"400":{"description":"Invalid request to the model","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"BadRequest","error_message":"You gave me a bad request :(","model_name":"my_model_name","duration_ms":12}}}},"500":{"description":"Internal server error occurred during prediction","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"InternalError","error_message":"Oops, the server couldn't predict","model_name":"my_model_name","duration_ms":12}}}}}}
67>
68  
69</StatusCodes>
70
71
72      

1---
2id: get-model-predict
3title: "ML Prediction"
4description: "Make a ML prediction using a specific model."
5sidebar_label: "ML Prediction"
6hide_title: true
7hide_table_of_contents: true
8api: eJztV99v2zYQ/leIe1kKKP6RNcCmt2wohgAJVqTdw2AYLkOdLDYUqZJHr4ah/304SomkOFibAX3zQ2BHx/vB7/vurDsAyW2AfAVX17DOoMCgvG5IOws53MoHFFLc3ojGY6EVPxYxaLsVUoQGlS61ErUr0MwgA9egl3zmuoActkibZNr0zpBBI72skdBzygNYWSPk3UcGmlM2kip4XsfHCgUfEq4UVGGXUZATdVfgqLp/NFVci8cvUXssICcfMYOgKqwl5AegfcNJA3ltt9C2az4cGmcDBrZfLBb8Ma3g/ZChlgWKEJXCEMpozB4yUM4SWmI/2TRGqwTD/HNg58Nxcnf/GRMgQ5krCCQpBsigQ61HpYgdpps6MEGNZ5RJd7WOjUN0bQm36F+EkXSNguQDWsZPuboxSJhQHaF4pq2otTE6oHK2CG+4Km11HWvIF20G6L3zmxpDkFscUq8eYc3ARmOOFcUlJF/R+wrdUcpAYCBRSm2wgHaCwhFr3yeQGLAQpfPPbjcE36EPuqPoFfX3Xse5OPAozSiq9F7uR0E14YQxG+v7RFjpfC0JciiNk8QBj/OPePIYoqFM0L7RShqzF9KKlIyrSzECB+mldSRrDtfZHm8zqj87Ah0t87+CD536IYPfZHHXMQcZXFtCb6V5xwTzNUmTwaF7PnRVtO2R5a5vQK4Vv0oWZeqbvuxRwrEqoN5vJr3yjFVYzhYwpWS1mL29zBaz9He5nrZXvrz4uW25vLcvzYBru5NGF09SJTfwf5oBpxlwmgE/dAZM0jzTHvztotjKHYqa3wfu5dCl+dm3psazEdBNgMuXJ0B3ORHQ79D3KnZKRe+xEEVkjKbwnabCaSqcpsKPmwrTyMeD4U/XhCzV3/esctEU9icSw1by2unAKkGqXL/lpL2GKshhvlvOk3OYH9i9nQ9JuvTd3hO9gRwqoiafz41T0lQuUP7L4tfFkYBv2CwK3KFxTY2W+ovMxO/OlnobPaalR3w6P+eIn2bAK01AFb2mfconG715QP6+Zpu2pUsS66H20XLzv9g7odEKCzEcMVoh85E/rW9XjVQVnl+kly1doCVdavRTS5vB+L1suZwtzqMNJO9N4rZxgWppR2Fvb8T7seQmtR2GwfraLbWXLuFXmjdG6tT1iZFDz+MKdstHWbCU814Kj2SuM2C++ODhcC8D/uVN2/LjLxF9gjmDnfQ6XY4JKHTg7wXkpTQB/+MyZ3f93H8j/sfW++Ld+ofS8pzZSRP5P8ggKaJDu123GVQoC6ZtdehNV0phQyOno18wVtNTK/zx7iO07b/+bq2l
9sidebar_class_name: "get 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={"ML Prediction"}
27>
28</Heading>
29
30<MethodEndpoint
31  method={"get"}
32  path={"/v1/models/{name}/predict"}
33  context={"endpoint"}
34>
35  
36</MethodEndpoint>
37
38
39
40Make a ML prediction using a specific model.
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":"The name of the model to make a prediction with.","required":true,"schema":{"type":"string"}}]}
52>
53  
54</ParamsDetails>
55
56<RequestSchema
57  title={"Body"}
58  body={undefined}
59>
60  
61</RequestSchema>
62
63<StatusCodes
64  id={undefined}
65  label={undefined}
66  responses={{"200":{"description":"Prediction made successfully","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"Success","model_name":"my_model_name","model_version":"1.0","prediction":[0.45,0.5,0.55],"duration_ms":123}}}},"400":{"description":"Invalid request to the model","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"BadRequest","error_message":"You gave me a bad request :(","model_name":"my_model_name","duration_ms":12}}}},"500":{"description":"Internal server error occurred during prediction","content":{"application/json":{"schema":{"type":"object","required":["status","model_name","duration_ms"],"properties":{"duration_ms":{"type":"integer","description":"The time taken to complete the prediction (in milliseconds)","minimum":0},"error_message":{"type":["string","null"],"description":"The error message if the request failed"},"model_name":{"type":"string","description":"The name of the model used for the prediction"},"model_version":{"type":["string","null"],"description":"The version of the model used"},"prediction":{"type":["array","null"],"items":{"type":"number","format":"float"},"description":"The prediction result, typically an array of floats"},"status":{"description":"The status of the prediction","type":"string","enum":["Success","BadRequest","InternalError"],"title":"PredictStatus"}},"title":"PredictResponse"},"example":{"status":"InternalError","error_message":"Oops, the server couldn't predict","model_name":"my_model_name","duration_ms":12}}}}}}
67>
68  
69</StatusCodes>
70
71
72