API standards and multilingual preset SDKs
The OpenAPI of this product (imm/2020-09-30) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service regions
|
API |
Title |
Description |
| ListRegions | List of Regions Supporting IMM Service | Get the list of regions |
Project management
|
API |
Title |
Description |
| CreateProject | Create a project | Creates a project. |
| UpdateProject | Update a project | Updates the information of a created project. |
| GetProject | Query project information | Queries information about a specified project, including basic information and statistics information related to datasets and files. |
| ListProjects | Query all project information | Queries information about all projects, including basic information and statistics information related to datasets and files. |
| DeleteProject | DeleteProject | Deletes a project. |
Metadata management
|
API |
Title |
Description |
| Dataset management | Dataset management | |
| CreateDataset | Create a dataset | Creates a dataset. |
| UpdateDataset | Update a dataset | Updates the information of a dataset. |
| GetDataset | GetDataset | Queries a dataset. |
| ListDatasets | ListDatasets | Queries a list of datasets. You can query the list by dataset prefix. |
| DeleteDataset | DeleteDataset | Deletes a dataset. |
| Metadata indexing | Metadata indexing | |
| IndexFileMeta | IndexFileMeta | Performs data processing on input files for tasks such as label detection, face detection, and location detection. This operation extracts object metadata and creates an index, which lets you retrieve data from a dataset. |
| BatchIndexFileMeta | BatchIndexFileMeta | This operation performs a batch index of object metadata by processing input files for tasks such as label detection, face detection, and location detection. The object metadata is then indexed into a dataset to support various data retrieval methods. |
| UpdateFileMeta | UpdateFileMeta | Updates the partial metadata of the indexed files in a dataset. |
| BatchUpdateFileMeta | BatchUpdateFileMeta | Updates some metadata items of files indexed into a dataset. |
| GetFileMeta | GetFileMeta | Queries metadata of a file whose metadata is indexed into the dataset. |
| BatchGetFileMeta | BatchGetFileMeta | Queries metadata of multiple objects or files in the specified dataset. |
| DeleteFileMeta | DeleteFileMeta | Removes the metadata of a file from a dataset. |
| BatchDeleteFileMeta | BatchDeleteFileMeta | Deletes the metadata of multiple files from a dataset. |
| Query and statistics | Query and statistics | |
| SimpleQuery | SimpleQuery | Queries files in a dataset by performing a simple query operation. The operation supports logical expressions. |
| SemanticQuery | SemanticQuery | Queries metadata in a dataset by inputting natural language. |
| FuzzyQuery | FuzzyQuery | Queries the extracted file metadata, including the file name, labels, path, custom tags, and other fields. If the value of a metadata field of a file matches the specified string, the metadata of the file is returned. |
| Intelligent management | Intelligent management | |
| Face clustering | Face clustering | |
| CreateFigureClusteringTask | CreateFigureClusteringTask | Creates a figure clustering task. This task uses an intelligent algorithm to group the faces of different people in images that are indexed in a dataset. |
| CreateFigureClustersMergingTask | CreateFigureClustersMergingTask | Merges two or more figure clustering groups into a single figure clustering group. |
| GetFigureCluster | GetFigureCluster | Obtains basic information about face clustering, including the creation time, number of images, and cover. |
| QueryFigureClusters | QueryFigureClusters | Queries face groups based on given conditions. |
| BatchGetFigureCluster | BatchGetFigureCluster | Queries face clusters. |
| UpdateFigureCluster | UpdateFigureCluster | Updates information about a face cluster, such as the cluster name and labels. |
| SearchImageFigureCluster | SearchImageFigureCluster | Queries face clusters that contain a specific face in an image. Each face cluster contains information such as bounding boxes and similarity. |
| CreateFacesSearchingTask | CreateFacesSearchingTask | Searches a media set for the top N images most similar to a specified image or face ID. The operation returns the corresponding face IDs and bounding boxes, sorted by similarity in descending order. |
| Spatiotemporal clustering | Spatiotemporal clustering | |
| CreateLocationDateClusteringTask | CreateLocationDateClusteringTask | The spatio-temporal clustering feature classifies files in a dataset based on their time and location. This feature works on indexed files, such as images and videos, that contain shooting time and location data. These classifications can represent content from a user's trip, where files have similar timestamps and locations. The classifications can also represent content shot at different places where a user lives or works. Analyzing the locations and time ranges of these classifications lets you categorize media files, create highlight reels, and generate photo and video stories. |
| QueryLocationDateClusters | QueryLocationDateClusters | Queries a list of spatiotemporal clusters based on the specified conditions. |
| UpdateLocationDateCluster | UpdateLocationDateCluster | Updates a spatiotemporal cluster. |
| DeleteLocationDateCluster | DeleteLocationDateCluster | Deletes a spatiotemporal cluster. |
| Stories | Stories | |
| CreateStory | CreateStory | Creates a story. |
| QueryStories | QueryStories | Queries stories based on the specified conditions. |
| GetStory | GetStory | Queries a story. |
| CreateCustomizedStory | CreateCustomizedStory | Creates a story based on the specified images and videos. |
| UpdateStory | UpdateStory | Updates the information about a story, such as the story name and cover image. |
| AddStoryFiles | AddStoryFiles | Adds objects to a story. |
| RemoveStoryFiles | RemoveStoryFiles | Deletes files from a story. |
| DeleteStory | DeleteStory | Deletes a story. |
| Image clustering | Image clustering | |
| CreateSimilarImageClusteringTask | CreateSimilarImageClusteringTask | The similar image clustering feature groups images that you have indexed in a dataset into clusters based on visual similarity. This feature is useful for scenarios such as deduplicating images or selecting the best shots. For example, you can use it to filter burst photos in an album. |
| QuerySimilarImageClusters | QuerySimilarImageClusters | You can call this operation to query the list of similar image clusters. |
| Data binding | Data binding | |
| CreateBinding | CreateBinding | Creates a binding relationship between a dataset and an Object Storage Service (OSS) bucket. This allows for the automatic synchronization of incremental and full data and indexing. |
| GetBinding | GetBinding | Queries the binding relationship between a specific dataset and an Object Storage Service (OSS) bucket. |
| ListBindings | Query the list of bindings | Query the list of bindings between datasets and Object Storage Service (OSS) buckets. |
| DeleteBinding | DeleteBinding | Deletes the binding between a dataset and an Object Storage Service (OSS) bucket. |
| AttachOSSBucket | AttachOSSBucket | Binds an Object Storage Service (OSS) bucket to the specified project. The binding enables you to use IMM features by using the x-oss-process parameter. |
| DetachOSSBucket | DetachOSSBucket | Unbinds an Object Storage Service (OSS) bucket from the corresponding project. |
| GetOSSBucketAttachment | Get OSS bucket binding information | Retrieves the project name of a project that is bound to a specified OSS bucket in the same region. |
Image processing
|
API |
Title |
Description |
| EncodeBlindWatermark | EncodeBlindWatermark | Embeds specific textual information into an image as watermarks. These watermarks are visually imperceptible and do not affect the aesthetics of the image or the integrity of the original data. The watermarks can be extracted by using the CreateDecodeBlindWatermarkTask operation. |
| CreateDecodeBlindWatermarkTask | CreateDecodeBlindWatermarkTask | Extracts a blind watermark. |
| GetDecodeBlindWatermarkResult | Get blind watermark extraction task result | Retrieves the result of a blind watermark extraction task for an image. |
| DetectImageLabels | DetectImageLabels | Detects scene, object, and event information in an image. Scene information includes natural landscapes, daily life, and disasters. Event information includes talent shows, office events, performances, and production events. Object information includes tableware, electronics, furniture, and transportation. The DetectImageLabels operation supports more than 30 different categories and thousands of labels. |
| DetectImageScore | DetectImageScore | Calculates the aesthetics quality score of an image based on metrics such as the composition, brightness, contrast, color, and resolution. The operation returns a score within the range from 0 to 1. A higher score indicates better image quality. |
| DetectImageCodes | DetectImageCodes | Detects barcodes and QR codes in an image. |
| DetectImageFaces | DetectImageFaces | Detects faces from an image, including face boundary information, attributes, and quality. The boundary information includes the distance from the y-coordinate of the vertex to the top edge (Top), distance from the x-coordinate of the vertex to the left edge (Left), height (Height), and width (Width). Face attributes include the age (Age), age standard deviation (AgeSD), gender (Gender), emotion (Emotion), mouth opening (Mouth), beard (Beard), hat wearing (Hat), mask wearing (Mask), glasses wearing (Glasses), head orientation (HeadPose), attractiveness (Attractive), and confidence levels for preceding attributes. Quality information includes the face quality score (FaceQuality) and face resolution (Sharpness). |
| DetectImageCropping | Detect optimal image cropping regions by using AI model capabilities | Detects visually optimal cropping regions in an image at a specified aspect ratio by using AI model capabilities. |
| AddImageMosaic | AddImageMosaic | Adds mosaics, Gaussian blurs, or solid color shapes to blur one or more areas of an image for privacy protection and saves the output image to the specified path in Object Storage Service (OSS). |
| CreateImageToPDFTask | CreateImageToPDFTask | Converts multiple images into a single PDF file and saves the file as a specified OSS object. |
| CreateImageSplicingTask | CreateImageSplicingTask | Stitches multiple images into a single image based on specified rules and saves the output to a specified OSS object. |
| CompareImageFaces | CompareImageFaces | Compares the similarity of the largest faces in two images. The largest face refers to the largest face frame in an image after face detection. |
| DetectImageBodies | DetectImageBodies | Detects human body information, such as the confidence level and body bounding box, in an image. |
| DetectImageCars | DetectImageCars | Detects the outline data, attributes, and license plate information of vehicles in an image. The vehicle attributes include the vehicle color (CarColor) and vehicle type (CarType). The license plate information includes the recognition content (Content) and plate frame (Boundary). |
| DetectImageTexts | DetectImageTexts | Recognizes and extracts text content from an image. |
Media processing
|
API |
Title |
Description |
| CreateMediaConvertTask | Create Media Transcoding Task | Create an asynchronous media transcoding task. This task processes audio and video files for media transcoding, media concatenation, video frame capture, and animated GIF generation. |
| DetectMediaMeta | Retrieve media file metadata | Retrieves the metadata of a media file, including media format information and media stream information. |
| CreateVideoLabelClassificationTask | CreateVideoLabelClassificationTask | Detects labels for scenarios, objects, and events in video content. This feature supports more than 30 categories and thousands of labels. Scenario labels include natural landscapes, life scenes, and disaster scenes. Event labels include talent shows, office work, performances, and production. Object labels include tableware, electronic products, furniture, and vehicles. |
| GetVideoLabelClassificationResult | Get video label detection task | Retrieves the result of a video label detection task. |
| GenerateVideoPlaylist | Generate a just-in-time transcoding playlist | Creates a just-in-time transcoding playlist that generates an M3U8 file from a video file. The playlist can be played immediately after generation, and transcoding is performed on demand based on playback progress. Compared with offline transcoding, this significantly reduces transcoding wait time and substantially lowers transcoding and storage costs. |
| CreateHighlightTask | Create a video highlight clipping task | Creates a video highlight task. This feature is in invitational preview. |
Document processing
|
API |
Title |
Description |
| GenerateWebofficeToken | Retrieve weboffice credentials | Retrieves the preview and editing credentials for a document. |
| RefreshWebofficeToken | Refresh a weboffice token | Refreshes a Weboffice access token. A Weboffice access token is valid for 30 minutes. After it expires, you can no longer access Weboffice. To continue accessing Weboffice, call this operation to refresh the Weboffice access token and obtain a new token that is also valid for 30 minutes. |
| CreateOfficeConversionTask | CreateOfficeConversionTask | Creates a document conversion task that converts documents, such as Word, PowerPoint, Excel, and PDF files, stored in Object Storage Service (OSS) into images, text files, or PDF files. |
| ExtractDocumentText | Extract Document Text | Extract text from the document |
File processing
|
API |
Title |
Description |
| Compression and decompression | Compression and decompression | |
| CreateFileCompressionTask | CreateFileCompressionTask | Package Download API |
| CreateArchiveFileInspectionTask | CreateArchiveFileInspectionTask | Creates a task to inspect a compressed file and retrieve a list of its contents without decompressing the file. |
| CreateFileUncompressionTask | CreateFileUncompressionTask | A file decompression task lets you decompress specific files or an entire compressed package to a specified location. Supported formats include Zip, RAR, and 7z. |
| Point cloud compression | Point cloud compression | |
| CreateCompressPointCloudTask | Create a point cloud compression task | Compresses point cloud data stored in Object Storage Service (OSS) to reduce network data transmission. |
Content security
|
API |
Title |
Description |
| DetectTextAnomaly | DetectTextAnomaly | Detects whether specified text contains anomalies, such as pornography, advertisements, excessive junk content, politically sensitive content, and abuse. |
| CreateImageModerationTask | CreateImageModerationTask | Detects non-compliant content in images, such as pornography, terrorism, undesirable scenes, logos, and text-in-image violations. |
| CreateVideoModerationTask | CreateVideoModerationTask | Detects threats or non-compliant content in videos. This operation can be used in scenarios such as pornography detection, terrorism and politically sensitive content detection, text and image violation detection, undesirable scene detection, and logo detection. |
| GetImageModerationResult | Retrieve an image content moderation task | Retrieves an image content moderation task. |
| GetVideoModerationResult | Retrieve a video content moderation task | Retrieves a video content moderation task. |
Task management
|
API |
Title |
Description |
| GetTask | Retrieve task information | Queries the information about a specified asynchronous task. Intelligent Media Management (IMM) supports various asynchronous data processing capabilities, each with its own task creation operation, such as CreateFigureClusteringTask for creating figure clustering tasks and CreateFileCompressionTask for creating file compression tasks. This operation is a general-purpose operation that allows you to query the details of an asynchronous task by task ID and type. |
| ListTasks | ListTasks | Lists tasks based on specific conditions, such as by time range and by tag. |
| Triggers | Triggers | |
| CreateTrigger | CreateTrigger | Creates a trigger to start data processing in Intelligent Media Management (IMM). The trigger is activated by event sources, such as Object Storage Service (OSS), and uses data processing templates to process media files, such as images, videos, and documents. |
| SuspendTrigger | SuspendTrigger | Suspends a running trigger. |
| ResumeTrigger | ResumeTrigger | Resumes a trigger that is in the Suspended or Failed state. |
| UpdateTrigger | UpdateTrigger | Updates information about a trigger, such as the input data source, data processing settings, and tags. |
| GetTrigger | GetTrigger | Queries the information about a trigger. |
| ListTriggers | ListTriggers | Queries triggers by tag or status. |
| DeleteTrigger | DeleteTrigger | Deletes a trigger. |
| Batch processing | Batch processing | |
| CreateBatch | CreateBatch | Creates a batch processing task that performs specified operations, such as transcoding and format conversion, on multiple existing files. |
| SuspendBatch | SuspendBatch | Suspends a batch processing task. |
| ResumeBatch | ResumeBatch | Resumes a batch processing task that is in the Suspended or Failed state. |
| UpdateBatch | UpdateBatch | Updates information for a batch processing task, such as the data source configuration, data processing configuration, and tags. |
| ListBatches | ListBatches | Queries batch processing tasks. You can query batch processing tasks based on conditions such task tags and status. The results can be sorted. |
| GetBatch | GetBatch | Queries the information about a batch processing task. |
| DeleteBatch | DeleteBatch | Deletes a batch processing task. |
Others
|
API |
Title |
Description |
| ContextualAnswer | Q\&A API in AI Assistant | Phase II of AI Assistant, Q\&A API |
| ContextualRetrieval | ContextualRetrieval | Retrieves semantically similar documents. The operation is designed for multi-turn conversations and can process message input in historical conversations. The operation returns results that are highly related to the current conversation based on an in-depth understanding of contextual content. It provides consistent and efficient information retrieval in multi-turn conversations. |
| ListAttachedOSSBuckets | List OSS Bucket Binding Relationships | List bound attachments |