Find Images By Tags

Introduction

This article explains how to find images by tags.

The API URL is: POST /imaging/ai/imageSearch/{searchContextId}/findByTags

Resource URI

Swagger UI lets you call Aspose.Imaging REST APIs directly from the browser. The description of the APIs and their parameters are also given there.

cURL Example

Request


// First get Access Token
// Get App Key and App SID from https://dashboard.aspose.cloud/

curl -v "https://api.aspose.cloud/oauth2/token" \
-X POST \
-d 'grant_type=client_credentials&client_id=xxxx&client_secret=xxxx' \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"



// cURL example to find images by tags

curl -v "https://api.aspose.cloud/v2/imaging/ai/imageSearch/cc435948-2dc3-4269-9299-052baa314d72/findByTags?similarityThreshold=90.0&maxCount=10" \
-X POST \
-d '["MyTag"]' \
-H "Content-Type: application/json" \
-H "Accept: multipart/form-data" \
-H "Authorization: Bearer <access_token>"

Response


{

  "Results": [



  ],

  "Code": 200,

  "Status": "OK"

}

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of Aspose.Imaging SDKs along with working examples, to get you started in no time.

SDK Examples

.NET

	// For complete examples and data files, please go to https://github.com/aspose-imaging-cloud/aspose-imaging-cloud-dotnet
	public void FindSimilarImagesByTag()
	{
	// Create new search context
	string searchContextId = this.CreateImageSearch();

	string ImageToFindByTag = "ComparingImageSimilar75.jpg";
	string ImagesPath = @"FindSimilar\";

	string fileName = ImageToFindByTag;
	FileStream inputImageStream = File.OpenRead(ImagingBase.PathToDataFiles + fileName);

	this.CreateImageFeatures(ImagesPath.TrimEnd('\\'), true, searchContextId);

	string tagName = "ImageTag";
	double? similarityThreshold = 60;
	int? maxCount = 5;
	string folder = null; // Path to input files
	string storage = null; // We are using default Cloud Storage

	this.ImagingApi.CreateImageTag(
	new CreateImageTagRequest(inputImageStream, searchContextId, tagName, folder, storage));

	var tags = JsonConvert.SerializeObject(new[] { tagName});
	SearchResultsSet searchResultsSet = this.ImagingApi.FindImagesByTags(
	new FindImagesByTagsRequest(tags, searchContextId, similarityThreshold, maxCount, storage: storage));

	// Process search results
	foreach (SearchResult searchResult in searchResultsSet.Results)
	{
	Console.WriteLine("ImageName: " + searchResult.ImageId +
	", Similarity: " + searchResult.Similarity);
	}

	// Delete the search context
	this.DeleteImageSearch(searchContextId);
	}

view raw FindSimilarImagesByTag.cs hosted with ❤ by GitHub

Java

	String APP_KEY = ""; // Get AppKey and AppSID from https:dashboard.aspose.cloud/
	String APP_SID = ""; // Get AppKey and AppSID from https:dashboard.aspose.cloud/
	String DATA_PATH = "src/main/resources/";

	ImagingApi imagingApi = new ImagingApi(APP_KEY, APP_SID);

	try {
	String tag = "MyTag";
	String searchContextId = "5728a4ed-12bb-4b4a-8dce-38295735549f";
	Double similarityThreshold = 90.0;
	Integer maxCount = 10;
	String folder = null; // Folder with image to process
	String storage = null; // We are using default Cloud Storage

	// Serialize search tags collection to JSON
	List<String> tagsList = new ArrayList<String>();
	tagsList.add(tag);
	String tags = new Gson().toJson(tagsList);

	// Search images by tags
	SearchResultsSet result = imagingApi.postSearchContextFindByTags(
	new PostSearchContextFindByTagsRequest(tags, searchContextId, similarityThreshold, maxCount,
	folder, storage));

	// Process search results
	for (SearchResult searchResult : result.getResults())
	{
	System.out.println("ImageName: " + searchResult.getImageId() +
	", Similarity: " + searchResult.getSimilarity());
	}
	} catch (Exception e) {
	System.out.println(e.getMessage());
	}

view raw SearchImagesByTags.java hosted with ❤ by GitHub

Find Duplicate Images Add Tag and Reference Image to Search Context