tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Search by Image

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2024-02-02 16:51:03

Overview

This document provides an overview of APIs and SDK code samples for search by image.
API
Description
Enables the search by image feature for a bucket
Adds an image to the image library
Searches for an image in the image library
Removes an image from the image library

Enabling Search by Image

Feature description

This API is used to enable the search by image feature for a bucket.

Method prototype

boolean openImageSearch(OpenImageSearchRequest imageSearchRequest);

Sample request

//1. Create a job request object
OpenImageSearchRequest request = new OpenImageSearchRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("demobucket-123456789");
request.setMaxCapacity("100");
request.setMaxQps("10");
//3. Call the API to get the job response object
boolean response = client.openImageSearch(request);

Parameter description

Request has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
bucketName
Request
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String
Yes
maxCapacity
Request
Maximum capacity of the image library
String
Yes
MaxQps
Request
Maximum QPS of the image library
String
No

Response description

Success: true is returned upon success.
Failure: An error (such as the bucket does not exist) occurs, reporting the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Adding Image to Image Library

Feature description

This API is used to add an image to the image library.

Method prototype

boolean addGalleryImages(ImageSearchRequest imageSearchRequest);

Sample request

//1. Create a job request object
ImageSearchRequest request = new ImageSearchRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
request.setEntityId("mark1");
//3. Call the API to get the job response object
boolean response = client.addGalleryImages(request);

Parameter description

Request has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
bucketName
Request
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String
Yes
objectKey
Request
Location of the image in the bucket
String
Yes
entityId
Request
Entity ID, which can contain up to 64 characters. If EntityId already exists, this request will add the image to it.
String
Yes
customContent
Request
Custom content, which can contain up to 4,096 characters. The content set will be returned when the image is queried.
String
No
tags
Request
Custom image tags. The value is a JSON string containing up to 10 key:value pairs.
String
No

Response description

Success: true is returned upon success.
Failure: An error (such as the bucket does not exist) occurs, reporting the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Searching for Image

Feature description

This API is used to search for an image in the image library.

Method prototype

ImageSearchResponse searchGalleryImages(ImageSearchRequest imageSearchRequest);

Sample request

//1. Create a job request object
ImageSearchRequest request = new ImageSearchRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
//3. Call the API to get the job response object
ImageSearchResponse response = client.searchGalleryImages(request);

Parameter description

Request has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
bucketName
Request
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String
Yes
objectKey
Request
Location of the image in the bucket
String
Yes
matchThreshold
Request
Only images scoring higher than the value of MatchThreshold will be returned. Default value: 0.
String
No
Offset
Request
Starting number. Default value: 0.
String
No
limit
Request
Number of results to be returned. Default value: 10. Maximum value: 100.
String
No
filter
Request
Uses image tags to filter images. You can use AND and OR to set multiple conditions (>, >=, <, <=, =, !=).
String
No

Response description

Success: The ImageSearchResponse response object is returned upon success.
Failure: An error (such as the bucket does not exist) occurs, reporting the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Removing Image from Image Library

Feature description

This API is used to remove an image from the image library.

Method prototype

boolean deleteGalleryImages(ImageSearchRequest imageSearchRequest);

Sample request

//1. Create a job request object
ImageSearchRequest request = new ImageSearchRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
request.setEntityId("mark");
//3. Call the API to get the job response object
boolean response = client.deleteGalleryImages(request);

Parameter description

Request has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
bucketName
Request
Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview.
String
Yes
objectKey
Request
Location of the image in the bucket
String
Yes
entityId
Request
Entity ID
String
Yes

Response description

Success: true is returned upon success.
Failure: An error (such as the bucket does not exist) occurs, reporting the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan