AI Guardrails:Multimodal SDK reference

Java SDK

Java 1.8 and later versions are supported.

For the original code, see Java SDK source code or Java SDK source code (OSS path).

Add the following dependency to the pom.xml file to use the SDK in a Maven project.

1. Add the following dependency to the dependencies section.

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>green20220302</artifactId>
  <version>2.21.0</version>
</dependency>

2. Java SDK sample code.

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.models.MultiModalGuardRequest;
import com.aliyun.green20220302.models.MultiModalGuardResponse;
import com.aliyun.green20220302.models.MultiModalGuardResponseBody;
import com.aliyun.teaopenapi.models.Config;

import java.util.Collections;

public class MultiModalGuardDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M.
         * Common methods to obtain environment variables:
         * Method 1:
         *     Obtain RAM user AccessKey ID: System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     Obtain RAM user AccessKey Secret: System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * Method 2:
         *     Obtain RAM user AccessKey ID: System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     Obtain RAM user AccessKey Secret: System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("We recommend that you obtain the RAM user AccessKey ID from environment variables");
        config.setAccessKeySecret("We recommend that you obtain the RAM user AccessKey Secret from environment variables");
        //Modify the region and endpoint based on your actual situation
        config.setRegionId("cn-shanghai");
        config.setEndpoint("green-cip.cn-shanghai.aliyuncs.com");
        //Read timeout in milliseconds (ms).
        config.setReadTimeout(10000);
        //Connection timeout in milliseconds (ms).
        config.setConnectTimeout(3000);
        //Set HTTP proxy.
        //config.setHttpProxy("http://xx.xx.xx.xx:xxxx");
        //Set HTTPS proxy.
        //config.setHttpsProxy("https://xx.xx.xx.xx:xxxx");
        com.aliyun.green20220302.Client client = new com.aliyun.green20220302.Client(config);

        JSONObject serviceParameters = new JSONObject();
        serviceParameters.put("content", "Test text content");
        serviceParameters.put("imageUrls", Collections.singletonList("https://img.alicdn.com/tfs/xxxxxxxxxx001.png"));

        MultiModalGuardRequest multiModalGuardRequest = new MultiModalGuardRequest();
        // Detection type
        multiModalGuardRequest.setService("text_img_security_check");
        multiModalGuardRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            MultiModalGuardResponse response = client.multiModalGuard(multiModalGuardRequest);
            if (response.getStatusCode() == 200) {
                MultiModalGuardResponseBody result = response.getBody();
                System.out.println(JSON.toJSONString(result));
                System.out.println("requestId = " + result.getRequestId());
                System.out.println("code = " + result.getCode());
                System.out.println("msg = " + result.getMessage());
                Integer code = result.getCode();
                if (200 == code) {
                    MultiModalGuardResponseBody.MultiModalGuardResponseBodyData data = result.getData();
                    System.out.println(JSON.toJSONString(data, true));
                } else {
                    System.out.println("multi modal guard not success. code:" + code);
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

Python SDK

Python 3.6 and later versions are supported.

For the original code, see Python SDK source code.

1. Run the following command to import the dependencies.

pip install alibabacloud_green20220302==2.21.2

2. Python SDK sample code.

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M.
    # We recommend that you do not include your AccessKey ID and AccessKey secret in your project code for data security reasons.
    # Common methods to obtain environment variables:
    # Obtain RAM user AccessKey ID: os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # Obtain RAM user AccessKey Secret: os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='We recommend that you obtain the RAM user AccessKey ID from environment variables',
    access_key_secret='We recommend that you obtain the RAM user AccessKey Secret from environment variables',
    # Connection timeout in milliseconds (ms)
    connect_timeout=10000,
    # Read timeout in milliseconds (ms)
    read_timeout=3000,
    region_id='cn-shanghai',
    endpoint='green-cip.cn-shanghai.aliyuncs.com'
)

clt = Client(config)

serviceParameters = {
    'content': 'Test text content',
    'imageUrls': ['https://img.alicdn.com/tfs/xxxxxxxxxx001.png']
}
multiModalGuardRequest = models.MultiModalGuardRequest(
    # Detection type
    service='text_img_security_check',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.multi_modal_guard(multiModalGuardRequest)
    if response.status_code == 200:
        # Call successful
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

PHP SDK

PHP 5.6 and later versions are supported.

For the original code, see PHP SDK source code.

1. Run the following command to import the dependencies.

composer require alibabacloud/green-20220302

2. PHP SDK sample code.

<?php
require('vendor/autoload.php');

use AlibabaCloud\Dara\Models\RuntimeOptions;
use AlibabaCloud\SDK\Green\V20220302\Models\MultiModalGuardRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Green\V20220302\Green;

$config = new Config([
    /**
     * The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M.
     * We recommend that you do not include your AccessKey ID and AccessKey secret in your project code for data security reasons.
     * Common methods to obtain environment variables:
     * Obtain RAM user AccessKey ID: getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
     * Obtain RAM user AccessKey Secret: getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
     */
    "accessKeyId" => 'We recommend that you obtain the RAM user AccessKey ID from environment variables',
    "accessKeySecret" => 'We recommend that you obtain the RAM user AccessKey Secret from environment variables',
    // Set HTTP proxy.
    // "httpProxy" => "http://10.10.xx.xx:xxxx",
    // Set HTTPS proxy.
    // "httpsProxy" => "https://10.10.xx.xx:xxxx",
    "endpoint" => "green-cip.cn-shanghai.aliyuncs.com",
    "regionId" => "cn-shanghai"

]);
// Note: The client instantiated here should be reused as much as possible to avoid repeatedly establishing connections and to improve detection performance.
$client = new Green($config);

$request = new MultiModalGuardRequest();
$request->service = "text_img_security_check";
$serviceParameters = array("content" => "Test content", "imageUrls" => ["https://img.alicdn.com/tfs/xxxxxxxxxx001.png"]);

$request->serviceParameters = json_encode($serviceParameters);

$runtime = new RuntimeOptions();
$runtime->readTimeout = 10000;
$runtime->connectTimeout = 3000;

try {
    $response = $client->multiModalGuardWithOptions($request, $runtime);
    print_r($response->body);
    if (200 != $response->statusCode) {
        print_r("response not success. code:" . $response->statusCode);
        return;
    }
    $body = $response->body;
    print_r("requestId = " . $body->requestId . "\n");
    print_r("code = " . $body->code . "\n");
    print_r("message = " . $body->message . "\n");
    if (200 != $body->code) {
        print_r("multi modal guard not success. code:" . $body->code);
    }
    $data = $body->data;
    print_r("data = " . json_encode($data));
} catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
}

Go SDK

1. Run the following command to import the dependencies.

go get github.com/alibabacloud-go/green-20220302

2. Go SDK sample code.

package main

import (
	"encoding/json"
	"fmt"
	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	green20220302 "github.com/alibabacloud-go/green-20220302/v2/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
	"net/http"
)

func main() {
	// If the project code is leaked, the AccessKey pair may be leaked and security issues may occur on all resources of your account. The following code example is for reference only. We recommend that you use the more secure STS method.
	config := &openapi.Config{
		/**
		 * The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M.
		 * We recommend that you do not include your AccessKey ID and AccessKey secret in your project code for data security reasons.
		 * Common methods to obtain environment variables:
		 * Obtain RAM user AccessKey ID: os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
		 * Obtain RAM user AccessKey Secret: os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
		 */
		AccessKeyId:     tea.String("We recommend that you obtain the RAM user AccessKey ID from environment variables"),
		AccessKeySecret: tea.String("We recommend that you obtain the RAM user AccessKey Secret from environment variables"),
		// Set HTTP proxy.
		// HttpProxy: tea.String("http://xx.xx.xx.xx:xxxx"),
		// Set HTTPS proxy.
		// HttpsProxy: tea.String("https://username:password@xxx.xxx.xxx.xxx:9999"),
		RegionId: tea.String("cn-shanghai"),
		Endpoint: tea.String("green-cip.cn-shanghai.aliyuncs.com"),
		/**
		 * Set timeout periods. The server-side end-to-end processing timeout is 10 seconds. Configure your settings accordingly.
		 * If you set ReadTimeout to a value less than the time required for server-side processing, your program will receive a ReadTimeout exception.
		 */
		ConnectTimeout: tea.Int(3000),
		ReadTimeout:    tea.Int(10000),
	}
	client, _err := green20220302.NewClient(config)
	if _err != nil {
		panic(_err)
	}

	// Create a RuntimeObject instance and set runtime parameters.
	runtime := &util.RuntimeOptions{}
	runtime.ReadTimeout = tea.Int(10000)
	runtime.ConnectTimeout = tea.Int(10000)

	serviceParameters, _ := json.Marshal(
		map[string]interface{}{
			"content":   "Test content",
			"imageUrls": [1]string{"https://img.alicdn.com/tfs/xxxxxxxxxx001.png"},
		},
	)
	request := green20220302.MultiModalGuardRequest{
		Service:           tea.String("text_img_security_check"),
		ServiceParameters: tea.String(string(serviceParameters)),
	}

	result, _err := client.MultiModalGuardWithOptions(&request, runtime)
	if _err != nil {
		panic(_err)
	}

	if *result.StatusCode != http.StatusOK {
		fmt.Printf("response not success. status:%d\n", *result.StatusCode)
		return
	}
	body := result.Body
	fmt.Printf("response success. requestId:%s, code:%d, msg:%s\n", *body.RequestId, *body.Code, *body.Message)
	if *body.Code != http.StatusOK {
		fmt.Printf("multi modal guard not success. code:%d\n", *body.Code)
		return
	}

	data := body.Data
	fmt.Printf("multi modal guard data:%s\n", *data)
}