文本審核增強版升級AIGC類文字檢測能力,支持對模型流式輸出文字進行自動拼接并審核。本文介紹文本審核服務的流式輸出文字審核功能。
使用場景
大語言模型應用支持通過流式輸出的方式盡快的將中間結果顯示在用戶界面上。以通義千問為例子,開發者可以通過參數控制流式輸出模式,具體參考文檔:API詳情。
當采用模型流式輸出的方式時,通常需要開發者拼接文字片段后作為文本審核服務的輸入內容,但這個方式存在明顯的缺點:
大語言模型容易生成較長內容的文字,拼接全部輸出文字后,內容長度有可能超過文本審核的輸入限制;
采用流式輸出的方式用戶端會更快看到模型生成內容片段,待全部內容輸出時潛在風險可能長時間暴露給用戶。
因此阿里云文本審核增強版提供了對模型流式輸出文字進行自動拼接并審核的功能。該功能既避免了由于內容過長導致文本審核輸入限制,也顯著降低潛在風險暴露給用戶的時間。
功能特性
使用場景 | 支持的文本審核服務 | 特性說明 |
大語言模型生成文字場景:采用模型流式輸出的模式,且開啟了增量輸出時,每次生成內容不包含已經輸出的部分。 | 服務名稱:大語言模型生成文字檢測 service:llm_response_moderation |
|
AIGC類文字場景:采用模型流式輸出的模式,且開啟了增量輸出時,每次生成內容不包含已經輸出的部分。 | 服務名稱:AIGC類文字檢測service:ai_art_detection |
|
費用說明
阿里云文本審核增強版默認的計費方式為按量后付費,即按照調用審核的文本次數計費,對使用流式輸出文字的場景下調用審核的文本次數會顯著增加。
因此我們建議采用機器審核QPS的預付費方式(最低 500QPS起),需要聯系商務開通和購買。
付費方式對比
以通義千問為例子,對比不同付費方式下,流式輸出文字場景的模型服務費用和文本審核費用:
選擇模型 | 模型使用說明 | 模型月度費用參考 |
qwen-turbo |
| 約 20.7 萬元 |
審核付費方式 | 審核使用說明 | 審核月度費用參考 |
按量后付費 |
| 約 9.72 萬元 |
按量后付費 |
| 約 3.88 萬元 |
按QPS預付費 |
| 約 3.33 萬元 |
按QPS預付費 |
| 約 1.67 萬元 |
按量后付費
當您開通文本審核增強版服務后,默認付費方式是按量后付費,且按照實際用量結算當日費用,不調用服務不收費。
審核類型 | 支持的業務場景(服務) | 計費單價 |
文本審核高級(text_advanced) | 大語言模型生成文字檢測:llm_response_moderation | 15元/萬次 |
文本審核通用(text_standard) | AIGC文字檢測: ai_art_detection | 7.5元/萬次 |
資源包抵扣
如果您的審核量較大,或有相對固定的審核需求,建議預先購買資源包的方式。購買資源包規格越大,享受的折扣越大,支持疊加購買和使用。更多內容,請參見購買內容審核增強版抵扣資源包。
該資源包用于內容審核增強版用量的抵扣,無法與內容安全流量包共享,具體的抵扣系數如下:
審核類型 | 支持的業務場景(服務) | 抵扣系數 |
文本審核高級(text_advanced) | 大語言模型生成文字檢測:llm_response_moderation | 抵扣系數為2,表示每成功調用一次接口,抵扣資源包的流量包容量規格2次。 例如購買的資源包的流量包容量規格為10次,當您成功調用1次接口,抵扣流量包容量規格2次,剩余8次。 |
文本審核通用(text_standard) | AIGC文字檢測: ai_art_detection | 抵扣系數為1,表示每成功調用一次接口,抵扣資源包的流量包容量規格1次。 例如購買的資源包的流量包容量規格為10次,當您成功調用1次接口,抵扣流量包容量規格1次,剩余9次。 |
接入指南
步驟一:開通服務
訪問開通服務,開通文本審核增強版服務。
開通文本增強版服務后,默認付費方式是按量后付費,且按照實際用量結算當日費用,不調用服務不收費。接口接入使用后系統會按使用量自動出賬,具體信息,請參見計費說明。您也可以購買按量抵扣資源包,資源包相較于后付費存在一定階梯折扣,適合使用量級可預期和較大的用戶。
步驟二:為RAM用戶授權
在接入SDK或者API之前,您需要為RAM用戶授權。您可以為阿里云賬號和RAM用戶創建一個訪問密鑰(AccessKey)。在調用阿里云API時您需要使用AccessKey完成身份驗證。獲取方式,請參見獲取AccessKey。
使用RAM管理員登錄RAM控制臺。
- 創建RAM用戶。
具體操作,請參見創建RAM用戶。
- 向RAM用戶授權系統策略權限:
AliyunYundunGreenWebFullAccess
。具體操作,請參見為RAM用戶授權。
完成以上配置后,您可以使用RAM用戶調用內容安全API。
步驟三:安裝并接入SDK
目前支持的接入地域如下,具體請參見文本審核增強版SDK及接入指南:
地域 | 外網接入地址 | 內網接入地址 |
華東2(上海) | green-cip.cn-shanghai.aliyuncs.com | green-cip-vpc.cn-shanghai.aliyuncs.com |
華北2(北京) | green-cip.cn-beijing.aliyuncs.com | green-cip-vpc.cn-beijing.aliyuncs.com |
華東1(杭州) | green-cip.cn-hangzhou.aliyuncs.com | green-cip-vpc.cn-hangzhou.aliyuncs.com |
華南1(深圳) | green-cip.cn-shenzhen.aliyuncs.com | green-cip-vpc.cn-shenzhen.aliyuncs.com |
西南1(成都) | green-cip.cn-chengdu.aliyuncs.com | 暫無 |
目前支持兩種審核服務類型,分別是大語言模型生成文字檢測(具體參考文本審核增強版PLUS服務API部分)和AIGC類文字檢測(文本審核增強版通用服務API部分)
文本審核增強版PLUS服務API
使用說明
業務接口:https://green-cip.{region}.aliyuncs.com
。
您可以調用該接口創建文本內容檢測任務。關于如何構造HTTP請求,請參見請求結構;您也可以直接選用已構造好的HTTP請求,更多信息,請參見文本審核增強版SDK及接入指南。
計費信息:
該接口為收費接口。僅對HTTP狀態碼為200的請求進行計量計費,產生其他錯誤碼時不會計費。關于計費方式,請參見計費說明。
QPS限制
本接口的單用戶QPS默認限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。如采用機器審核QPS的預付費方式,可根據業務峰值擴容,請聯系商務開通。
請求參數
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
Service | String | 是 | llm_response_moderation | 審核服務類型。取值:
|
ServiceParameters | JSONString | 是 | 審核服務需要的參數集。JSON字符串格式,關于每個字符串的描述,請參見表ServiceParameters。 |
表 1. ServiceParameters
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
content | String | 是 | 檢測內容 | 審核的文本內容,限定在600字以內。 |
sessionId | String | 否 | 10123**** | 會話ID,標記本次請求內容屬于同一段流式內容,文本審核引擎會自動拼接后進行審核,拼接文字片段后不超過 2000字的部分。 說明 使用 sessionId時不能夠同時傳入參數 accountId。 |
返回參數
名稱 | 類型 | 示例值 | 描述 |
Code | Integer | 200 | 狀態碼。更多信息,請參見Code說明。 |
Data | JSONObject | {"Result":[...]} | 審核結果數據,具體請參見Data。 |
Message | String | OK | 請求消息的響應消息。 |
RequestId | String | AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE**** | 請求ID。 |
表 2. Data
名稱 | 類型 | 示例值 | 描述 |
Result | JSONArray | 檢測的風險標簽、置信分等結果,具體請參見Result。 | |
Advice | JSONArray | [{"Answer":"這是標準回答"}] | 調用檢測服務llm_query_moderation時,如果輸入指令檢索并匹配特定知識庫,則返回標準回答,具體請參見Advice。 |
表 3. Result
名稱 | 類型 | 示例值 | 描述 |
Label | String | political_xxx | 文字內容檢測運算后返回的標簽,可能會檢出多個標簽和分值。支持的標簽請參見風險標簽部分。 |
Confidence | Float | 81.22 | 置信分值,0到100分,保留到小數點后2位。部分標簽無置信分。 |
Riskwords | String | AA,BB,CC | 檢測到的敏感詞,多個詞用逗號分隔,部分標簽不會返回敏感詞。 |
CustomizedHit | JSONArray | [{"LibName":"...","Keywords":"..."}] | 當命中自定義庫時,Label為customized,返回自定義庫名稱和自定義詞,具體參見CustomizedHit。 |
表 4. CustomizedHit
名稱 | 類型 | 示例值 | 描述 |
LibName | String | 自定義庫1 | 自定義庫名稱。 |
Keywords | String | 自定義詞1,自定義詞2 | 自定義詞,多個詞用逗號分隔。 |
表 5. Advice
名稱 | 類型 | 示例值 | 描述 |
Answer | String | 這是一條標準回答 | 在調用檢測服務時,支持返回代答內容:
|
HitLabel | String | political_xxx | 在文字內容檢測運算后返回的標簽中,取較高風險的標簽,支持的標簽請參見風險標簽。 |
HitLibName | String | 自定義代答庫001 | 自定義配置代答庫名稱。 |
示例
請求示例
{
"Service": "llm_response_moderation",
"ServiceParameters": {
"content": "流式輸出內容",
"sessionId": "10123****"
}
}
正常返回示例
{
"Code": 200,
"Data": {
"Advice": [
{
"HitLabel": "political_entity",
"Answer": "這是一條標準回答返回的示例。",
"HitLibName": "political_entity-001"
}
"Result": [
{
"Label": "political_entity",
"Confidence": 100.0,
"RiskWords": "詞A,詞B,詞C"
},
{
"Label": "political_figure",
"Confidence": 100.0,
"RiskWords": "詞A,詞B,詞C"
}
]
},
"Message": "OK",
"RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}
Code說明
Code | 狀態代碼 | 說明 |
200 | OK | 請求成功。 |
400 | BAD_REQUEST | 請求有誤。可能是請求參數不正確導致,請仔細檢查請求參數。 |
408 | PERMISSION_DENY | 可能是您的賬號未授權、賬號欠費、賬號未開通、賬號被禁等。 |
500 | GENERAL_ERROR | 錯誤。可能是服務端臨時出錯。建議重試,若持續返回該錯誤碼,請通過在線服務聯系我們。 |
581 | TIMEOUT | 超時。建議重試,若持續返回該錯誤碼,請通過在線服務聯系我們。 |
588 | EXCEED_QUOTA | 請求頻率超出配額。 |
文本審核增強版通用服務API
使用說明
業務接口:https://green-cip.{region}.aliyuncs.com
。
您可以調用該接口創建文本內容檢測任務。關于如何構造HTTP請求,請參見請求結構;您也可以直接選用已構造好的HTTP請求,更多信息,請參見文本審核增強版SDK及接入指南。
計費信息:
該接口為收費接口。僅對HTTP狀態碼為200的請求進行計量計費,產生其他錯誤碼時不會計費。關于計費方式,請參見計費說明。
QPS限制
本接口的單用戶QPS默認限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。如采用機器審核QPS的預付費方式,可根據業務峰值擴容,請聯系商務開通。
請求參數
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
Service | String | 是 | ai_art_detection | 審核服務類型。取值:
|
ServiceParameters | JSONString | 是 | 審核服務需要的參數集。JSON字符串格式,關于每個字符串的描述見下表。 |
表 1. ServiceParameters
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
content | String | 是 | 檢測內容 | 審核的文本內容,限定在600字以內。 |
sessionId | String | 否 | 10123**** | 會話ID,標記本次請求內容屬于同一段流式內容,文本審核引擎會自動拼接后進行審核,拼接文字片段后不超過 2000字的部分。 說明 使用 sessionId時不能夠同時傳入參數 accountId。 |
返回參數
名稱 | 類型 | 示例值 | 描述 |
Code | Integer | 200 | 狀態碼。更多信息,請參見Code說明。 |
Data | JSONObject | {"labels": "sexual_content","reason": "{\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務\"}"} | 審核結果數據,具體信息請參見Data。 |
Message | String | OK | 請求消息的響應消息。 |
RequestId | String | AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE**** | 請求ID。 |
表 2.Data
名稱 | 類型 | 示例值 | 描述 |
Labels | String | sexual_content | 標簽,多個用英文逗號分隔。包括:
說明 標簽會持續新增,建議業務對接過程對未知標簽忽略處理。 |
Reason | String | {\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務\"} | 原因定位的JSON字符串,包含以下字段:
|
示例
請求示例
{
"Service": "ai_art_detection",
"ServiceParameters": {
"content": "流式輸出內容",
"sessionId": "10123****"
}
}
正常返回示例
{
"Code": 200,
"Data": {
"labels": "sexual_content",
"reason": "{\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務\"}"
},
"Message": "OK",
"RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}
Code說明
Code | 狀態代碼 | 說明 |
200 | OK | 請求成功。 |
400 | BAD_REQUEST | 請求有誤。可能是請求參數不正確導致,請仔細檢查請求參數。 |
407 | NOT_SUPPORT | 無法識別或不支持該語種類型。 |
408 | PERMISSION_DENY | 可能是您的賬號未授權、賬號欠費、賬號未開通、賬號被禁等。 |
500 | GENERAL_ERROR | 錯誤。可能是服務端臨時出錯。建議重試,若持續返回該錯誤碼,請通過在線服務聯系我們。 |
581 | TIMEOUT | 超時。建議重試,若持續返回該錯誤碼,請通過在線服務聯系我們。 |
588 | EXCEED_QUOTA | 請求頻率超出配額。 |