blob: 53ae64fcf7d02f7ecc8ede8900bc3f9e63c8751d [file] [log] [blame]
(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{193:function(e,t,n){"use strict";n.d(t,"a",(function(){return u})),n.d(t,"b",(function(){return d}));var r=n(0),a=n.n(r);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function c(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?c(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):c(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=a.a.createContext({}),i=function(e){var t=a.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=i(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},m=a.a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=i(n),m=r,d=u["".concat(c,".").concat(m)]||u[m]||b[m]||o;return n?a.a.createElement(d,l(l({ref:t},p),{},{components:n})):a.a.createElement(d,l({ref:t},p))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,c=new Array(o);c[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,c[1]=l;for(var p=2;p<o;p++)c[p]=n[p];return a.a.createElement.apply(null,c)}return a.a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},94:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return c})),n.d(t,"metadata",(function(){return l})),n.d(t,"toc",(function(){return s})),n.d(t,"default",(function(){return i}));var r=n(3),a=n(7),o=(n(0),n(193)),c={title:"Serve REST API"},l={unversionedId:"api/serve",id:"api/serve",isDocsHomePage:!1,title:"Serve REST API",description:"\x3c!--",source:"@site/docs/api/serve.md",slug:"/api/serve",permalink:"/docs/next/api/serve",editUrl:"https://github.com/apache/submarine/edit/master/website/docs/api/serve.md",version:"current",sidebar:"api",previous:{title:"Notebook REST API",permalink:"/docs/next/api/notebook"}},s=[{value:"Create a model serve",id:"create-a-model-serve",children:[]},{value:"Delete the TensorFlow model serve",id:"delete-the-tensorflow-model-serve",children:[]}],p={toc:s};function i(e){var t=e.components,n=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(r.a)({},p,n,{components:t,mdxType:"MDXLayout"}),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"Note: The Serv API is in the alpha stage which is subjected to incompatible changes in future releases.")),Object(o.b)("h2",{id:"create-a-model-serve"},"Create a model serve"),Object(o.b)("p",null,Object(o.b)("inlineCode",{parentName:"p"},"POST /api/v1/serve")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Example Request")),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"Make sure there is a model named ",Object(o.b)("inlineCode",{parentName:"p"},"simple")," with version ",Object(o.b)("inlineCode",{parentName:"p"},"1")," in the database.")),Object(o.b)("pre",null,Object(o.b)("code",{parentName:"pre",className:"language-sh"},'curl -X POST -H "Content-Type: application/json" -d \'\n{\n "modelName": "simple", \n "modelVersion":1, \n}\n\' http://127.0.0.1:32080/api/v1/serve\n')),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Example Response:")),Object(o.b)("pre",null,Object(o.b)("code",{parentName:"pre",className:"language-json"},'{\n "status":"OK",\n "code":200,\n "success":true,\n "message":"Create a serve instance",\n "result":{"url":null},\n "attributes":{}\n}\n')),Object(o.b)("h2",{id:"delete-the-tensorflow-model-serve"},"Delete the TensorFlow model serve"),Object(o.b)("p",null,Object(o.b)("inlineCode",{parentName:"p"},"DELETE /api/v1/serve")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Example Request")),Object(o.b)("pre",null,Object(o.b)("code",{parentName:"pre",className:"language-sh"},'curl -X DELETE -H "Content-Type: application/json" -d \'\n{\n "modelName": "simple", \n "modelVersion":1,\n}\n\' http://127.0.0.1:32080/api/v1/serve\n')),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Example Response:")),Object(o.b)("pre",null,Object(o.b)("code",{parentName:"pre",className:"language-json"},'{\n "status":"OK",\n "code":200,\n "success":true,\n "message":"Delete the model serve instance",\n "result":null,\n "attributes":{}\n}\n')))}i.isMDXComponent=!0}}]);