DescribeKeywordLib - Content Moderation - Alibaba Cloud ドキュメントセンター

カスタムテキストライブラリを照会します。テキストライブラリは、テキストのスパム対策に使用できます。APIオペレーションによって返されるカスタムテキストライブラリに関する情報は、Alibaba Cloudコンテンツモデレーションコンソールのカスタムテキストライブラリに関する情報と一致しています。

説明

操作：DescribeKeywordLib

この操作を呼び出して、カスタムテキストライブラリを照会できます。 HTTPリクエストの作成方法の詳細については、リクエスト構造をご参照ください。既存のHTTPリクエストを選択することもできます。詳細については、SDKの概要をご参照ください。

課金：この操作は無料です。

QPS制限

この操作は、アカウントごとに1秒あたり最大10回呼び出すことができます。1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。

リクエストパラメータ

すべてのコンテンツモデレーションAPIリクエストに含める必要がある共通リクエストパラメータの詳細については、共通パラメータをご参照ください。

次の表は、リクエストボディのパラメータを示しています。

パラメータ	タイプ	必須	例	説明
ServiceModule	String	はい	open_api	サービスモジュールの名前。open_api に設定します。 open_api の値は、コンテンツモデレーションAPIで使用されるテキストライブラリを照会することを示します。

レスポンスパラメータ

この操作が返す共通レスポンスパラメータの詳細については、共通レスポンスパラメータをご参照ください。

レスポンスボディの KeywordLibList パラメータは JSON 配列です。次の表は、JSON 配列の各要素に含まれるパラメータを示しています。

パラメータ	タイプ	例	説明
Id	Integer	2147	テキストライブラリの ID。
ModifiedTime	String	2018-09-04 14:17:56 +0800	テキストライブラリが最後に変更された時刻。
Name	String	test1sdkdk	テキストライブラリの名前。
Code	String	710001	テキストライブラリのコード。説明コンソールの左側のナビゲーションペインで、[機械監査] > [リスクライブラリ] を選択します。表示されるページで、テキストライブラリのコードを表示できます。コードはコンソールでテキストライブラリを識別するために使用されますが、ID は API 操作を呼び出すときにテキストライブラリを識別するために使用されます。
Count	String	3	テキストライブラリのテキストエントリの数。
Category	String	BLACK	テキストライブラリのカテゴリ。有効な値： BLACK：テキストがテキストライブラリのテキストエントリにヒットした場合、テキストに違反が含まれています。テキストを削除またはブロックできます。 WHITE：テキストがテキストライブラリのテキストエントリにヒットした場合、テキストは正常であり、それ以上の操作は必要ありません。 REVIEW：テキストがテキストライブラリのテキストエントリにヒットした場合、テキストは手動レビューが必要です。
Source	String	MANUAL	カスタムテキストライブラリがどのように作成されたかを示します。有効な値： MANUAL：テキストライブラリは手動で作成されました。 FEEDBACK：コンテンツモデレーションによってテキストライブラリが自動的に作成されました。
BizTypes	StringArray	["bizTypeA","bizTypeB"]	ビジネスシナリオ。詳細については、CreateBizTypeをご参照ください。
ResourceType	String	TEXT	テキストライブラリのカテゴリ。有効な値： TEXT：リテラルテキストライブラリ。 IMAGE：画像から抽出されたテキストが照合されるテキストライブラリ。 VOICE：音声から認識されたテキストが照合されるテキストライブラリ。
LibType	String	textKeyword	各モデレーションシナリオでのテキストライブラリのカテゴリ。有効な値：テキストスパム対策 textKeyword：テキスト内の用語が照合されるテキストライブラリ。 similarText：テキストパターンが照合されるテキストライブラリ。画像内の広告の検出 textKeyword：画像から抽出された用語が照合されるテキストライブラリ。音声スパム対策 voiceText：音声から変換された用語が照合されるテキストライブラリ。
MatchMode	String	fuzzy	マッチング方法。有効な値： fuzzy：あいまい一致 precise：完全一致
Enable	Boolean	true	テキストライブラリのステータス。 true：テキストライブラリは有効です。 false：テキストライブラリは無効です。説明無効になっているテキストライブラリを有効にするには、CreateKeywordLib 操作を呼び出してテキストライブラリのステータスを変更できます。詳細については、UpdateKeywordLibをご参照ください。

例

リクエスト例

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeKeywordLib&ServiceModule=open_api
&<Common request parameters>

正常なレスポンス例

{
  "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
}