Add similar graph samples

更新时间:
复制 MD 格式

This topic describes how to use the .NET SDK to add a specific image sample to an image library.

Feature description

When you add an image sample, you can set tags for it. If a search finds the sample image, its tags are also returned. For more information about the parameters, see AddSimilarityImage API documentation.

You must use the AI Guardrails endpoint to call the service using the SDK. For more information about API endpoints, see Endpoints.

Note
  • This SDK supports only image URLs. It does not support local files or binary data.

  • The following types of URLs are supported:

    • Public HTTP and HTTPS URLs. The URLs cannot exceed 2,048 characters in length.

    • Alibaba Cloud Object Storage Service (OSS) URLs in the format of oss://<bucket-name>.<endpoint>/<object-name>. You must grant AI Guardrails the required permissions to access the destination OSS bucket. The bucket and the AI Guardrails service must be in the same region. For more information, see Authorize AI Guardrails to access OSS buckets.

Prerequisites

The .NET dependencies must be installed. For instructions, see Install .NET dependencies.

Note

You must use the required .NET version described in the Installation topic to install the dependencies. Otherwise, subsequent operation calls fail.

Add an image sample task

using System;
using Newtonsoft.Json;
using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Http;
using Aliyun.Acs.Core.Profile;
using Aliyun.Acs.Green.Model.V20180509;
using System.Collections.Generic;

namespace csharp_sdk_sample
{
    class Program
    {
        static void Main(string[] args)
        {
            /**
             * Common ways to obtain environment variables:
             *     Obtain the AccessKey ID of a Resource Access Management (RAM) user: Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID");
             *     Obtain the AccessKey secret of a RAM user: Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
             */
            DefaultProfile profile = DefaultProfile.GetProfile(
                    "cn-shanghai",
                    "Obtain the AccessKey ID of a RAM user from an environment variable.",
                    "Obtain the AccessKey secret of a RAM user from an environment variable.");
            DefaultAcsClient client = new DefaultAcsClient(profile);

            AddSimilarityImageRequest request = new AddSimilarityImageRequest();
            request.AcceptFormat = FormatType.JSON;
            request.ContentType = FormatType.JSON;
            request.Method = MethodType.POST;
            request.Encoding = "UTF-8";

            Dictionary<string, object> task = new Dictionary<string, object>();
            task.Add("dataId", "Data ID");
            task.Add("url", "Sample image URL");
            task.Add("tag", new List<string> { "Custom Tag 1", "Custom Tag 2", "Custom Tag 3" });

            Dictionary<string, object> httpBody = new Dictionary<string, object>();
            httpBody.Add("name", "Name of the image library for image search");
           httpBody.Add("tasks", new List<Dictionary<string, object>> { task });

            request.SetContent(System.Text.Encoding.Default.GetBytes(JsonConvert.SerializeObject(httpBody)), "utf-8", FormatType.JSON);
            try
            {
                AddSimilarityImageResponse response = client.GetAcsResponse(request);
                if (response.HttpResponse.Status != 200)
                {
                    Console.WriteLine("the request failed. status:{0}", response.HttpResponse.Status);
                }
                Console.WriteLine(System.Text.Encoding.Default.GetString(response.HttpResponse.Content));
            }
            catch (Exception ex)
            {
                Console.WriteLine("Failed with error info: {0}", ex.Message);
            }
        }
    }
}