テキストをモデレートします。この操作を呼び出して、指定されたテキストに、ポルノコンテンツ、広告違反、スパム、政治的コンテンツ、虐待などの望ましくないコンテンツが含まれているかどうかを検出できます。
使用方法
操作: /green/text/scan
この操作を呼び出して、テキストモデレーションタスクを送信できます。 HTTPリクエストを構成する方法の詳細については、リクエスト構造をご参照ください。既存のHTTPリクエストを選択することもできます。詳細については、SDKの概要をご参照ください。
課金:
この操作の呼び出しには料金が発生します。課金方法の詳細については、をご確認ください。
QPS制限
この操作は、アカウントごとに1秒あたり最大100回呼び出すことができます。1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| bizType | String | いいえ | default | ビジネスシナリオ。 でビジネスシナリオを作成できます。 Content Moderation コンソール。詳細については、「機械支援モデレーションのポリシーのカスタマイズ」をご参照ください。 |
| scenes | StringArray | はい | ["antispam"] | モデレーションシナリオ。値を antispam に設定します。これはテキストモデレーションを示します。 |
| tasks | JSONArray | はい | モデレート対象オブジェクトのリスト。JSON配列には最大100個の要素を含めることができます。各要素は構造体です。つまり、一度に最大100個のテキストエントリを送信できます。一度に100個を超えるテキストエントリを送信する必要がある場合は、アカウントマネージャーに連絡して同時実行制限の増加を申請してください。構造体の詳細については、task をご参照ください。 |
| パラメーター | タイプ | 必須 | 例 | 説明 |
| clientInfo | JSONObject | いいえ | クライアントに関する情報。共通パラメーターの「共通リクエストパラメーター」セクションをご参照ください。 サーバーは、グローバル clientInfo パラメーターを使用するか、この表で説明されている clientInfo パラメーターを使用するかを決定します。 説明 この表の clientInfo パラメーターは、グローバル clientInfo パラメーターよりも優先されます。 | |
| dataId | String | いいえ | cfd33235-71a4-468b-8137-a5ffe323**** | モデレート対象オブジェクトの ID。 ID には、文字、数字、アンダースコア (_)、ハイフン (-)、およびピリオド (.) を使用できます。最大128文字まで使用できます。この ID は、ビジネスデータを一意に識別します。 |
| content | String | はい | We are a micro-lending company that provides an unsecured loan on the same day with reliable, fast, convenient, and door-to-door services when you apply for a loan on your mobile phone. | モデレートするテキスト。各テキストエントリは、句読点を含め、最大 10,000 文字まで入力できます。 |
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、一般的なエラーコードをご参照ください。 |
| msg | String | OK | リクエストに対して返されるメッセージ。 |
| dataId | String | cfd33235-71a4-468b-8137-a5ffe323**** | モデレート対象オブジェクトの ID。 説明 モデレーションリクエストで dataId パラメーターを設定した場合、dataId リクエストパラメーターの値がここに返されます。 |
| taskId | String | txt6HB8NQoEbU@5fosnj2xVEM-1t**** | モデレーションタスクの ID。 |
| content | String | We are a micro-lending company that provides an unsecured loan on the same day with reliable, fast, convenient, and door-to-door services when you apply for a loan on your mobile phone. | モデレーションリクエストで指定したテキスト。 |
| filteredContent | String | We are a **** company that provides an *** loan on the same day with reliable, fast, convenient, and **** services when you apply for a loan on your mobile phone. | 元のコンテンツがカスタム用語ライブラリの用語にヒットした場合に返されるテキスト。用語はアスタリスク (*) に置き換えられます。 CreateKeywordLib 操作を呼び出すか、内容安全控制台[コンテンツモデレーションコンソール]で用語をカスタマイズできます。詳細については、カスタムテキストライブラリの管理とCreateKeywordLibをご参照ください。 |
| results | JSONArray | モデレーション結果。呼び出しが成功すると、HTTPステータスコード 200 とモデレーション結果が返されます。モデレーション結果の配列には、1つ以上の要素が含まれています。各要素は構造体です。各要素の構造体の詳細については、result をご参照ください。 |
| パラメーター | タイプ | 例 | 説明 |
| scene | String | antispam | モデレーションリクエストで指定したモデレーションシナリオ。 |
| suggestion | String | block | 推奨される後続操作。有効な値:
|
| label | String | porn | モデレートされたテキストのモデレーション結果のカテゴリ。有効な値:
|
| rate | Float | 99.91 | 信頼レベルのスコア。有効な値:0 から 100。値が大きいほど、信頼レベルが高いことを示します。 suggestion パラメーターに pass の値が返された場合、信頼レベルが高いほど、コンテンツが正常である可能性が高くなります。提案レビューブロックsuggestion パラメーターに または の値が返された場合、信頼レベルが高いほど、コンテンツに違反が含まれている可能性が高くなります。 重要 suggestion、label、および sublabel パラメーターに返される値を使用して、コンテンツに違反が含まれているかどうかを判断することをお勧めします。 sublabel パラメーターは、特定の操作によって返されます。 |
| extras | JSONObject | {"userId":"xxx"} | 追加情報。これは拡張パラメーターです。 |
| details | JSONArray | モデレートされたテキストでヒットした危険なコンテンツの詳細。1 つのテキストエントリで複数の危険なコンテンツにヒットする可能性があります。構造体の詳細については、detail をご参照ください。 |
| パラメーター | タイプ | 例 | 説明 |
| label | String | porn | モデレートされたテキストでヒットした危険なコンテンツのカテゴリ。有効な値:
|
| contexts | JSONArray | モデレートされたテキストでヒットした危険なコンテンツのコンテキスト情報。構造体の詳細については、context をご参照ください。 |
| パラメーター | タイプ | 例 | 説明 |
| context | String | door-to-door | モデレートされたテキストでヒットした用語。テキストが用語にヒットした場合、その用語が返されます。テキストがアルゴリズムモデルにヒットした場合、このパラメーターは返されません。 |
| positions | JSONArray | [{"startPos":1, "endPos":10}] | 元のテキストで、モデレートされたテキストがヒットした用語の位置。 |
| libName | String | Name of your custom text library | カスタムテキストライブラリの名前。モデレートされたテキストがカスタムテキストライブラリの用語にヒットした場合、このパラメーターが返されます。 |
| libCode | String | 123456 | カスタムテキストライブラリのコード。モデレートされたテキストがカスタムテキストライブラリの用語にヒットした場合、このパラメーターが返されます。 |
| ruleType | String | ip | 動作ルール。モデレートされたテキストが動作ルールにヒットした場合、このパラメーターが返されます。有効な値:
|
例
http(s)://[Endpoint]/green/text/scan
&<共通リクエストパラメーター>
{
"scenes": [
"antispam"
],
"tasks": [
{
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
..."content": "We are a micro-lending company that provides an unsecured loan on the same day with reliable, fast, convenient, and door-to-door services when you apply for a loan on your mobile phone." // モデレートするテキスト
}
]
}{
"code": 200,
"data": [
{
"code": 200,
"content": "We are a micro-lending company that provides an unsecured loan on the same day with reliable, fast, convenient, and door-to-door services when you apply for a loan on your mobile phone.", // モデレートするテキスト
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****", // モデレート対象オブジェクトのID
"filteredContent": "We are a **** company that provides an *** loan on the same day with reliable, fast, convenient, and **** services when you apply for a loan on your mobile phone.", // カスタム用語ライブラリの用語にヒットした場合に返されるテキスト。用語はアスタリスク (*) に置き換えられます
"msg": "OK",
"results": [
{
"details": [
{
"contexts": [
{
"context": "unsecured", // モデレートされたテキストでヒットした用語
"positions": [
{
"endPos": 19, // 用語の終了位置
"startPos": 16 // 用語の開始位置
}
]
},
{
"context": "micro-lending", // モデレートされたテキストでヒットした用語
"positions": [
{
"endPos": 6, // 用語の終了位置
"startPos": 2 // 用語の開始位置
}
]
}
],
"label": "spam" // 危険なコンテンツのカテゴリ
},
{
"contexts": [
{
"context": "door-to-door", // モデレートされたテキストでヒットした用語
"libCode": "123456", // カスタムテキストライブラリのコード
"libName": "Name of your custom text library", // カスタムテキストライブラリの名前
"positions": [
{
"endPos": 34, // 用語の終了位置
"startPos": 30 // 用語の開始位置
}
]
}
],
"label": "porn" // 危険なコンテンツのカテゴリ
}
],
"label": "porn", // モデレーション結果のカテゴリ
"rate": 99.91, // 信頼レベルのスコア
"scene": "antispam", // モデレーションシナリオ
"suggestion": "block" // 推奨される後続操作
}
],
"taskId": "txt6HB8NQoEbU@5fosnj2xVEM-1t****" // モデレーションタスクのID
}
],
"msg": "OK",
"requestId": "25711794-BF6D-4F32-A735-09CA21197D32"
}