擷取文本庫列表 - Content Moderation

本文提供了擷取已添加的自訂文本庫列表的具體介面及參數，協助您通過API介面自主管理您的文本庫。您通過API介面管理的文本庫可用於文本反垃圾檢測，該方式擷取的文本庫資訊與Alibaba Content Security Service控制台上的自訂文本庫一致。

使用說明

業務介面：DescribeKeywordLib

您可以調用該介面擷取自訂文本庫列表。關於如何構造HTTP請求，請參見請求結構；您也可以直接選用已構造好的HTTP請求，更多資訊，請參見SDK概覽。

計費資訊：該介面為免費介面。

QPS限制

本介面的單使用者QPS限制為10次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。

請求參數

關於在請求中必須包含的公用請求參數，請參見公用參數。

請求body是一個結構體，結構說明如下：

名稱	類型	是否必選	樣本值	描述
ServiceModule	String	是	open_api	文本庫所屬的功能模組，取值：open_api，表示用於內容檢測API功能的文本庫。

返回資料

關於返回結果說明，請參見返回結果。

返回body中的KeywordLibList欄位是JSON數組，每一個元素包含如下欄位：

名稱	類型	樣本值	描述
Id	Integer	2147	文本庫ID。
ModifiedTime	String	2018-09-04 14:17:56 +0800	文本庫最近一次修改時間。
Name	String	test1sdkdk	文本庫名稱。
Code	String	710001	文本庫Code。說明在控制台中機器審核 > 風險庫管理頁面顯示的文本庫Code，而在API介面中以文本庫ID標識文本庫。
Count	String	3	文本庫中添加的文本的數量。
Category	String	BLACK	文本庫類型，取值： BLACK：表示匹配命中該文本庫後，檢測的目標文本結果為違規文本，您需要直接刪除或限制公開該文本。 WHITE：表示匹配命中該文本庫後，檢測的目標文本結果為正常文本，可以直接允許存取。 REVIEW：表示匹配命中該文本庫後，檢測的目標文本需要執行人工審核。
Source	String	MANUAL	自訂的文本庫的來源，取值： MANUAL：手動建立的文本庫。 FEEDBACK：Alibaba Content Security Service自動建立的文本庫。
BizTypes	StringArray	["bizTypeA","bizTypeB"]	業務情境。更多資訊，請參見建立業務情境。
ResourceType	String	TEXT	文本庫類型，取值： TEXT：文字文本庫 IMAGE：圖片文本庫 VOICE：語音文本庫
LibType	String	textKeyword	各應用情境中的文本庫類型，取值：文本反垃圾情境 textKeyword：關鍵詞文本庫 similarText：相似文本庫圖片廣告情境 textKeyword：圖片關鍵詞文本庫語音反垃圾情境 voiceText：語音關鍵詞文本庫
MatchMode	String	fuzzy	待檢測文本與文本庫匹配的方式。取值： fuzzy：模糊比對 precise：精確匹配
Enable	Boolean	true	文本庫的狀態。 true：已啟用 false：已停用。說明如果您需要再次啟用已停用的文本庫，可以調用建立文本庫介面來修改文本庫的狀態。相關文檔，請參見修改文本庫。

樣本

請求樣本

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeKeywordLib&ServiceModule=open_api
&<公用請求參數>

返回樣本

{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "data": {
    "TotalCount": 11,
    "KeywordLibList": [
      {
        "Name": "test1sdkdk",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "TEXT",
        "Id": 2147,
        "ModifiedTime": "2018-09-04 14:17:56 +0800",
        "Code": "710001",
        "LibType": "textKeyword",
        "MatchMode":"fuzzy",
        "Enable":"true"
      },
      {
        "Name": "Test001",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "VOICE",
        "Id": 2693,
        "ModifiedTime": "2018-09-03 17:11:04 +0800",
        "Code": "932001",
        "LibType": "voiceText",
        "MatchMode":"fuzzy",
        "Enable":"true"
      }
    ]
  },
  "code": 200,
  "success": true
}