Skip to content

ModerationApi.md

Latest commit

 

History

History
280 lines (212 loc) · 9.46 KB

ModerationApi.md

File metadata and controls

280 lines (212 loc) · 9.46 KB
Raw

ModerationApi

All requests use the primary/backup domains configured by the caller.

Method HTTP request Description
batchAddProfanityWords POST /v4/profanity-word/batch/add Batch add profanity words
batchRemoveProfanityWords POST /v4/profanity-word/batch/remove Batch delete profanity words
listProfanityWords POST /v4/profanity-word/list List profanity words
removeProfanityWord POST /v4/profanity-word/remove Delete profanity word

batchAddProfanityWords

ProfanityWordBatchAddResponse batchAddProfanityWords(profanityWordBatchAddRequest)

Batch add profanity words

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.ModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    ModerationApi apiInstance = new ModerationApi(defaultClient);
    
    ProfanityWordBatchAddRequest profanityWordBatchAddRequest = new ProfanityWordBatchAddRequest(); // ProfanityWordBatchAddRequest | 
    try {
      ProfanityWordBatchAddResponse result = apiInstance.batchAddProfanityWords(profanityWordBatchAddRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ModerationApi#batchAddProfanityWords");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
profanityWordBatchAddRequest ProfanityWordBatchAddRequest

Return type

ProfanityWordBatchAddResponse

Authorization

NexconnSignature

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

batchRemoveProfanityWords

CodeOnlyResponse batchRemoveProfanityWords(profanityWordBatchDeleteRequest)

Batch delete profanity words

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.ModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    ModerationApi apiInstance = new ModerationApi(defaultClient);
    
    ProfanityWordBatchDeleteRequest profanityWordBatchDeleteRequest = new ProfanityWordBatchDeleteRequest(); // ProfanityWordBatchDeleteRequest | 
    try {
      CodeOnlyResponse result = apiInstance.batchRemoveProfanityWords(profanityWordBatchDeleteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ModerationApi#batchRemoveProfanityWords");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
profanityWordBatchDeleteRequest ProfanityWordBatchDeleteRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

listProfanityWords

ProfanityWordListResponse listProfanityWords(profanityWordListRequest)

List profanity words

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.ModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    ModerationApi apiInstance = new ModerationApi(defaultClient);
    
    ProfanityWordListRequest profanityWordListRequest = new ProfanityWordListRequest(); // ProfanityWordListRequest | 
    try {
      ProfanityWordListResponse result = apiInstance.listProfanityWords(profanityWordListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ModerationApi#listProfanityWords");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
profanityWordListRequest ProfanityWordListRequest

Return type

ProfanityWordListResponse

Authorization

NexconnSignature

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

removeProfanityWord

CodeOnlyResponse removeProfanityWord(profanityWordDeleteRequest)

Delete profanity word

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.ModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    ModerationApi apiInstance = new ModerationApi(defaultClient);
    
    ProfanityWordDeleteRequest profanityWordDeleteRequest = new ProfanityWordDeleteRequest(); // ProfanityWordDeleteRequest | 
    try {
      CodeOnlyResponse result = apiInstance.removeProfanityWord(profanityWordDeleteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ModerationApi#removeProfanityWord");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
profanityWordDeleteRequest ProfanityWordDeleteRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -