建立文本庫 - Content Moderation

本文提供了建立自訂文本庫的具體介面及參數，協助您通過API介面自主管理您的文本庫。您通過API介面管理的文本庫可用於文本反垃圾檢測，該方式與內容控制台上的自訂文本庫功能完全一致。

使用說明

業務介面：CreateKeywordLib

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

文本庫適用於以下檢測情境：

文本反垃圾：識別文本中包含的違規內容。
圖文違規檢測：識別圖片中包含的廣告和文字違規內容。
語音反垃圾：識別語音中包含的違規內容。

您還可以通過控制台操作建立文本庫。更多資訊，請參見建立和管理自訂文本庫。

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

QPS限制

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

請求參數

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

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

名稱	類型	是否必須	樣本值	描述
ServiceModule	String	是	open_api	服務模組名稱，取值：open_api。
Name	String	是	test1sdkdk	文本庫名稱。
ResourceType	String	是	TEXT	文本庫應用的檢測情境類型，取值： TEXT：文本反垃圾 IMAGE：圖文違規檢測 VOICE：語音反垃圾
BizTypes	StringArray	否	["bizTypeA","bizTypeB"]	業務情境。更多資訊，請參見建立業務情境。
Category	String	是	BLACK	文本庫類型，取值： BLACK：風險名單 WHITE：可信名單 REVIEW：疑似名單
LibType	String	是	textKeyword	各應用情境中的文本庫類型，取值：文本反垃圾 textKeyword：關鍵詞文本庫 similarText：相似文本庫圖文違規識別 textKeyword：圖片關鍵詞文本庫語音反垃圾 voiceText：語音關鍵詞文本庫
MatchMode	String	否	fuzzy	匹配方式。取值： fuzzy：模糊比對 precise：精確匹配
Enable	Boolean	否	true	是否啟用文本庫。 true（預設）：啟用 false：停用

返回資料

返回結果說明，參見返回結果。

名稱	類型	樣本值	描述
code	Integer	200	錯誤碼，和HTTP狀態代碼一致。更多資訊，請參見公用錯誤碼。
msg	String	OK	請求資訊的響應訊息。
requestId	String	795D8871-4889-4C0F-A8B1-C7D2B990FF61	唯一標識該請求的ID，可用於定位問題。
id	String	123	唯一標識一個文本庫的ID，可以用於後續對文本庫中的內容進行操作。

樣本

請求樣本

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=CreateKeywordLib&ServiceModule=open_api
&<公用請求參數>
{
  "Name": "test1sdkdk",
  "BizTypes": [],
  "Category": "BLACK",
  "ServiceModule": "open_api",
  "ResourceType": "TEXT",
  "LibType": "textKeyword"
}

返回樣本

{
 "RequestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
 "code": 200,
 "Id": "123"
}