すべてのプロダクト
Search
ドキュメントセンター

Image Search:Node.js SDK

最終更新日:Jan 20, 2026

このトピックでは、Image Search の Node.js SDK の使用方法について説明し、サンプルコードを提供します。

メソッド

メソッド

説明

Add

1 つ以上の画像を追加します。

SearchImageByPic

画像に基づいて類似画像を検索します。

SearchImageByName

イメージギャラリー内の既存の画像名に基づいて類似画像を検索します。

Delete

1 つ以上の画像を削除します。

UpdateImage

画像を更新します。

Detail

インスタンスに関する情報を照会します。

DumpMeta

メタデータをエクスポートするタスクを作成します。

DumpMetaList

メタデータをエクスポートするために使用されるタスクを照会します。

BatchTask

バッチタスクを作成します。

BatchTaskList

バッチ操作を実行するために使用されるタスクを照会します。

CompareSimilarByImage

2 つの画像の類似度を比較します。

事前準備

  • Alibaba Cloud SDK をインストールして使用する前に、Alibaba Cloud アカウントを作成し、そのアカウントの AccessKey ペアを取得していることを確認してください。詳細については、「AccessKey ペアの作成」をご参照ください。

  • 次のコマンドを実行して、Image Search の Node.js SDK をインストールします。

npm install @alicloud/imagesearch20201214@4.2.3 --save

Add

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'});
    var picContent = fs.createReadStream("D:/123.jpg");
    async function demo() {
      const addImageAdvanceRequest = new imagesearch.AddImageAdvanceRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXX",
        // 必須。商品の ID。ID の長さは 256 文字を超えることはできません。
        // 1 つの商品 ID は複数の画像名に対応できます。
        productId: "123455",
        // 必須。画像名。名前の長さは最大 256 文字です。
        // 1. 必須。画像は商品 ID (ProductId) と画像名 (PicName) によって一意に識別されます。
        // 2. 商品 ID (productId) と画像名 (picName) が既存の画像と同じである画像を追加すると、新しく追加された画像が既存の画像を上書きします。
        picName: "this",
        // 画像。画像のサイズは 4 MB を超えることはできません。転送タイムアウト期間は 5 秒です。PNG、JPG、JPEG、BMP、GIF、WebP、TIFF、PPM の画像形式のみがサポートされています。
        // 商品および一般的な画像検索の場合、画像の長さと幅は 100 ピクセルから 4,096 ピクセルの範囲である必要があります。
        // 画像に回転プロパティを含めることはできません。
        picContentObject: picContent,
        // 任意。商品カテゴリの ID。
        // 1. 商品検索:カテゴリが指定されている場合、指定されたカテゴリが優先されます。カテゴリが指定されていない場合、システムはカテゴリを予測して選択します。システムによって選択されたカテゴリは応答に含まれます。
        // 2. 布地、ブランド、および一般的な画像検索の場合:カテゴリ ID が設定されているかどうかに関わらず、カテゴリ ID は 88888888 に設定されます。
        categoryId : 3,
        // 任意。追加したい説明。値は 4,096 文字を超えることはできません。
        // このパラメーターを設定すると、応答にこのパラメーターとその値が含まれます。画像の説明などのテキストを追加できます。
        customContent : "this is a simple test",
        // 任意。INT 型の属性。この属性は画像検索で画像をフィルターするために使用できます。このパラメーターを指定すると、応答にこのパラメーターとその値が含まれます。
        // 例えば、異なるサイトや異なるユーザーからの画像に異なる属性を設定できます。これにより、ユーザーは属性で画像をフィルターし、より正確な検索結果を得ることができます。
        intAttr : 56,
        // 任意。STRING 型の属性。値は 128 文字を超えることはできません。この属性は画像検索で画像をフィルターするために使用できます。このパラメーターを指定すると、応答にこのパラメーターとその値が含まれます。
        strAttr : "test",
        // 任意。画像内の主体を認識するかどうかを指定します。デフォルト値:true。
        // 1. このパラメーターを true に設定すると、システムは画像内の主体を認識し、認識された主体に基づいて画像を検索します。応答には認識結果が含まれます。
        // 2. このパラメーターを false に設定すると、システムは主体認識なしで画像全体に基づいて画像を検索します。
        crop : true,
        // 任意。画像の主体領域。フォーマットは x1,x2,y1,y2 です。具体的には、x1 と y1 は左上のピクセルを指定し、x2 と y2 は右下のピクセルを指定します。指定された領域は画像の境界を越えることはできません。
        // Region パラメーターを設定した場合、Crop パラメーターの値に関係なく、Region パラメーターの値に基づいて検索が実行されます。
        region : "167,467,221,407"
      });
      let ossRuntime = new oss.RuntimeOptions({});
      const addResponse = await client.addImageAdvance(addImageAdvanceRequest, ossRuntime);
      console.log(1, addResponse);
    }
    demo();
  • 応答例

    AddImageResponse {
      requestId: 'B85D5B4A-92AF-44C1-A3FB-9B554950F8D1',
      success: true,
      message: 'success',
      code: 0,
      picInfo: AddImageResponsePicInfo { categoryId: 0, region: '167,477,221,407' }
    }

SearchImageByPic

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    var picContent = fs.createReadStream("D:/123.jpg");
    async function demo() {
      const searchImageByPicAdvanceRequest = new imagesearch.SearchImageByPicAdvanceRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXX",
        // 画像。画像のサイズは 4 MB を超えることはできません。転送タイムアウト期間は 5 秒です。PNG、JPG、JPEG、BMP、GIF、WebP、TIFF、PPM の画像形式のみがサポートされています。
        // 商品および一般的な画像検索の場合、画像の長さと幅は 100 ピクセルから 4,096 ピクセルの範囲である必要があります。
        // 布地画像検索の場合、画像の長さと幅は 448 ピクセルから 4,096 ピクセルの範囲である必要があります。
        // 画像に回転プロパティを含めることはできません。
        picContentObject: picContent,
        // 任意。商品カテゴリの ID。
        // 1. 商品検索:カテゴリが指定されている場合、指定されたカテゴリが優先されます。カテゴリが指定されていない場合、システムはカテゴリを予測して選択します。システムによって選択されたカテゴリは応答に含まれます。
        // 2. 一般的な画像検索:カテゴリが指定されているかどうかに関わらず、カテゴリ ID は 88888888 に設定されます。
        categoryId: 3,
        // 任意。返されるエントリの数。有効値:1~100。デフォルト値:10
        num: 10,
        // 任意。返される最初のエントリの序数。有効値:0~499。デフォルト値:0。
        start: 0,
        // 任意。画像内の主体を認識するかどうかを指定します。デフォルト値:true。
        // 1. このパラメーターを true に設定すると、システムは画像内の主体を認識し、認識された主体に基づいて画像を検索します。応答には認識結果が含まれます。
        // 2. このパラメーターを false に設定すると、システムは主体認識なしで画像全体に基づいて画像を検索します。
        // 3. 布地画像検索の場合、このパラメーターは効果がありません。システムは画像全体に基づいて画像を検索します。
        crop: true,
        // 任意。画像の主体領域。フォーマットは x1,x2,y1,y2 です。具体的には、x1 と y1 は左上のピクセルを指定し、x2 と y2 は右下のピクセルを指定します。指定された領域は画像の境界を越えることはできません。
        // Region パラメーターを設定した場合、Crop パラメーターの値に関係なく、Region パラメーターの値に基づいて検索が実行されます。
        region: "167,467,221,407",
        // 任意。true に設定すると、応答データは ProductId パラメーターに基づいて返されます。
        distinctProductId: false,
        // 任意。フィルター条件。
        // int_attr は in、not in、>、>=、<、<=、= のオペレーターをサポートします。str_attr は in、not in、=、!= のオペレーターをサポートします。条件間の論理演算子として AND または OR を設定できます。
        // 例:
        // 1. INT 型の属性に基づいて画像をフィルターする:int_attr>=100。
        // 2. STRING 型の属性に基づいて画像をフィルターする:str_attr!="value1"。
        // 3. INT 型と STRING 型の属性に基づいて画像をフィルターする:int_attr=1000 AND str_attr="value1"。
        filter: "int_attr=56 AND str_attr=\"test\"",
        // 任意。類似度しきい値。
        // 類似度スコアのしきい値を指定した後、類似度スコアがしきい値以上の画像のみが返されます。しきい値の範囲は 0.00~1.00 で、小数点以下 2 桁までサポートされます。デフォルト値は 0.00 です。
        scoreThreshold: "0.54"
      });
      let ossRuntime = new oss.RuntimeOptions({});
      const searchImageByPicResponse = await client.searchImageByPicAdvance(searchImageByPicAdvanceRequest, ossRuntime);
      console.log(3, searchImageByPicResponse);
    }
    demo();
  • 応答例

    SearchImageByPicResponse {
      requestId: 'A38BFBD4-D7AD-4BE9-9606-72BB765A9001',
      success: true,
      code: 0,
      msg: 'success',
      auctions: [
        SearchImageByPicResponseAuctions {
          categoryId: 0,
          productId: '1000',
          picName: 'vae.jpg',
          score:1.0,
          sortExprValues: '7.33136443711219e+24;0'
        },
      ...............
        SearchImageByPicResponseAuctions {
          categoryId: 0,
          productId: '123455',
          picName: 'this',
          score:1.0,
          sortExprValues: '7.33136443711219e+24;0'
        }
      ],
      head: SearchImageByPicResponseHead {
        docsReturn: 5,
        docsFound: 5,
        searchTime: 218
      },
      picInfo: SearchImageByPicResponsePicInfo {
        categoryId: 0,
        region: '167,477,221,407',
        allCategories: [
          [SearchImageByPicResponsePicInfoAllCategories],
          ........
          [SearchImageByPicResponsePicInfoAllCategories]
        ],
        "multiRegion": [
           [SearchImageByPicResponseBodyPicInfoMultiRegion],
          ........
          [SearchImageByPicResponseBodyPicInfoMultiRegion]
        ]
      }
    }

SearchImageByName

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    var picContent = fs.createReadStream("D:/123.jpg");
    async function demo() {
      const searchImageByNameRequest = new imagesearch.SearchImageByNameRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXX",
        // 必須。商品の ID。ID の長さは 256 文字を超えることはできません。
        // 1 つの商品 ID は複数の画像名に対応できます。
        productId: "123455",
        // 必須。画像名。名前の長さは最大 256 文字です。
       // 1. 必須。画像は商品 ID (ProductId) と画像名 (PicName) によって一意に識別されます。
        picName: "this",
        // 任意。商品カテゴリの ID。
        // 1. 商品検索:カテゴリが指定されている場合、指定されたカテゴリが優先されます。カテゴリが指定されていない場合、システムはカテゴリを予測して選択します。システムによって選択されたカテゴリは応答に含まれます。
        // 2. 一般的な画像検索:カテゴリが指定されているかどうかに関わらず、カテゴリ ID は 88888888 に設定されます。
        categoryId: 3,
        // 任意。返されるエントリの数。有効値:1~100。デフォルト値:10
        num: 10,
        // 任意。返される最初のエントリの序数。有効値:0~499。デフォルト値:0。
        start: 0,
        // 任意。画像内の主体を認識するかどうかを指定します。デフォルト値:true。
        // 1. このパラメーターを true に設定すると、システムは画像内の主体を認識し、認識された主体に基づいて画像を検索します。応答には認識結果が含まれます。
        // 2. このパラメーターを false に設定すると、システムは主体認識なしで画像全体に基づいて画像を検索します。
        crop: true,
        // 任意。フィルター条件。
        // int_attr は in、not in、>、>=、<、<=、= のオペレーターをサポートします。str_attr は in、not in、=、!= のオペレーターをサポートします。条件間の論理演算子として AND または OR を設定できます。
        // 例:
        // 1. INT 型の属性に基づいて画像をフィルターする:int_attr>=100。
        // 2. STRING 型の属性に基づいて画像をフィルターする:str_attr!="value1"。
        // 3. INT 型と STRING 型の属性に基づいて画像をフィルターする:int_attr=1000 AND str_attr="value1"。
        filter: "int_attr=56 AND str_attr=\"test\"",
        // 任意。類似度しきい値。
        // 類似度スコアのしきい値を指定した後、類似度スコアがしきい値以上の画像のみが返されます。しきい値の範囲は 0.00~1.00 で、小数点以下 2 桁までサポートされます。デフォルト値は 0.00 です。
        scoreThreshold: "0.54"
      });
      const searchImageByNameResponse = await client.searchImageByName(searchImageByNameRequest);
      console.log(2, searchImageByNameResponse);
    }
    demo();
  • 応答例

    SearchImageByNameResponse {
      requestId: '4B039098-B274-41DE-9A55-32550B6F74E1',
      success: true,
      code: 0,
      msg: 'success',
      auctions: [
        SearchImageByNameResponseAuctions {
          categoryId: 0,
          productId: '1000',
          picName: 'vae.jpg',
          score:1.0,
          sortExprValues: '7.33136443711219e+24;0'
        },
          .........
        SearchImageByNameResponseAuctions {
          categoryId: 0,
          productId: '123455',
          picName: 'this',
          score:1.0,
          sortExprValues: '7.33136443711219e+24;0'
        }
      ],
      head: SearchImageByNameResponseHead {
        docsReturn: 5,
        docsFound: 5,
        searchTime: 11
      },
      picInfo: SearchImageByNameResponsePicInfo {
        categoryId: 0,
          allCategories: [
          [SearchImageByNameResponsePicInfoAllCategories],
          ......
          [SearchImageByNameResponsePicInfoAllCategories]
        ],
         "multiRegion": [
           [SearchImageByPicResponseBodyPicInfoMultiRegion],
          ........
          [SearchImageByPicResponseBodyPicInfoMultiRegion]
        ]
      }
    }

Delete

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function demo() {
      const deleteImageRequest = new imagesearch.DeleteImageRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX",
        // 必須。商品の ID。ID の長さは 256 文字を超えることはできません。
        // 1 つの商品 ID は複数の画像名に対応できます。
        productId: "123455",
        // 任意。画像名。このパラメーターを設定しない場合、システムは指定された商品 ID に関連するすべての画像を削除します。このパラメーターを設定した場合、システムは ProductId と PicName パラメーターで指定された画像のみを削除します。
        picName: "this",
        // 任意。値を true に設定すると、画像はフィルターによって削除されます。
        isDeleteByFilter: false,
        filter: "intattr3=xxx"
      });
      const deleteImageResponse = await client.deleteImage(deleteImageRequest);
      console.log(4, deleteImageResponse);
    }
    demo();
  • 応答例

    DeleteImageResponse {
      requestId: '3965B44B-0584-41DE-8764-0D8B36857CE1',
      success: true,
      message: 'success',
      code: 0
    }

UpdateImage

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function updateImage() {
      const request = new imagesearch.UpdateImageRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX",
        // 必須。商品の ID。商品 ID は変更できません。
        productId: "1",
        // 必須。画像の名前。画像名は変更できません。
        picName: "1",
        // 任意。INT 型の属性。この属性は画像検索で画像をフィルターするために使用できます。このパラメーターを指定すると、応答にこのパラメーターとその値が含まれます。
        intAttr: "11",
        // 任意。STRING 型の属性。値は 128 文字を超えることはできません。この属性は画像検索で画像をフィルターするために使用できます。このパラメーターを指定すると、応答にこのパラメーターとその値が含まれます。
        strAttr: "text",
        // 任意。追加したい説明。値は 4,096 文字を超えることはできません。
        customContent: "This is a sample description"
      });
      const response = await client.updateImage(request);
      console.log(4, response.body.toMap());
    }
    updateImage();
  • 応答例

    4 {
      Code: 0,
      RequestId: '1DD89D33-9D60-179A-9D3E-07CA381F07B5',
      Success: true
    }
                        

Detail

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function detail() {
      const request = new imagesearch.DetailRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX"
      });
      const response = await client.detail(request);
      console.log(4, response.body.toMap());
    }
    detail();
  • 応答例

    4 {
      Instance: {
        Capacity: 10,
        Name: 'xxxxxx',
        Qps: 1,
        Region: 'cn-shanghai',
        ServiceType: 0,
        TotalCount: 99999,
        UtcCreate: '1620382716000',
        UtcExpireTime: '1623081600000'
      },
      RequestId: '84ADF9D3-3668-1837-B0A9-ADB093F77DB2',
      Success: true
    }
                        

DumpMeta

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function dumpMeta() {
      const request = new imagesearch.DumpMetaRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX"
      });
      const response = await client.dumpMeta(request);
      console.log(4, response.body.toMap());
    }
    dumpMeta();
  • 応答例

    4 {
      Data: { DumpMetaStatus: 'PROCESSING', Id: '571' },
      RequestId: '8B639BD9-5EAB-127D-89EF-3EBE3277E02F',
      Success: true
    }
                        

DumpMetaList

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function dumpMetaList() {
      const request = new imagesearch.DumpMetaListRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX",
        // 任意。メタデータをエクスポートするために使用されるタスクの ID。
        id: 567,
        // 任意。返される最初のエントリの序数。デフォルト値:1。
        pageNumber: 1,
        // 任意。返されるエントリの数。デフォルト値:20。
        pageSize: 1
      });
      const response = await client.dumpMetaList(request);
      console.log(4, response.body.toMap());
      console.log(4, response.body.data.dumpMetaList);
    }
    dumpMetaList();
  • 応答例

    4 {
      Data: {
        DumpMetaList: [ [Object] ],
        PageNumber: 1,
        PageSize: 1,
        TotalCount: 1
      },
      RequestId: 'BFE47106-BF23-1581-A3AB-F3F54D8866BC'
    }
    4 [
      DumpMetaListResponseBodyDataDumpMetaList {
        code: '0',
        id: 567,
        metaUrl: 'https://xxx/xxx',
        msg: 'success',
        status: 'SUCCESS',
        utcCreate: '1639969113000',
        utcModified: 1639969140000
      }
    ]
    
                        

BatchTask

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function batchTask() {
      const request = new imagesearch.IncreaseInstanceRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX",
        // 必須。画像が Object Storage Service (OSS) バケットに保存されている場合は、バケット名を入力します。
        bucketName: "xxxx",
        // 必須。画像が保存されているパス。パスはスラッシュ (/) で始まり、スラッシュ (/) で終わることはできません。
        // 画像が保存されているパスに increment.meta という名前のファイルを作成します。詳細については、Image Search ドキュメントの「ユーザーガイド」章の「バッチ操作の実行」トピックをご参照ください。
        path: "/public/xxx",
        // 任意。呼び出しが成功した場合のコールバックアドレス。アドレスは文字列 http:// または https:// で始まる必要があります。
        callbackAddress: "http://xxx/xx"
      });
      const response = await client.increaseInstance(request);
      console.log(4, response.body.toMap());
    }
    batchTask();
  • 応答例

    4 {
      Data: { Id: '1474', IncrementStatus: 'PROCESSING' },
      RequestId: 'E2AF05CC-F642-1481-BD97-70DC7EBAF7C8',
      Success: true
    }
                        

BatchTaskList

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
      // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
      // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
      // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
      accessKeyId: process.env.CC_AK_ENV,
      accessKeySecret: process.env.CC_SK_ENV,
      type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    async function batchTaskList() {
      const request = new imagesearch.IncreaseListRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXXXXXXXXXX",
        // 必須。画像が OSS バケットに保存されている場合は、バケット名を入力します。
        bucketName: "xxxx",
        // 必須。画像が保存されているパス。パスはスラッシュ (/) で始まり、スラッシュ (/) で終わることはできません。
        path: "/public/xxx",
        // 任意。メタデータをエクスポートするために使用されるタスクの ID。
        id: 1464,
        // 任意。返される最初のエントリの序数。デフォルト値:1。
        pageNumber: 1,
        // 任意。返されるエントリの数。デフォルト値:20。
        pageSize: 1
      });
      const response = await client.increaseList(request);
      console.log(4, response.body.toMap());
      console.log(4, response.body.data.increments.toMap());
    }
    batchTaskList();
  • サンプル応答

    4 {
      Data: {
        Increments: { Instance: [Array] },
        PageNumber: 1,
        PageSize: 1,
        TotalCount: 1
      },
      RequestId: 'F51B5D0D-3E10-170B-88ED-79997736C6E8'
    }
    4 {
      Instance: [
        {
          BucketName: 'cccxxx',
          Code: '0',
          ErrorUrl: 'https://x/x',
          Id: 1464,
          Msg: 'success',
          Path: '/public/xxx',
          Status: 'NORMAL',
          UtcCreate: '1639107872000',
          UtcModified: 1639125540000
        }
      ]
    }
                        

CompareSimilarByImage

  • コード例

    const oss = require('@alicloud/oss-util');
    const fs = require('fs');
    const imagesearch = require('@alicloud/imagesearch20201214')
    // AccessKey ペアの作成方法については、https://www.alibabacloud.com/help/en/resource-access-management/latest/accesskey-pairs-create-an-accesskey-pair-for-a-ram-user をご参照ください。
    const client = new imagesearch.default({
        // Alibaba Cloud アカウントの AccessKey は、すべての API 操作を呼び出す権限を持っています。RAM ユーザーの AccessKey ペアを使用して API 操作を呼び出すか、日常の O&M を実行することを推奨します。
        // AccessKey ID と AccessKey Secret をプロジェクトコードにハードコーディングすることは推奨しません。ハードコーディングすると、AccessKey ペアが漏洩し、アカウント内のすべてのリソースのセキュリティが侵害される可能性があります。
        // この例では、AccessKey ID と AccessKey Secret を環境変数として保存します。ビジネス要件に応じて、設定ファイルに AccessKey ペアを保存することもできます。
        accessKeyId: process.env.CC_AK_ENV,
        accessKeySecret: process.env.CC_SK_ENV,
        type: "access_key",
      // ご利用の Image Search インスタンスが所在するリージョンのエンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch.ap-southeast-1.aliyuncs.com に設定します。
      endpoint: "imagesearch.ap-southeast-1.aliyuncs.com",
    
      // 以下のサンプルコードは、VPC エンドポイントを使用して Image Search API を呼び出す方法の例です。
      // 注:VPC エンドポイントは、同じリージョンにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。例えば、Image Search インスタンスがシンガポールにある場合、VPC エンドポイントはシンガポールにある ECS インスタンスまたはリソースからのみ Image Search API を呼び出すために使用できます。そうでない場合、API 操作の呼び出しは失敗します。API 呼び出しが失敗した場合は、Image Search API を呼び出す前に、ご利用の ECS インスタンスまたはリソースが Image Search インスタンスと同じリージョンにあるかどうかを確認してください。
      // endpointType : "internal",  // VPC エンドポイントを使用して Image Search API を呼び出す場合は、endpointType パラメーターを指定し、値を internal に設定する必要があります。
      // endpoint : "imagesearch-vpc.ap-southeast-1.aliyuncs.com", // Image Search API を呼び出すために使用される VPC エンドポイント。ご利用の Image Search インスタンスが所在するリージョンの VPC エンドポイントに値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、endpoint パラメーターを imagesearch-vpc.ap-southeast-1.aliyuncs.com に設定します。
    
      // ご利用の Image Search インスタンスが所在するリージョンの ID に値を置き換えてください。例えば、Image Search インスタンスがシンガポールにある場合、regionId パラメーターを ap-southeast-1 に設定します。
      regionId: "ap-southeast-1",
      protocol: 'http'
    });
    var primaryContent = fs.createReadStream("D:/123.jpg");
    var secondaryContent = fs.createReadStream("D:/123.jpg");
    
    async function demo() {
      const compareSimilarByImageAdvanceRequest = new imagesearch.CompareSimilarByImageAdvanceRequest({
        // 必須。Image Search インスタンスの名前。インスタンス ID ではなくインスタンス名を入力してください。Image Search インスタンスを購入後、Image Search コンソールのインスタンスリストページ (https://imagesearch.console.alibabacloud.com/overview) でインスタンス名を確認できます。
        instanceName: "XXXXXXXXXX",
        primaryPicContentObject: primaryContent,
        secondaryPicContentObject: secondaryContent
    
      });
      let ossRuntime = new oss.RuntimeOptions({});
      const compareSimilarResponse = await client.compareSimilarByImageAdvance(compareSimilarByImageAdvanceRequest, ossRuntime);
      console.log(1, compareSimilarResponse);
    }
    demo();
  • 応答例

    compareSimilarResponse {
      requestId: 'B85D5B4A-92AF-44C1-A3FB-9B554950F8D1',
      success: true,
      message: 'success',
      code: 0,
      Score: 1
    }