API Documentation
...
Tabular
Tabular Classification
3 min
the below parameters are for various tabular classification attack types to know more about the different attack input parameters see tabular classification docid\ mvtlctnkashpx9mzjvb62 the values presented below are examples taken from the model used in the reference implementation it is important to customize these values to achieve the best performance for your particular model extraction { "attack type" "blackbox", "categorical columns info" "job,marital,education,default,housing,loan,contact,poutcome", "defense bestonly" "no", "encryption strategy" "0", "input dimensions" "100,18", "is category columns" "yes", "model api details" "na", "model framework" "scikit learn", "normalize data" "yes", "number of attack queries" "10000", "number of classes" "2", "use model api" "no", "vulnerability threshold" "0 00" } evasion { "categorical columns info" "job,marital,education,default,housing,loan,contact,poutcome", "defense bestonly" "no", "encryption strategy" "1", "input dimensions" "41188,18", "is category columns" "yes", "model api details" "na", "model framework" "scikit learn", "normalize data" "yes", "number of classes" "2", "use model api" "no" } tab examples url https api aws boschaishield com prod api ais v1 5 model analyse name model anaylsis method post request pathparameters name model id kind required type string description enter you model id children queryparameters headerparameters kind required name org id type string children description enter your organization id kind required name x api key type string children description enter your api key bodydataparameters formdataparameters results languages id dl4hdcclth6dutou opbd code 200 ok returns a json object containing unique model id and urls to upload required files language 200 customlabel id fhrzsmfhkporakuqs5nwk language 401 code 401 unauthorized returns an error message if the provided api key or org id is invalid or expired customlabel id ipx3tlcetwtoozemy0zqi language 400 code 400 bad request error returns an error message if the application cannot or will not process the request due to something that is perceived to be a client error for example malformed request syntax invalid request message framing etc customlabel id x 4ris1xptvjjnqhgoyxk language 412 code 412 precondition failed returns an error message if access to the target resource has been denied for example if any of the parameter value is incorrect or license has expired customlabel selectedlanguageid x 4ris1xptvjjnqhgoyxk examples languages id oq j7 jc68hxvp4dp5sli language python code import requests n nmodelid enter model id nurl https api aws boschaishield com prod api ais v1 5 model analyse modelid n n please select proper payload for your usecase for extraction evasion or poisoning npayload n enter payload data n nheaders n accept application json n x api key n org id n n nresponse requests request post url headers headers data payload n nprint response text customlabel id 2j4hww7ylszm8ia5 oe4p language curl code modelid enter model id ncurl location https api aws boschaishield com prod api ais v1 5 model analyse modelid n header x api key n header org id n header content type application json n data n enter payload data n customlabel id klrzkt zqhtfs8eom28jy language nodejs code var request require request ; n nmodelid enter model id nvar options n method post n url https api aws boschaishield com prod api ais v1 5 model analyse modelid n headers n x api key n org id n content type application json n n body json stringify n enter task pair based payload n n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id xehjjl ehgrpasijzxvyj language javascript code var myheaders new headers ; nmyheaders append x api key ; nmyheaders append org id ; nmyheaders append content type application json ; n nvar raw json stringify n enter payload details based on task pair n ; n nvar modelid enter model id n nvar requestoptions n method post n headers myheaders n body raw n redirect follow n ; n nfetch https api aws boschaishield com prod api ais v1 5 model analyse modelid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel selectedlanguageid xehjjl ehgrpasijzxvyj description currentnewparameter label path parameter value pathparameters note in the response, copy job id this value is required to trigger the get apis see \<get> job metadata docid\ s mz7r0hnzicdqy6q 6hq the "job id" is used to retrieve model analysis metadata and check the processing status of the request it is also used for generating reports for the analyzed model copy the dashboard link from the response and open it in a new tab this allows users to monitor the job progress and download reports for using nodejs sample code, install npm package request given ample code for python is tested for python version 3 7 given sample code for nodejs and javascript is tested for node v20lts