API overview-AI Guardrails(AI Guardrails)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (Green/2022-09-26) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

API catalog

API	Title	Description
AddKeywordLib	AddKeywordLib	Create a keyword library
DeleteFeatureConfig	Delete feature configuration	Delete feature configuration
ExportCipStats	Export usage	Exports call usage statistics.
ExportOssCheckStat	Export OSS scan task usage statistics	Exports OSS usage statistics.
GetFeatureConfig	Query feature configurations	Retrieves feature configurations.
GetOssCheckResultDetail	Query OSS check result details	Retrieves the detailed information about OSS check results.
GetOssCheckStat	Query OSS usage statistics	Queries OSS usage statistics.
GetScanResult	Query detection results	Queries detection results.
GetServiceConf	Get Rule Configuration	Get a Single Service
GetServiceConfig	Retrieve rule configuration	Retrieves a single service.
GetUserBuyStatus	Retrieve user purchase status	Retrieves the purchase status of a user.
ListKeywordLibs	List keyword libraries	Queries the list of keyword libraries.
ListOssCheckResult	Query OSS Scan Result List	query OSS scan result list
ModifyFeatureConfig	Edit attribute configuration	Saves an attribute configuration.
QueryCallback	Query message notification	Queries a single callback configuration.
UpdateScanResultFeedback	Submit detection result feedback	Submits feedback on detection results.
AddAnswerSample	Add a proxy answer	Adds a proxy answer.
AddImageLib	Create an image library	Creates an image library.
AddImages2Lib	Add images to an image library	Adds images in batches.
AddKeywords	Add keywords	Adds keywords.
AddKeywordsToLib	Add keywords to a keyword library	Adds keywords.
CancelStockOssCheckTask	Cancel an OSS scan task	Cancels an OSS scan task.
CopyServiceConfig	Replication rule configuration	Copies a service.
CreatStockOssCheckTask	Create an OSS scan task	Creates an OSS scan task.
CreateAnswerLib	Create a proxy answer library	Creates a proxy answer library.
CreateCallback	Create a message notification	Creates a message notification.
CreateImageLib	Create a custom graph library.	Create a graph library.
CreateOnlineTest	Create Online Test Task	Online Test
CreatePreCheck	Dry run before creating an OSS scan task	Performs a dry run before creating an OSS scan task.
DeleteAnswerLib	Delete a proxy answer library	Delete a proxy answer library
DeleteAnswerSample	Delete proxy answers	Deletes proxy answers.
DeleteCallback	Delete a message notification	Deletes a message notification.
DeleteImagesFromLib	Delete images from an image library	Deletes images in batches.
DeleteKeyword	Delete keywords	Deletes keywords.
DeleteKeywordLib	Delete a keyword library	Deletes a keyword library.
DeleteOnlineTest	Delete online test	Delete online test
DescribeOnlineTestResult	Query the Detection Result of an Online Detection Task	Query the detection results of online Detection.
ExportAnswerSample	Export proxy answer responses	Exports proxy answer responses.
ExportKeyword	Export keywords	Exports keywords.
ExportResult	Export OSS scan task results	Exports OSS scan results.
ExportScanResult	Export detection results	Exports call results as an Excel file.
ExportTextScanResult	Export text detection results	Exports call results as an Excel file.
GetAnswerImportProgress	Retrieve proxy answer import progress	Retrieves the import progress of proxy answer samples.
GetBackupBucketsList	Retrieve bucket list for evidence dumping	Retrieves the list of user buckets for evidence dumping.
GetBackupConfig	Get Evidence Backup Configuration	Get Evidence Backup Configuration
GetBackupStatus	Query evidence archiving user status	Verifies user authorization.
GetBucketsList	List buckets	Lists buckets.
GetCipStats	Query usage statistics	Queries the call volume.
GetExecuteTime	Get Scheduled Task Estimated Execution Time	Get Scheduled OSS Scan Task Estimated Execution Time
GetImageSceneLabelConf	Retrieve image rule tag information	Retrieves image rule tag information.
GetImageSceneLabelListConf	Get Image Rule Label Information	Get Image Rule Label Information
GetJobNameList	Query OSS scheduled scan detection cycle	Queries the scheduled scan detection cycle for OSS.
GetKeywordImportResult	Get keyword import result	Queries the result of a keyword import task.
GetKeywordLib	Retrieve keyword library information	The keyword library information.
GetOssCheckFreezeResult	Query OSS Detection Freeze Result	Query OSS freeze result
GetOssCheckStatus	Query OSS detection status	Queries the OSS detection status of a user.
GetOssCheckTaskInfo	Obtain OSS detection job information.	Query OSS scan job details
GetPromptTestResult	Retrieve custom prompt testing results	Test attribute configuration
GetScanNum	Retrieve user pending detection information	The user's pending detection information.
GetServiceLabelConfig	Retrieve the tag configuration of a rule configuration	Retrieves the tag configuration of a single service.
GetStockOssCheckTasksList	Query OSS Scan Task List	Query OSS Scan Task List
GetTextScanResult	Query text detection results	Queries call results.
GetUploadInfo	Retrieve file upload information	Retrieves the information required for file upload.
GetUploadLink	Query an upload link	Obtain an upload link
ListAnswerLib	List proxy answer libraries	Queries the list of proxy answer libraries.
ListCallback	List message notifications	Queries the list of message notifications.
ListImageLib	Query image library list	Queries the list of image libraries.
ListImagesFromLib	List Images from Image Library	List Images with Pagination
ListKeywords	Query keyword list	Queries a list of keywords.
ListServiceConfigs	Retrieve rule configuration list	Retrieves the service list.
LlmStreamChat	Large Model Streaming Conversation Forwarding Interface	Use SSE interface to stream large model calls
ModifyAnswerLib	Edit proxy response library	Updates a proxy response library.
ModifyCallback	Edit message notification	Modifies a message notification.
ModifyServiceInfo	Edit rule configuration	Edits a service.
OssCheckResultList	Query OSS Detection Result List	OSS scan result query
QueryAnswerSampleByPage	Paged query of proxy answers	Queries proxy answer samples by paging.
QueryCallbackByPage	Query message notification list by page	Message notification.
StopOnlineTest	Abort an online Detection Job	Abort an online Detection Job
UpdateBackupConfig	Edit evidence transfer configuration	Updates the evidence transfer configuration.
UpdateImageLib	Edit an image library	Edits an image library.
UpdateImageLibFreeInspection	Edit image library inspection-exempt configuration	Edits the image library inspection-exempt configuration.
UpdateKeywordLib	Edit a keyword library	Edits a keyword library.
UpdateOssCheckResultsBatchFeedback	Batch update detection result feedback	Batch update OSS detection result feedback
UpdateOssCheckResultsFeedBack	Update OSS detection result feedback	Update OSS detection result feedback
UpdateOssCheckResultsFreeze	Update OSS detection result freeze status	Batch freeze OSS detection results.
UpdateOssCheckResultsUnfreeze	Restore OSS Detection results	Batch restore OSS Detection results