カスタムテキストライブラリの DescribeKeywordLib API リファレンス - Content Moderation

このトピックでは、カスタムテキストライブラリのリストを取得するために使用される API オペレーションとパラメーターについて説明します。この API オペレーションを使用して、テキストスパム検出用のテキストライブラリを管理できます。この API 呼び出しによって取得される情報は、AI ガードレールコンソールに表示されるカスタムテキストライブラリと一致します。

注意事項

API オペレーション：DescribeKeywordLib

この API オペレーションを呼び出して、カスタムテキストライブラリのリストを取得できます。HTTP リクエストの作成方法については、「リクエスト構造」をご参照ください。また、ビルド済みの HTTP リクエストを使用することもできます。詳細については、「SDK の概要」をご参照ください。

課金：この API オペレーションは無料です。

QPS 制限

この操作は、アカウントごとに毎秒 10 回まで呼び出すことができます。1 秒あたりの呼び出し回数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が及ぶ可能性があります。この操作を呼び出す際は、制限に注意することを推奨します。

リクエストパラメーター

リクエストに含める必要がある共通リクエストパラメーターについては、「共通パラメーター」をご参照ください。

リクエストボディは構造体です。その構造を次の表に示します。

名前	タイプ	必須	例	説明
ServiceModule	String	はい	open_api	テキストライブラリの機能モジュールです。値を open_api に設定します。これは、ライブラリが AI ガードレール API で使用されることを示します。

返されるデータ

返される結果については、「レスポンスパラメーター」をご参照ください。

レスポンスボディの KeywordLibList フィールドは JSON 配列です。各要素には次のフィールドが含まれています。

名前	タイプ	例	説明
Id	Integer	2147	テキストライブラリの ID です。
ModifiedTime	String	2018-09-04 14:17:56 +0800	テキストライブラリが最後に変更された時間です。
Name	String	test1sdkdk	テキストライブラリの名前です。
Code	String	710001	テキストライブラリのコードです。説明 AI ガードレールコンソールでは、テキストライブラリコードは [機械審査] > [脅威検出ライブラリ] ページに表示されます。API オペレーションでは、テキストライブラリはその ID によって識別されます。
Count	String	3	テキストライブラリ内のテキストエントリの数です。
Category	String	BLACK	テキストライブラリのタイプです。有効な値： BLACK：このライブラリで一致が見つかった場合、検出されたテキストは迷惑メールと見なされます。テキストを削除または制限します。 WHITE：このライブラリで一致が見つかった場合、検出されたテキストは正常と見なされます。テキストは直接渡すことができます。 REVIEW：このライブラリで一致が見つかった場合、検出されたテキストには手動レビューが必要です。
Source	String	MANUAL	カスタムテキストライブラリのソースです。有効な値： MANUAL：手動で作成されたテキストライブラリです。 FEEDBACK：AI ガードレールによって自動的に作成されたテキストライブラリです。
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
&<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
}