ドキュメントモデレーション拡張版 SDK および統合ガイド - Content Moderation

ドキュメントモデレーション 2.0 は、SDK ベースとネイティブ HTTPS 呼び出しの両方をサポートしています。SDK を使用すると、署名検証と本文形式の構築ステップをスキップできます。このガイドでは、ドキュメントモデレーション 2.0 を統合する方法について説明します。

ステップ 1：サービスの有効化

Content Moderation 2.0 サービスの有効化ページにアクセスして、ドキュメントモデレーション 2.0 サービスを有効化します。サービスを統合すると、使用量に基づいて自動的に課金されます。詳細については、「課金」をご参照ください。

ドキュメントモデレーション 2.0 サービスを有効にすると、デフォルトの課金方法は従量課金になります。実際の使用量に基づいて毎日課金されます。サービスを使用しない場合、料金は発生しません。

ステップ 2：RAM ユーザーへの権限付与

SDK または API を使用する前に、Resource Access Management (RAM) ユーザーに必要な権限を付与する必要があります。Alibaba Cloud への API 呼び出しを認証するために、RAM ユーザーの AccessKey ペアを作成する必要があります。詳細については、「AccessKey の取得」をご参照ください。

操作手順

RAM 管理者として RAM コンソールにログインします。
RAM ユーザーを作成します。

詳細については、「RAM ユーザーの作成」をご参照ください。
AliyunYundunGreenWebFullAccess システムポリシーを RAM ユーザーに付与します。

詳細については、「RAM ユーザーへの権限付与」をご参照ください。

上記の手順を完了すると、RAM ユーザーとして Content Moderation API を呼び出すことができます。

ステップ 3：ドキュメントモデレーションサービスのインストールと統合

このサービスは、以下のリージョンで統合できます。

リージョン	パブリックエンドポイント	VPC エンドポイント	サポートされるサービス
シンガポール	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com	document_detection_global

説明

他の言語の SDK サンプルコードが必要な場合は、OpenAPI Developer Portal のオンラインデバッグツールを使用して API 操作をテストできます。このツールは、対応する API の SDK サンプルコードを自動的に生成します。

Alibaba Cloud SDK コードでは、ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数を定義することで、デフォルトのアクセス認証情報を作成できます。Alibaba Cloud サービスの API 操作を呼び出すと、システムは直接認証情報にアクセスし、AccessKey ペアを読み取り、自動的に認証を完了します。SDK サンプルコードを使用する前に、環境変数を設定する必要があります。詳細については、「認証情報の設定」をご参照ください。

API インターフェイスフィールドの詳細については、「ドキュメントモデレーション拡張版 2.0 API」をご参照ください。

Java SDK

この SDK は Java 1.8 以降をサポートしています。

ソースコードについては、「Java SDK ソースコード」または「Java SDK ソースコード (OSS パス)」をご参照ください。

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

モデレートしたいドキュメントがインターネットからアクセス可能な場合、ドキュメントモデレーション 2.0 はドキュメント URL を使用してファイルを取得し、そのファイルをモデレートします。

Maven プロジェクトで SDK を使用するには、pom.xml ファイルに必要な依存関係を追加します。

dependencies セクションに次の依存関係を追加します：

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

Java SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.FileModerationRequest; 
import com.aliyun.green20220302.models.FileModerationResponse; 
import com.aliyun.green20220302.models.FileModerationResponseBody; 
import com.aliyun.teaopenapi.models.Config;

public class FileModerationDemo {
    public static void main(String[] args) throws Exception {
        Config config = new Config();
         /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します。
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        // 接続タイムアウト (ミリ秒)。
        config.setReadTimeout(6000);
        // 読み取りタイムアウト (ミリ秒)。
        config.setConnectTimeout(3000);

        Client client = new Client(config);
        JSONObject serviceParameters = new JSONObject();
        serviceParameters.put("url", "https://xxx.oss.aliyuncs.com/xxx.pdf"); // ファイル URL

        FileModerationRequest fileModerationRequest = new FileModerationRequest(); 
        // 検出タイプ：document_detection_global 一般的なドキュメント検出
        fileModerationRequest.setService("document_detection_global");
        fileModerationRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            FileModerationResponse response = client.fileModeration(fileModerationRequest); 
            if (response.getStatusCode() == 200) {
                FileModerationResponseBody 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) {
                    FileModerationResponseBody.FileModerationResponseBodyData data = result.getData();
                    System.out.println("taskId = [" + data.getTaskId() + "]");
                } else {
                    System.out.println("file moderation not success. code:" + code);
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

ドキュメント検出タスクの結果を取得

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        // 接続タイムアウト (ミリ秒)。
        config.setReadTimeout(6000);
        // 読み取りタイムアウト (ミリ秒)。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // タスク送信時に返される taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

ローカルドキュメントの検出

シナリオ

モデレートしたいドキュメントがローカルに保存されており、インターネットからアクセスできない場合、Content Moderation が提供する Object Storage Service (OSS) バケットにアップロードする必要があります。ドキュメントモデレーション 2.0 は、OSS に直接アクセスしてドキュメントコンテンツを取得し、モデレートします。

dependencies セクションに次の依存関係を追加します：

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

OSS SDK をインストールします：

<dependency>
  <groupId>com.aliyun.oss</groupId>
  <artifactId>aliyun-sdk-oss</artifactId>
  <version>3.16.3</version>
</dependency>

Java SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

import com.alibaba.fastjson.JSON;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeUploadTokenResponse;
import com.aliyun.green20220302.models.DescribeUploadTokenResponseBody;
import com.aliyun.green20220302.models.FileModerationRequest;
import com.aliyun.green20220302.models.FileModerationResponse;
import com.aliyun.green20220302.models.FileModerationResponseBody;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.model.PutObjectRequest;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;

import java.io.File;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

public class FileModerationFile {
    /**サービスが VPC にデプロイされているかどうか*/
    public static boolean isVPC = false;

    /**ファイルアップロードトークン endpoint->token*/
    public static Map<String, DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData> tokenMap = new HashMap<>();

    /**ファイルアップロードリクエスト用のクライアント*/
    public static OSS ossClient = null;

    /**
     * リクエストクライアントを作成
     *
     * @param accessKeyId
     * @param accessKeySecret
     * @param endpoint
     * @return
     * @throws Exception
     */
    public static Client createClient(String accessKeyId, String accessKeySecret, String endpoint) throws Exception {
        Config config = new Config();
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
        // 実際の状況に応じてリージョンとアドレスを変更します
        config.setEndpoint(endpoint);
        return new Client(config);
    }

    /**
     * ファイルアップロードリクエスト用のクライアントを作成
     *
     * @param tokenData
     * @param isVPC
     */
    public static void getOssClient(DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData tokenData, boolean isVPC) {
        // ここでインスタンス化されたクライアントは、繰り返し接続を避け、検出パフォーマンスを向上させるために、できるだけ再利用する必要があります。
        if (isVPC) {
            ossClient = new OSSClientBuilder().build(tokenData.ossInternalEndPoint, tokenData.getAccessKeyId(), tokenData.getAccessKeySecret(), tokenData.getSecurityToken());
        } else {
            ossClient = new OSSClientBuilder().build(tokenData.ossInternetEndPoint, tokenData.getAccessKeyId(), tokenData.getAccessKeySecret(), tokenData.getSecurityToken());
        }
    }

    /**
     * ファイルをアップロード
     *
     * @param filePath
     * @param tokenData
     * @return
     * @throws Exception
     */
    public static String uploadFile(String filePath, DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData tokenData) throws Exception {
        String[] split = filePath.split("\\.");
        String objectName;
        if (split.length > 1) {
            objectName = tokenData.getFileNamePrefix() + UUID.randomUUID() + "." + split[split.length - 1];
        } else {
            objectName = tokenData.getFileNamePrefix() + UUID.randomUUID();
        }
        PutObjectRequest putObjectRequest = new PutObjectRequest(tokenData.getBucketName(), objectName, new File(filePath));
        ossClient.putObject(putObjectRequest);
        return objectName;
    }

    public static FileModerationResponse invokeFunction(String accessKeyId, String accessKeySecret, String endpoint) throws Exception {
        // ここでインスタンス化されたクライアントは、繰り返し接続を避け、検出パフォーマンスを向上させるために、できるだけ再利用する必要があります。
        Client client = createClient(accessKeyId, accessKeySecret, endpoint);
        RuntimeOptions runtime = new RuntimeOptions();

        // ローカルファイルのフルパス、例：D:\localPath\exampleFile.mp3。
        String filePath = "D:/test/1.pdf";
        // ファイルアップロードトークンを取得
        if (tokenMap.get(endpoint) == null || tokenMap.get(endpoint).expiration <= System.currentTimeMillis() / 1000) {
            DescribeUploadTokenResponse tokenResponse = client.describeUploadToken();
            tokenMap.put(endpoint, tokenResponse.getBody().getData());
        }
        // ファイルアップロードリクエスト用のクライアント
        getOssClient(tokenMap.get(endpoint), isVPC);

        // ファイルをアップロード
        String objectName = uploadFile(filePath, tokenMap.get(endpoint));

        // 検出パラメーターを構築します。
        Map<String, String> serviceParameters = new HashMap<>();
        // ファイルアップロード情報
        serviceParameters.put("ossBucketName", tokenMap.get(endpoint).getBucketName());
        serviceParameters.put("ossObjectName", objectName);
        serviceParameters.put("dataId", UUID.randomUUID().toString());

        FileModerationRequest request = new FileModerationRequest();
        // 検出タイプ。
        request.setService("document_detection_global");
        request.setServiceParameters(JSON.toJSONString(serviceParameters));

        FileModerationResponse response = null;
        try {
            response = client.fileModerationWithOptions(request, runtime);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return response;
    }

    public static void main(String[] args) throws Exception {
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します。
        FileModerationResponse response = invokeFunction(accessKeyId, accessKeySecret, "green-cip.ap-southeast-1.aliyuncs.com");

            // 検出結果を出力します。
            if (response != null) {
                if (response.getStatusCode() == 200) {
                    FileModerationResponseBody body = response.getBody();
                    System.out.println(JSON.toJSONString(body));
                    System.out.println("requestId = " + body.getRequestId());
                    System.out.println("code = " + body.getCode());
                    System.out.println("msg = " + body.getMessage());
                    Integer code = body.getCode();
                    if (200 == code) {
                        FileModerationResponseBody.FileModerationResponseBodyData data = body.getData();
                        System.out.println("taskId = [" + data.getTaskId() + "]");
                    } else {
                        System.out.println("file moderation not success. code:" + code);
                    }
                } else {
                    System.out.println("response not success. status:" + response.getStatusCode());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

ドキュメント検出タスクのコードサンプルを取得

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        // 接続タイムアウト (ミリ秒)。
        config.setReadTimeout(6000);
        // 読み取りタイムアウト (ミリ秒)。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // タスク送信時に返される taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

OSS ドキュメントの検出

シナリオ

モデレートしたいドキュメントが Alibaba Cloud Object Storage Service (OSS) に保存されている場合、Content Moderation に OSS へのアクセスを許可するためのサーバロールを作成する必要があります。ドキュメントモデレーション 2.0 は、このサーバロールを使用して OSS からファイルを取得し、分析します。サーバロールを作成するには、クラウドリソースアクセス権限付与ページにアクセスしてください。

dependencies セクションに次の依存関係を追加します：

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

OSS SDK をインストールします：

<dependency>
  <groupId>com.aliyun.oss</groupId>
  <artifactId>aliyun-sdk-oss</artifactId>
  <version>3.16.3</version>
</dependency>

Java SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.FileModerationRequest; 
import com.aliyun.green20220302.models.FileModerationResponse; 
import com.aliyun.green20220302.models.FileModerationResponseBody; 
import com.aliyun.teaopenapi.models.Config;

public class FileModerationDemo {
    public static void main(String[] args) throws Exception {
        Config config = new Config();
         /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します。
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        // 接続タイムアウト (ミリ秒)。
        config.setReadTimeout(6000);
        // 読み取りタイムアウト (ミリ秒)。
        config.setConnectTimeout(3000);

        Client client = new Client(config);
        JSONObject serviceParameters = new JSONObject();
        serviceParameters.put("ossBucketName", "bucket_01");
        serviceParameters.put("ossObjectName", "2022023/04/24/test.pdf");
        serviceParameters.put("ossRegionId", "ap-southeast-1"); 

        FileModerationRequest fileModerationRequest = new FileModerationRequest(); 
        // 検出タイプ：document_detection_global 一般的なドキュメント検出
        fileModerationRequest.setService("document_detection_global");
        fileModerationRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            FileModerationResponse response = client.fileModeration(fileModerationRequest); 
            if (response.getStatusCode() == 200) {
                FileModerationResponseBody 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) {
                    FileModerationResponseBody.FileModerationResponseBodyData data = result.getData();
                    System.out.println("taskId = [" + data.getTaskId() + "]");
                } else {
                    System.out.println("file moderation not success. code:" + code);
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

ドキュメント検出タスクの結果を取得するためのサンプルコード

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * 環境変数を取得する一般的な方法：
         * 方法 1：
         *     RAM ユーザーの AccessKey ID を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方法 2：
         *     RAM ユーザーの AccessKey ID を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     RAM ユーザーの AccessKey Secret を取得：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します");
        config.setAccessKeySecret("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します");
        // 実際の状況に応じてリージョンとアドレスを変更します
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        // 接続タイムアウト (ミリ秒)。
        config.setReadTimeout(6000);
        // 読み取りタイムアウト (ミリ秒)。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // タスク送信時に返される taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Python SDK

この SDK は Python 3.6 以降をサポートしています。

ソースコードについては、「Python SDK ソースコード」をご参照ください。

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

次のコマンドを実行して pip をインストールできます。
```
pip install alibabacloud_green20220302==2.2.11
```

Python SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

# 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(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)
    connect_timeout=10000, 
    # 読み取りタイムアウト (ミリ秒) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

serviceParameters = {
    'url': 'https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf',
}
fileModerationRequest = models.FileModerationRequest(
    # 検出タイプ
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.file_moderation(fileModerationRequest)
    if response.status_code == 200:
        # 呼び出し成功
        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)

ドキュメント検出タスクの結果を取得

# 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(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)
    connect_timeout=10000, 
    # 読み取りタイムアウト (ミリ秒) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# タスク送信時に返される taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 検出タイプ
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 呼び出し成功
        # レビュー結果を取得
        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)

ローカルドキュメントの検出

シナリオ

次のコマンドを実行して pip をインストールします。
```
pip install alibabacloud_green20220302==2.2.11
```
OSS SDK をインストールします：
```
pip install oss2
```

Python SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_tea_util import models as util_models
import json
import uuid

import oss2
import time

configs = Config(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)。
    connect_timeout=10000,
    # 読み取りタイムアウト (ミリ秒)。
    read_timeout=10000,
    # 実際の状況に応じてアクセスリージョンとアドレスを変更します。
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)
# 注：ここでインスタンス化されたクライアントは、繰り返し接続を避け、検出パフォーマンスを向上させるために、できるだけ再利用する必要があります。
client = Client(configs)

bucket = None
upload_token = None


def get_oss_client(is_vpc):
    global upload_token
    global bucket
    if (upload_token == None) or int(upload_token.expiration) <= int(time.time()):
        response = client.describe_upload_token()

        upload_token = response.body.data
        auth = oss2.StsAuth(upload_token.access_key_id, upload_token.access_key_secret, upload_token.security_token)

        end_point = upload_token.oss_internet_end_point
        if (is_vpc):
            end_point = upload_token.oss_internal_end_point
        bucket = oss2.Bucket(auth, end_point, upload_token.bucket_name)


def upload_file(file_name, is_vpc):
    get_oss_client(is_vpc)
    object_name = upload_token.file_name_prefix + str(uuid.uuid4()) + '.' + file_name.split('.')[-1]
    bucket.put_object_from_file(object_name, file_name)
    return object_name


def file_moderation_by_local_file(file_path, is_vpc):
    # 1. ファイルをアップロード
    object_name = upload_file(file_path, is_vpc)

    # 2. 検出パラメーター
    service_parameters = {
        'dataId': str(uuid.uuid4()),
        'ossBucketName': upload_token.bucket_name,
        'ossObjectName': object_name
    }

    file_moderation_request = models.FileModerationRequest(
        # 検出タイプ。
        service='document_detection_global',
        service_parameters=json.dumps(service_parameters)
    )

    # RuntimeObject インスタンスを作成し、実行時パラメーターを設定します。
    runtime = util_models.RuntimeOptions()
    runtime.read_timeout = 10000
    runtime.connect_timeout = 10000
    try:
        global client
        response = client.file_moderation_with_options(file_moderation_request, runtime)

        if response.status_code == 200:
            # 呼び出し成功。
            # レビュー結果を取得します。
            result = response.body
            print('response success. result:{}'.format(result))
            if result.code == 200:
                result_data = result.data
                print('result: {}'.format(result_data))
        else:
            print('response not success. status:{} ,result:{}'.format(response.status_code, response))
    except Exception as err:
        print(err)


if __name__ == '__main__':
    # ローカルファイルパス
    file_path = '/Users/test/MS.pdf'
    # VPC にデプロイされているかどうか
    is_vpc = False  # True
    file_moderation_by_local_file(file_path, is_vpc)

ドキュメント検出タスクの結果を取得

# 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(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)
    connect_timeout=10000, 
    # 読み取りタイムアウト (ミリ秒) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# タスク送信時に返される taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 検出タイプ
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 呼び出し成功
        # レビュー結果を取得
        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)

OSS ドキュメントの検出

シナリオ

次のコマンドを実行して pip をインストールします。
```
pip install alibabacloud_green20220302==2.2.11
```

Python SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

# 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(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)
    connect_timeout=10000,
    # 読み取りタイムアウト (ミリ秒)
    read_timeout=3000,
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

serviceParameters = {
    'ossRegionId': 'cn-hangzhou',
    'ossBucketName': 'detect-obj',
    'ossObjectName': 'sample/xxxx.pdf'
}
fileModerationRequest = models.FileModerationRequest(
    # 検出タイプ
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.file_moderation(fileModerationRequest)
    if response.status_code == 200:
        # 呼び出し成功
        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)

ドキュメント検出タスクの結果を取得

# 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(
    # Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
    # プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
    # 環境変数を取得する一般的な方法：
    # RAM ユーザーの AccessKey ID を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # RAM ユーザーの AccessKey Secret を取得：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    access_key_secret='環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    # 接続タイムアウト (ミリ秒)
    connect_timeout=10000, 
    # 読み取りタイムアウト (ミリ秒) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# タスク送信時に返される taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 検出タイプ
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 呼び出し成功
        # レビュー結果を取得
        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

この SDK は PHP 5.6 以降をサポートしています。

ソースコードについては、「PHP SDK ソースコード」をご参照ください。

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
composer require alibabacloud/green-20220302 2.2.10
```

PHP SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

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

use AlibabaCloud\SDK\Green\V20220302\Models\FileModerationRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\SDK\Green\V20220302\Green;

$config = new Config([
    /**
     * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
     * プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
     * 環境変数を取得する一般的な方法：
     * RAM ユーザーの AccessKey ID を取得：getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
     * RAM ユーザーの AccessKey Secret を取得：getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
     */
    "accessKeyId" => '環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    "accessKeySecret" => '環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    "endpoint" => "green-cip.ap-southeast-1.aliyuncs.com",
    "regionId" => "ap-southeast-1"

]);
// 注：検出パフォーマンスを向上させ、繰り返し接続を避けるために、インスタンス化されたクライアントをできるだけ再利用してください。
$client = new Green($config);

$request = new FileModerationRequest();
$request->service = "document_detection_global";
$serviceParameters = array("url" => "https://xxx.oss.aliyuncs.com/xxx.pdf");

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

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

try {
    $response = $client->fileModerationWithOptions($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("file moderation not success. code:" . $body->code);
    }
    $data = $body->data;
    print_r("taskId = " . $data->taskId);
} catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
}

ドキュメント検出タスクの結果を取得

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

use AlibabaCloud\SDK\Green\V20220302\Models\DescribeFileModerationResultRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\SDK\Green\V20220302\Green;

$config = new Config([
    /**
     * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
     * プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
     * 環境変数を取得する一般的な方法：
     * RAM ユーザーの AccessKey ID を取得：getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
     * RAM ユーザーの AccessKey Secret を取得：getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
     */
    "accessKeyId" => '環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します',
    "accessKeySecret" => '環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します',
    "endpoint" => "green-cip.ap-southeast-1.aliyuncs.com",
    "regionId" => "ap-southeast-1"

]);
// 注：検出パフォーマンスを向上させ、繰り返し接続を避けるために、インスタンス化されたクライアントをできるだけ再利用してください。
$client = new Green($config);

$request = new DescribeFileModerationResultRequest();
$request->service = "document_detection_global";
$serviceParameters = array("taskId" => "fi_f_O5z5iaIis*****NYj7qa-1x****");

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

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

try {
    $response = $client->describeFileModerationResultWithOptions($request, $runtime);
    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 (280 == $body->code) {
        print_r("processing file moderation. code:" . $body->code);
        return;
    }
    if (200 != $body->code) {
        print_r("file moderation result not success. code:" . $body->code);
        return;
    }
    $data = $body->data;
      print_r("data = " . json_encode($data) . "\n");
    print_r("pageResult = " . json_encode($data->pageResult) . "\n");
} catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
}

ローカルドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
composer require alibabacloud/green-20220302 2.2.10
```
OSS SDK をインストールします：
```
composer require aliyuncs/oss-sdk-php
```
PHP SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得

OSS ドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
composer require alibabacloud/green-20220302 2.2.10
```
PHP SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得

Go SDK

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

Go SDK

次のコマンドを実行して依存関係を追加します：

go git clone --branch v2.2.11 github.com/alibabacloud-go/green-20220302/v2

Go SDK を統合します。

ドキュメント検出タスクを送信するためのサンプルコード

package main

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

func main() {
    // プロジェクトコードの漏洩は AccessKey の漏洩につながり、アカウント内のすべてのリソースのセキュリティを脅かす可能性があります。以下のコード例は参照用です。より安全な STS 方式を使用することを推奨します。
    config := &openapi.Config{
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
         * 環境変数を取得する一般的な方法：
         * RAM ユーザーの AccessKey ID を取得：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
         * RAM ユーザーの AccessKey Secret を取得：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
         */
        AccessKeyId: tea.String("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します"),
        AccessKeySecret: tea.String("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します"),
        RegionId: tea.String("ap-southeast-1"),
        Endpoint: tea.String("green-cip.ap-southeast-1.aliyuncs.com"),
        /**
     * タイムアウト期間を設定してください。サーバー側のフルリンク処理タイムアウトは 10 秒です。対応する設定を行ってください。
     * ReadTimeout をサーバー側の処理時間より短く設定すると、プログラムは ReadTimeout 例外を受け取ります。
     */
        ConnectTimeout: tea.Int(3000),
        ReadTimeout:    tea.Int(6000),
    }
    client, _err := green20220302.NewClient(config)
    if _err != nil {
        panic(_err)
    }

    // RuntimeObject インスタンスを作成し、実行時パラメーターを設定します。
    runtime := &util.RuntimeOptions{}
    runtime.ReadTimeout = tea.Int(10000)
    runtime.ConnectTimeout = tea.Int(10000)

    serviceParameters, _ := json.Marshal(
        map[string]interface{}{
            "url": "https://xxx.oss.aliyuncs.com/xxx.pdf",
        },
    )
    request := green20220302.FileModerationRequest{
        Service:           tea.String("document_detection_global"),
        ServiceParameters: tea.String(string(serviceParameters)),
    }

    result, _err := client.FileModerationWithOptions(&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("file moderation not success. code:%d\n", *body.Code)
        return
    }
    
    data := body.Data
    fmt.Printf("file moderation taskId:%s\n", *data.TaskId)
}

ドキュメント検出タスクの結果を取得

package main

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

func main() {
    // プロジェクトコードの漏洩は AccessKey の漏洩につながり、アカウント内のすべてのリソースのセキュリティを脅かす可能性があります。以下のコード例は参照用です。より安全な STS 方式を使用することを推奨します。
    config := &openapi.Config{
        /**
         * Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。RAM ユーザーを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
         * プロジェクトコードに AccessKey ID と AccessKey Secret を保存しないことを強く推奨します。そうしないと、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが損なわれる可能性があります。
         * 環境変数を取得する一般的な方法：
         * RAM ユーザーの AccessKey ID を取得：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
         * RAM ユーザーの AccessKey Secret を取得：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
         */
        AccessKeyId: tea.String("環境変数から RAM ユーザーの AccessKey ID を取得することを推奨します"),
        AccessKeySecret: tea.String("環境変数から RAM ユーザーの AccessKey Secret を取得することを推奨します"),
        RegionId: tea.String("ap-southeast-1"),
        Endpoint: tea.String("green-cip.ap-southeast-1.aliyuncs.com"),
        /**
     * タイムアウト期間を設定してください。サーバー側のフルリンク処理タイムアウトは 10 秒です。対応する設定を行ってください。
     * ReadTimeout をサーバー側の処理時間より短く設定すると、プログラムは ReadTimeout 例外を受け取ります。
     */
        ConnectTimeout: tea.Int(3000),
        ReadTimeout:    tea.Int(6000),
    }
    client, _err := green20220302.NewClient(config)
    if _err != nil {
    panic(_err)
    }

    // RuntimeObject インスタンスを作成し、実行時パラメーターを設定します。
    runtime := &util.RuntimeOptions{}
    runtime.ReadTimeout = tea.Int(10000)
    runtime.ConnectTimeout = tea.Int(10000)

    serviceParameters, _ := json.Marshal(
    map[string]interface{}{
    "taskId": "fi_f_O5z5iaIi******-1x****",
    },
    )
    request := green20220302.DescribeFileModerationResultRequest{
    Service:           tea.String("document_detection_global"),
    ServiceParameters: tea.String(string(serviceParameters)),
    }

    result, _err := client.DescribeFileModerationResultWithOptions(&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 == 280 {
    fmt.Printf("processing file moderation. code:%d\n", *body.Code)
    return
    }
    if *body.Code != http.StatusOK {
    fmt.Printf("file moderation result not success. code:%d\n", *body.Code)
    return
    }

    data := body.Data
    fmt.Printf("file moderation result:%s\n", data)
    fmt.Printf("file moderation result pageResult:%s\n", data.PageResult)
    fmt.Printf("file moderation result dataId:%s\n", data.DataId)
}

ローカルドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：

go git clone --branch v2.2.11 github.com/alibabacloud-go/green-20220302/v2

OSS SDK をインストールします：

go get github.com/aliyun/aliyun-oss-go-sdk/oss

Go SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得

OSS ドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：

go git clone --branch v2.2.11 github.com/alibabacloud-go/green-20220302/v2

Go SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得

Node.js SDK

ソースコードについては、「Node.js SDK ソースコード」をご参照ください。

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
npm install @alicloud/green20220302@2.2.10
```
Node.js SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
  ドキュメント検出タスクの結果を取得するためのサンプルコード

ローカルドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
npm install @alicloud/green20220302@2.2.10
```
OSS SDK をインストールします：
```
npm install ali-oss --save
```
Node.js SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
  ドキュメント検出タスクの結果を取得するためのサンプルコード

OSS ドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：
```
npm install @alicloud/green20220302@2.2.10
```
Node.js SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
  ドキュメント検出タスクの結果を取得するためのサンプルコード

C# SDK

ソースコードについては、「C# SDK ソースコード」をご参照ください。

この SDK は、以下の 3 種類のドキュメント検出をサポートしています。

パブリックアクセス可能なドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：

dotnet add package AlibabaCloud.SDK.Green20220302 --version 2.2.10

C# SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得するためのサンプルコード

ローカルドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：

dotnet add package AlibabaCloud.SDK.Green20220302 --version 2.2.10

OSS SDK をインストールします：

NuGet 経由でインストール 
1. Visual Studio に NuGet がインストールされていない場合は、まず NuGet をインストールします。
2. Visual Studio で、新しいプロジェクトを作成するか、既存のプロジェクトを開き、[ツール] > [NuGet パッケージ マネージャー] > [ソリューションの NuGet パッケージの管理] を選択します。
3. aliyun.oss.sdk を検索し、結果から Aliyun.OSS.SDK (.NET Framework 用) または Aliyun.OSS.SDK.NetCore (.Net Core 用) を見つけ、最新バージョンを選択して [インストール] をクリックします。

C# SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得するためのサンプルコード

OSS ドキュメントの検出

シナリオ

次のコマンドを実行して依存関係を追加します：

dotnet add package AlibabaCloud.SDK.Green20220302 --version 2.2.10

C# SDK を統合します。
- ドキュメント検出タスクを送信するためのサンプルコード
- ドキュメント検出タスクの結果を取得するためのサンプルコード

ネイティブ HTTPS 呼び出し

呼び出しメソッド
サービスリクエストエンドポイント：https://green-cip.{region}.aliyuncs.com
プロトコル：HTTPS
メソッド：POST

共通リクエストパラメーター

ドキュメントモデレーション拡張版 API の入力パラメーターには、共通リクエストパラメーターと API 固有の操作パラメーターが含まれます。共通リクエストパラメーターは、すべての API 操作に必要です。次の表に、共通リクエストパラメーターを示します。

名前	タイプ	必須	説明
Format	String	はい	レスポンスのフォーマット。有効な値： JSON (デフォルト) XML
Version	String	はい	YYYY-MM-DD 形式の API バージョン番号。現在のバージョンは 2022-03-02 です。
AccessKeyId	String	はい	サービスアクセス用に Alibaba Cloud がユーザーに発行した AccessKey ID。
Signature	String	はい	署名文字列。署名の計算方法については、以下の署名メソッドをご参照ください。
SignatureMethod	String	はい	署名メソッド。HMAC-SHA1 がサポートされています。
Timestamp	String	はい	リクエストのタイムスタンプ。日付形式は ISO 8601 標準に従い、UTC である必要があります。リクエストのタイムスタンプ。日付形式は ISO 8601 標準に従い、UTC を使用する必要があります。形式は yyyy-MM-ddTHH:mm:ssZ です。たとえば、2022 年 12 月 12 日 09:13:14 (UTC+08:00) は 2022-12-12T01:13:14Z と表されます。
SignatureVersion	String	はい	署名アルゴリズムのバージョン。値を 1.0 に設定します。
SignatureNonce	String	はい	リプレイ攻撃を防ぐために使用される一意の乱数。各リクエストに異なる乱数を使用します。
Action	String	はい	有効な値： FileModeration DescribeFileModerationResult

共通レスポンスパラメーター
API 呼び出しごとに、呼び出しが成功したかどうかに関係なく、システムは一意のリクエスト ID (RequestId) を返します。その他のレスポンスパラメーターは、呼び出す API 操作によって異なります。
```
{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}
```

コード例

以下のレスポンス例は、読みやすさのためにフォーマットされています。実際のレスポンスは、改行やインデントなしでフォーマットされます。

モデレーションタスクの例

リクエストの例

レスポンスの例

{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}

クエリタスクの例

リクエストの例

レスポンスの例

{
    "Code": 200,
    "Data": {
        "DataId": "fileId*****",
        "PageResult": [
            {
                "ImageResult": [
                    {
                        "Description": "ドキュメントページの画像コンテンツモデレーション",
                        "LabelResult": [
                            {
                                "label": "nonLabel"
                            }
                        ],
                        "Service": "baselineCheck"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/a.png",
                "PageNum": 1,
                "TextResult": [
                    {
                        "Description": "ドキュメントページのテキストコンテンツモデレーション",
                        "Labels": "",
                        "RiskTips": "",
                        "RiskWords": "",
                        "Service": "pgc_detection",
                        "Text": "Content Moderation 製品テストケース a"
                    }
                ]
            },
            ...
            {
                "ImageResult": [
                    {
                        "Description": "ドキュメントページの画像コンテンツモデレーション",
                        "LabelResult": [
                            {
                                "Confidence": 89.01,
                                "Label": "pornographic_adultContent_tii"
                            }
                        ],
                        "Service": "baselineCheck"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/b.png",
                "PageNum": 10,
                "TextResult": [
                    {
                        "Description": "ドキュメントページのテキストコンテンツモデレーション",
                        "Labels": "contraband,sexual_content",
                        "RiskTips": "prohibited_prohibited_goods,sexual_films,sexual_vulgar",
                        "RiskWords": "リスクワード A,リスクワード B",
                        "Service": "ad_compliance_detection",
                        "Text": "Content Moderation 製品テストケース b"
                    }
                ]
            }
        ],
        "Url": "http://www.aliyundoc.com/a.docx"
    },
    "Message": "SUCCESS",
    "RequestId": "1D0854A7-AAAAA-BBBBBBB-CC8292AE5"
}

署名メソッド
ドキュメントモデレーション拡張版サービスは、すべてのリクエストを認証します。したがって、各リクエストに署名情報を含める必要があります。このサービスは、AccessKey ID と AccessKey Secret を使用した対称暗号化を使用して、リクエスト送信者の ID を検証します。
AccessKey ID と AccessKey Secret は Alibaba Cloud によって発行されます。Alibaba Cloud のウェブサイトで申請および管理できます。AccessKey ID はユーザーを識別します。AccessKey Secret は、署名文字列を暗号化し、サーバーで署名文字列を検証するために使用されます。AccessKey Secret は機密情報として保持する必要があります。
リクエストに署名するには、次の手順を実行します：
1. リクエストパラメーターから正規化されたクエリ文字列を構築します。
  1. すべてのリクエストパラメーターをパラメーター名でアルファベット順にソートします。リクエストパラメーターには、共通パラメーターと API 固有のパラメーターが含まれますが、Signature パラメーターは除外されます。
  2. 各リクエストパラメーターの名前と値を UTF-8 で URL エンコードします。
    説明
    Java の java.net.URLEncoder などの URL エンコーディングライブラリは、通常、application/x-www-form-urlencoded MIME タイプのルールに従います。これらのライブラリをエンコーディングに使用できます。必要な形式を取得するには、エンコードされた文字列のプラス記号 (+) を %20 に、アスタリスク (*) を %2A に、%7E をチルダ (~) に置き換える必要があります。
    URL エンコーディングのルールは次のとおりです：
    大文字、小文字、数字、および次の文字はエンコードしないでください：ハイフン (-)、アンダースコア (_)、ピリオド (.)、チルダ (~)。
    他の文字は %XY 形式にエンコードします。XY は文字の ASCII コードの 16 進数表現です。たとえば、二重引用符 (") は %22 としてエンコードされます。
    拡張 UTF-8 文字は %XY%ZA… 形式にエンコードします。
    スペースはプラス記号 (+) ではなく、%20 としてエンコードします。
  3. エンコードされたパラメーター名とその値を等号 (=) で連結します。
  4. 結果の文字列をソートされた順序でアンパサンド (&) で連結して、正規化されたクエリ文字列を作成します。
2. ステップ a.i の正規化された文字列を使用して、次のルールに従って署名する文字列を作成します：
```
StringToSign=
HTTPMethod + "&" +
percentEncode("/") + "&" +
percentEncode(CanonicalizedQueryString)
```
  説明
  HTTPMethod は、POST などのリクエストに使用される HTTP メソッドです。percentEncode("/") は、スラッシュ (/) の URL エンコードされた値で、%2F です。percentEncode(CanonicalizedQueryString) は、前のステップで構築した URL エンコードされた正規化クエリ文字列です。
3. RFC 2104 で定義されているように、署名対象文字列の HMAC 値を計算します。
  説明
  署名を計算するためのキーは、AccessKey Secret の後に & 文字 (ASCII コード 38) を付けたものです。SHA1 ハッシュアルゴリズムが使用されます。
4. HMAC 値を Base64 でエンコードして署名を取得します。
5. 署名を Signature パラメーターとしてリクエストに追加して、署名プロセスを完了します。
  説明
  Content Moderation サーバーに署名を送信する場合、他のパラメーターと同様に、RFC 3986 に基づいて URL エンコードする必要があります。