All Products
Search
Document Center

Intelligent Media Management:InputFile

Last Updated:Oct 09, 2025
ParameterTypeDescriptionExample
object

The file that is used to create or update indexes. For information about how to create indexes, see IndexFileMeta . For information about how to update indexes, see UpdateFileMeta .

URIstring

The URI of the file for which you want to create or update an index in the request. This parameter is required. The URI can represent an object in Object Storage Service (OSS) or a file in Photo and Drive Service.

The OSS URI must be in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of the OSS bucket that is in the same region as the current project. ${Object} specifies the full file path that contains the object name extension.

The URI of a file in Photo and Drive Service must be in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.

Note URIs that start with HTTP are not supported.
oss://examplebucket/sampleobject.jpg
CustomIdstring

The custom ID of the file. This parameter is optional. When the metadata of the file is indexed into the dataset, the custom ID is stored as the data attribute. You can map the custom ID to other data in your business system. You can configure this parameter based on your business requirements. For example, you can associate a URI with an ID in your business system. We recommend that you set this parameter to a unique value.

This parameter supports prefix searches and sorting during queries. For more information, see Supported fields and operators.

member-image-id-0001
CustomLabelsobject

The custom labels of the file. This parameter is optional. The parameter stores custom key-value labels, which can be used to filter data. For more information, see Supported fields and operators.

{ "MemberName": "Tim", "Enabled": "True", "ItemCount": "10" }
FileHashstring

The file hash. In most cases, you can leave this parameter empty. This parameter is required only when the URI parameter specifies a file in Photo and Drive Service.

1d9c280a7c4f67f7ef873e28449dbe17
OSSURIstring

The path of the OSS object. In most cases, you can leave this parameter empty. You can specify this parameter only if the URI parameter specifies a file in Photo and Drive Service.

oss://test-bucket/test-object.jpg
MediaTypestring

In most cases, you can leave this parameter empty. The media type of the file.

Enumerated values:

  • image
  • other
  • document
  • archive
  • video
  • audio
image
ContentTypestring

In most cases, you can leave this parameter empty. The Multipurpose Internet Mail Extensions (MIME) type of the file.

image/jpeg
Figuresarray<object>

This parameter is optional. The persons. This parameter is used to remove a face from a face group or modify a face group. For more information, see Face clustering.

Note This parameter takes effect only for the UpdateFileMeta or BatchUpdateFileMeta operation.
Figuresobject

The object that stores the person information.

FigureIdstring

The person ID.

2cb3c51e-b406-4b0c-af1b-897d88e1****
FigureClusterIdstring

The ID of the face cluster. The following IDs of special face clusters are reserved:

  • figure-cluster-id-independent: indicates that the face does not belong to any face cluster. The face may be added to a face cluster in subsequent face clustering tasks after new images are added to the dataset.
  • figure-cluster-id-unavailable: indicates that the face has not been included in a face clustering task since a new image was added to the dataset.
Cluster-dbe72fec-b84c-4ab6-885b-3678e64****
FigureTypestring

The figure type. Set this parameter to face.

face
LatLongstring

The GPS latitude and longitude information.

30.134390,120.074997
ProduceTimestring

The time when the image was taken.

2021-06-29T14:50:13.011643661+08:00
Titlestring

The file title.

test
Artiststring

The artist.

Jane
AlbumArtiststring

The album artist.

Jane
Composerstring

The composer.

Jane
Performerstring

The performer.

Jane
Albumstring

The album.

FirstAlbum
Labelsarray

The intelligent labels.

LabelsLabel

The object that stores information about the intelligent label.

Addressesarray

The addresses.

AddressesAddress

The address information.