All Products
Search

This Product

    Intelligent Media Management:InputFile

    Document Center

    Intelligent Media Management:InputFile

    Last Updated:Aug 28, 2026

    Parameter

    Type

    Description

    Example

    object

    The file used to create or update indexes. To create indexes, see IndexFileMeta. To update indexes, see UpdateFileMeta.

    URI

    string

    Required. The URI of the file to index or update. Supports Object Storage Service (OSS) and Photo and Drive Service URIs.

    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://test-bucket/test-object
    CustomId

    string

    Optional. A custom ID for the file, stored as a data attribute when metadata is indexed into the dataset. Use this parameter to map a URI to 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
    CustomLabels

    object

    Optional. Custom key-value labels for the file, which can be used to filter data. For more information, see Supported fields and operators.

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

    string

    The file hash. Required only when URI specifies a file in Photo and Drive Service. In most cases, leave this parameter empty.

    1d9c280a7c4f67f7ef873e28449dbe17
    OSSURI

    string

    The OSS object path. Applicable only when URI specifies a file in Photo and Drive Service. In most cases, leave this parameter empty.

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

    string

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

    Enumerated values:

    • image

    • other

    • document

    • archive

    • video

    • audio

    image
    ContentType

    string

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

    image/jpeg
    Figures

    array

    Optional. The figures (persons) in the file. Use this parameter 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.

    object

    The person information.

    FigureId

    string

    The person ID.

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

    string

    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****

    FigureType

    string

    The figure type. Set this parameter to face.

    face
    LatLong

    string

    The GPS latitude and longitude.

    30.134390,120.074997
    ProduceTime

    string

    The time when the image was taken.

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

    string

    The file title.

    test
    Artist

    string

    The artist.

    Jane
    AlbumArtist

    string

    The album artist.

    Jane
    Composer

    string

    The composer.

    Jane
    Performer

    string

    The performer.

    Jane
    Album

    string

    The album.

    FirstAlbum
    Labels

    array

    The intelligent labels.

    Label

    The intelligent label information.

    Addresses

    array

    The addresses.

    Address

    The address information.