CLI集成示例
本文以調(diào)用內(nèi)容安全(Content Moderation)TextModeration
接口審核文本內(nèi)容為例,為您介紹使用阿里云CLI調(diào)用內(nèi)容安全增強(qiáng)版OpenAPI的操作步驟。
前置概念
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構(gòu)建的通用命令行工具,您可以通過阿里云CLI實現(xiàn)自動化管理和維護(hù)內(nèi)容安全增強(qiáng)版。更多信息,請參見什么是阿里云CLI。
暫不支持使用阿里云CLI調(diào)用OSS違規(guī)檢測普惠版。
步驟一:安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統(tǒng)下的安裝服務(wù),請根據(jù)您使用設(shè)備的操作系統(tǒng)選擇對應(yīng)的安裝服務(wù)。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
云命令行(Cloud Shell)中預(yù)裝了阿里云CLI,且自動為您配置身份憑證,無需手動操作。您可在云命令行中調(diào)試阿里云CLI命令。更多信息,請參見什么是云命令行。
步驟二:配置阿里云CLI
阿里云賬號(主賬號)擁有所有產(chǎn)品OpenAPI的管理和訪問權(quán)限,風(fēng)險很高。強(qiáng)烈建議您創(chuàng)建RAM用戶(子賬號),并依據(jù)最小化權(quán)限原則授予權(quán)限,使用RAM用戶身份訪問OpenAPI。內(nèi)容安全增強(qiáng)版支持的權(quán)限策略,請參見使用RAM進(jìn)行訪問控制。
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請參見身份憑證類型。阿里云CLI支持使用RAM用戶的AccessKey信息配置AK類型身份憑證,具體操作步驟如下:
創(chuàng)建一個RAM用戶,并創(chuàng)建AccessKey,以便后續(xù)配置身份憑證使用。具體操作,請參見創(chuàng)建RAM用戶及創(chuàng)建AccessKey。
為RAM用戶授權(quán)。本文示例需授予RAM用戶調(diào)用內(nèi)容安全增強(qiáng)版API的權(quán)限
AliyunYundunGreenWebFullAccess
。具體操作,請參見為RAM用戶授權(quán)。獲取可用的地域ID,以便后續(xù)配置身份憑證使用。阿里云CLI將使用您指定的地域發(fā)起OpenAPI調(diào)用。內(nèi)容安全增強(qiáng)版的可用地域如下所示:
地域名稱
地域ID
公網(wǎng)接入地址
VPC接入地址
華北2(北京)
cn-beijing
green-cip.cn-beijing.aliyuncs.com
green-cip-vpc.cn-beijing.aliyuncs.com
華東2(上海)
cn-shanghai
green-cip.cn-shanghai.aliyuncs.com
green-cip-vpc.cn-shanghai.aliyuncs.com
華南1(深圳)
cn-shenzhen
green-cip.cn-shenzhen.aliyuncs.com
green-cip-vpc.cn-shenzhen.aliyuncs.com
新加坡
ap-southeast-1
green-cip.ap-southeast-1.aliyuncs.com
green-cip-vpc.ap-southeast-1.aliyuncs.com
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發(fā)起命令調(diào)用,該選項在使用時將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見配置示例。
步驟三:生成CLI命令示例
在OpenAPI門戶中,訪問TextModeration調(diào)試地址。
在參數(shù)配置中輸入請求參數(shù),單擊CLI示例頁簽,查看生成的CLI示例。
復(fù)制CLI示例或在云命令行中快速執(zhí)行:
單擊運行命令按鈕,可喚出云命令行并快速完成命令調(diào)試。
單擊復(fù)制按鈕,將CLI示例復(fù)制到剪貼板中,可粘貼至本地Shell工具中運行或用于編輯自動化命令行腳本。
說明復(fù)制CLI示例到本地Shell工具中進(jìn)行調(diào)試時請注意參數(shù)格式。關(guān)于阿里云CLI命令參數(shù)使用格式的詳細(xì)信息,請參見參數(shù)格式說明。
OpenAPI門戶生成示例中會默認(rèn)添加
--region
選項,復(fù)制命令到本地調(diào)用時阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息,優(yōu)先使用指定的地域調(diào)用命令,您可根據(jù)需要對該選項進(jìn)行刪除或保留。
步驟四:調(diào)用內(nèi)容安全增強(qiáng)版OpenAPI
示例一:獲取OpenAPI列表
以下示例將為您展示如何使用--help
選項獲取支持阿里云CLI調(diào)用的內(nèi)容安全增強(qiáng)版OpenAPI列表。
執(zhí)行以下命令。
aliyun green --help
預(yù)期輸出。
示例二:查詢工作空間列表
以下示例將為您展示如何使用阿里云CLI調(diào)用內(nèi)容安全增強(qiáng)版的TextModeration
接口,檢測用戶昵稱是否違規(guī)。更多接口信息,請參見文本審核增強(qiáng)版。
執(zhí)行命令。
aliyun green TextModeration --region cn-beijing --Service nickname_detection --ServiceParameters '{"content":"檢測內(nèi)容"}'
預(yù)期輸出。
命中系統(tǒng)策略:
{ "Code": 200, "Data": { "Labels": "sexual_content", "Reason": "{\"riskLevel\":\"high\",\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務(wù)\"}", "AccountId": "10123****" }, "Message": "OK", "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****" }
命中自定義關(guān)鍵詞:
{ "Code": 200, "Data": { "Labels": "sexual_content", "Reason": "{\"riskLevel\":\"high\",\"customizedWords\":\"自定義關(guān)鍵詞\",\"customizedLibs\":\"自定義關(guān)鍵詞庫名稱\"}", "AccountId": "10123****" }, "Message": "OK", "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****" }
說明如果調(diào)用內(nèi)容安全增強(qiáng)版OpenAPI后返回錯誤,您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。
您可以記錄下調(diào)用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進(jìn)行自助診斷。