All Products
Search
Document Center

Intelligent Media Management:InputFile

Last Updated:Dec 11, 2024
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 in which you want to create or update an index in the request. This parameter is required. URIs of the Object Storage Service (OSS) and Photo and Drive Service (PDS) types are supported.

The OSS path 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 file name extension.

The PDS path must be in the pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision} format.

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

The custom ID of the file. This parameter is optional. After you create an index for a file and add the index to a dataset, the index is stored as a part of metadata and is used to associate the dataset with 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. A custom label stores custom key names and key-value pairs that you can use to search for specific information during queries. 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 is a PDS path.

1d9c280a7c4f67f7ef873e28449dbe17
OSSURIstring

The path of the OSS file. In most cases, you can leave this parameter empty. This parameter is required only when the URI is a PDS path.

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

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

Valid values:

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

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

image/jpeg
Figuresarray<object>

The figures that you want to update. This parameter is optional. 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 figure.

FigureIdstring

The figure ID.

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

The ID of the face clustering task. The following IDs of special face clustering tasks are reserved:

  • figure-cluster-id-independent: the ID of a face clustering task in which faces do not belong to any face group. After images are added to a dataset, the faces may be categorized into different face groups when you perform face clustering.
  • figure-cluster-id-unavailable: the ID of a face clustering task in which face clustering is not performed after images are added to a 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 singer.

Jane
Composerstring

The composer.

Jane
Performerstring

The player.

Jane
Albumstring

The album.

FirstAlbum
Labelsarray

The intelligent labels.

LabelsLabel

The intelligent label.

Addressesarray

The addresses.

AddressesAddress

The address.