SmartCluster

Parameter

Type

Required

Example value

Description

SmartCluster

container

Yes

N/A

Contains the details of the SmartCluster.

child nodes: ObjectId, ClusterType, Name, Description, Rules, Reason, Notification, CreateTime, UpdateTime

ObjectId

String

Yes

cluster-abc123def456

The unique ID of the SmartCluster. The system assigns this ID when the SmartCluster is created. Use this ID for all subsequent query, update, and delete operations.

parent node: SmartCluster

ClusterType

String

Yes

figure

The type of clustering. Valid values:

• figure: face clustering.

• knowledge: semantic clustering of keywords.

parent node: SmartCluster

Name

String

Yes

face-cluster-alice

The name of the SmartCluster. The name must be unique within the Dataset and can be up to 128 characters in length.

parent node: SmartCluster

Description

String

No

Cluster faces matching Alice

The description text, up to 128 characters in length.

parent node: SmartCluster

Rules

container

Yes

N/A

Contains the list of clustering rules.

child node: Rule

parent node: SmartCluster

Rule

container

Yes

N/A

Contains a single clustering rule.

child nodes: RuleType, BaseURIs, Keywords, Sensitivity

parent node: Rules

RuleType

String

Yes

face

The type of clustering rule. Valid values:

• face: Performs face clustering based on reference face images. Use this rule type with ClusterType=figure.

• keywords: Performs semantic clustering based on keywords. Use this rule type with ClusterType=knowledge.

parent node: Rule

BaseURIs

String

No

oss://examplebucket/refs/alice.jpg

The OSS URI of a reference file, in the format oss://{bucket}/{key}. This parameter is required when RuleType is set to face. You can specify this element up to three times.

parent node: Rule

Keywords

String

No

car

A keyword for clustering. This parameter is required when RuleType is set to keywords. You can specify this element multiple times to provide multiple keywords.

parent node: Rule

Sensitivity

Float

No

0.7

The clustering sensitivity. The value must be in the range of [0, 1]. A higher value indicates a stricter match.

parent node: Rule

Reason

String

No

N/A

A description of the reason for a clustering task failure or exception. This field is empty if the task completes successfully.

parent node: SmartCluster

Notification

container

No

N/A

Contains settings for the notification sent when a clustering task completes.

child node: MNS

parent node: SmartCluster

MNS

container

No

N/A

Contains the MNS notification settings.

child node: TopicName

parent node: Notification

TopicName

String

No

imm-cluster-notification

The MNS topic name.

parent node: MNS

CreateTime

String

Yes

2026-05-20T11:00:00.000+08:00

The creation time of the SmartCluster, in RFC 3339 format.

parent node: SmartCluster

UpdateTime

String

Yes

2026-05-20T11:05:00.000+08:00

The last update time of the SmartCluster, in RFC 3339 format.

parent node: SmartCluster