API Documentation
...
Text
Text Recommendation (Alpha-release)
3 min
the below parameters are for text recommendation attack types to know more about the different attack input parameters see text recommendation docid\ rp8 2r2fwgpobf37lmgab the values presented below are examples used in the reference implementation it is important to customize these values to achieve the best performance for your particular model extraction { "use model api" "no", "model api details" "no", "model framework" "tensorflow", "encryption strategy" "0", "title" "\<text to get recommendation>" } 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 your model 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 z5ds opimhsxfewrtknkw language 401 code 401 unauthorized returns an error message if the provided api key or org id is invalid or expired customlabel id xjhl9zr5waz30f4gu2buz 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 exy7xhvpq ht16gzp2cna 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 exy7xhvpq ht16gzp2cna examples languages id uvpr8qrnc1hhhn9quoxg7 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 vcv7cmmwnkodxcznzkdaz 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 exsnyglulanuxx2kbno0c 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 z1glbsbw28gqg4d6hm6st 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 uvpr8qrnc1hhhn9quoxg7 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