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: eJztV01v20YQ/SuLudQBaEl2Y6DhzS2CwoCNBk56KARBWe0OxY2Xu8x+qBEI/vdglrRJmkZbF8hNB0MyZ+dj33sz4jQQ+N5DvobrG9hkINELp+qgrIEc7vgDMs7ublntUCpBj1n0yuwZZ75GoQolWGUl6gVkYGt0nM7cSMhhj2GbTNveGTKoueMVBnSUsgHDK4S8+8hAUcqahxKe1/GpREaHmC1YKLHLyIJlVVfgqLq/VSipFodfo3IoIQ8uYgZelFhxyBsIx5qS+uCU2UPbbuiwr63x6Ml+uVrRx7SCD0OGiktkPgqB3hdR6yNkIKwJaAL58brWSiQYll88OTfz5Hb3BRMgQ5lr8IGH6CGDDrUeFRk7TLeVJ4JqRygH1dU6Ng7RlQm4R/cijEFVyAJ/QEP4CVvVGgMmVEconinDKqW18iiskf4NVaWMqmIF+arNAJ2zbluh93yPQ+r1I6wZmKj1XFFUQvJlvS9THaUEBPrACq40SmgnKMxY+28CiR4lK6x7drsh+AGdVx1Fr6i/95rnosCjNKOo3Dl+HAVVASeMmVjtEmGFdRUPkEOhLQ8UcJ5/xJNDH3XIWDjWSnCtj4wblpJRdSmGpyC9tGaypnCd7fE2o/qzGehoiP81fOzUDxn8yuV9xxxkcGMCOsP1eyKYrhlU0Dh0z8euiradWe77BqRa8RsnUaa+6cseJRyrAqrjdtIrz1iFi8UKppSsV4u3V9lqkf6uNtP2yi8uf25bKu/tSzPgxhy4VvJJqsEO/J9mwGkGnGbAD50BkzTPtAd/2cj2/ICsoveBHR+6ND/7t6nxbAR0E+Dq5QnQXY55dAd0vYqtENE5lExGwmgK32kqnKbCaSr8uKkwjTwfDH/Y2mep/r5nhY1amp8CG7aS104HUgmG0vZbTtprQgk5LA8Xy+Tslw25t8shSZe+23ui05BDGUKdL5faCq5L60P+y+rdaibgWzIziQfUtq7QhP4iC/abNYXaR4dp6WGfz88p4ucF0ErjUUSnwjHl47XaPiB935BNmcImifVQu2io+V/sHV8rgZINR7QSSHzkT+vbdc1FieeX6WVLSTRBFQrd1NJmMH4ve7e4TD1hfai4GQW7u2UfxkKbVNQM4/S1u2kv2IDfwrLWXKVeTzw0PXtrOFw8ioEEnPcCeKRwkwGxRAebZsc9/ul029LjrxFdAjeDA3eK7wjVdQNSefouIS+49vgPlzm776f9G/Y/dt0X79Y/5Iamy4HrSP9BBkkHHdrtps2gRC6JrHXTm66FwDqMnGa/W6Shpwb4/f0naNvvriGp8w==
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: eJztV01v20YQ/SuLudQBaEl2Y6DhzS2CwoCNBk56KARBWe0OxY2Xu8x+qBEI/vdglrRJmkZbF8hNB0MyZ+dj33sz4jQQ+N5DvobrG9hkINELp+qgrIEc7vgDMs7ublntUCpBj1n0yuwZZ75GoQolWGUl6gVkYGt0nM7cSMhhj2GbTNveGTKoueMVBnSUsgHDK4S8+8hAUcqahxKe1/GpREaHmC1YKLHLyIJlVVfgqLq/VSipFodfo3IoIQ8uYgZelFhxyBsIx5qS+uCU2UPbbuiwr63x6Ml+uVrRx7SCD0OGiktkPgqB3hdR6yNkIKwJaAL58brWSiQYll88OTfz5Hb3BRMgQ5lr8IGH6CGDDrUeFRk7TLeVJ4JqRygH1dU6Ng7RlQm4R/cijEFVyAJ/QEP4CVvVGgMmVEconinDKqW18iiskf4NVaWMqmIF+arNAJ2zbluh93yPQ+r1I6wZmKj1XFFUQvJlvS9THaUEBPrACq40SmgnKMxY+28CiR4lK6x7drsh+AGdVx1Fr6i/95rnosCjNKOo3Dl+HAVVASeMmVjtEmGFdRUPkEOhLQ8UcJ5/xJNDH3XIWDjWSnCtj4wblpJRdSmGpyC9tGaypnCd7fE2o/qzGehoiP81fOzUDxn8yuV9xxxkcGMCOsP1eyKYrhlU0Dh0z8euiradWe77BqRa8RsnUaa+6cseJRyrAqrjdtIrz1iFi8UKppSsV4u3V9lqkf6uNtP2yi8uf25bKu/tSzPgxhy4VvJJqsEO/J9mwGkGnGbAD50BkzTPtAd/2cj2/ICsoveBHR+6ND/7t6nxbAR0E+Dq5QnQXY55dAd0vYqtENE5lExGwmgK32kqnKbCaSr8uKkwjTwfDH/Y2mep/r5nhY1amp8CG7aS104HUgmG0vZbTtprQgk5LA8Xy+Tslw25t8shSZe+23ui05BDGUKdL5faCq5L60P+y+rdaibgWzIziQfUtq7QhP4iC/abNYXaR4dp6WGfz88p4ucF0ErjUUSnwjHl47XaPiB935BNmcImifVQu2io+V/sHV8rgZINR7QSSHzkT+vbdc1FieeX6WVLSTRBFQrd1NJmMH4ve7e4TD1hfai4GQW7u2UfxkKbVNQM4/S1u2kv2IDfwrLWXKVeTzw0PXtrOFw8ioEEnPcCeKRwkwGxRAebZsc9/ul029LjrxFdAjeDA3eK7wjVdQNSefouIS+49vgPlzm776f9G/Y/dt0X79Y/5Iamy4HrSP9BBkkHHdrtps2gRC6JrHXTm66FwDqMnGa/W6Shpwb4/f0naNvvriGp8w==
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