Text Classification

3min
The below parameters are for text classification attack types. To know more about the different attack input parameters see Text Classification﻿﻿
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",
"number_of_classes": "2",
"attack_type": "blackbox",
"input_dimensions": "100",
"number_of_attack_queries": "20000",
"model_framework": "tensorflow",
"vulnerability_threshold": "0",
"defense_best_only": "no",
"encryption_strategy": = "1"
}
{
"use_model_api": "no",
"model_api_details": "no",
"number_of_classes": "2",
"attack_type": "blackbox",
"input_dimensions": "100",
"number_of_attack_queries": "20000",
"model_framework": "tensorflow",
"vulnerability_threshold": "0",
"defense_best_only": "no",
"encryption_strategy": = "1"
}
﻿
POST
Request
Path Params
model id
required
String
Enter your model
Header Parameters
Org_id
required
String
Enter your organization id
x-api-key
required
String
Enter your API key
Python
Curl
Node.js
JS
var myHeaders = new Headers();
myHeaders.append("x-api-key", "########################################");
myHeaders.append("Org-Id", "####################################################################################################");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    // << Enter Payload Details based on Task pair >>
});

var modelID = "<< Enter Model ID >>"

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.aws.boschaishield.com/prod/api/ais/v1.5/model_analyse/"+modelID+"", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
var myHeaders = new Headers();
myHeaders.append("x-api-key", "########################################");
myHeaders.append("Org-Id", "####################################################################################################");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    // << Enter Payload Details based on Task pair >>
});

var modelID = "<< Enter Model ID >>"

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.aws.boschaishield.com/prod/api/ais/v1.5/model_analyse/"+modelID+"", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
Responses
200
401
400
412
// 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)
// 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)
﻿
Note: In the response, copy job_id. This value is required to trigger the GET APIs. See <GET> Job Metadata﻿.

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 
﻿
﻿
﻿
Updated 20 Dec 2024
Did this page help you?
Text
Text Recommendation (Alpha-release)