'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'imm', 'version' => '2020-09-30', ], 'directories' => [ [ 'id' => 178523, 'title' => '服务地域', 'type' => 'directory', 'children' => [ 'ListRegions', ], ], [ 'id' => 178609, 'title' => '项目管理', 'type' => 'directory', 'children' => [ 'CreateProject', 'UpdateProject', 'GetProject', 'ListProjects', 'DeleteProject', ], ], [ 'id' => 178610, 'title' => '元数据管理', 'type' => 'directory', 'children' => [ [ 'id' => 178611, 'title' => '数据集管理', 'type' => 'directory', 'children' => [ 'CreateDataset', 'UpdateDataset', 'GetDataset', 'ListDatasets', 'DeleteDataset', ], ], [ 'id' => 178612, 'title' => '元数据索引', 'type' => 'directory', 'children' => [ 'IndexFileMeta', 'BatchIndexFileMeta', 'UpdateFileMeta', 'BatchUpdateFileMeta', 'GetFileMeta', 'BatchGetFileMeta', 'DeleteFileMeta', 'BatchDeleteFileMeta', ], ], [ 'id' => 178699, 'title' => '查询与统计', 'type' => 'directory', 'children' => [ 'SimpleQuery', 'SemanticQuery', 'FuzzyQuery', ], ], [ 'id' => 178700, 'title' => '智能管理', 'type' => 'directory', 'children' => [ [ 'id' => 178701, 'title' => '人脸聚类', 'type' => 'directory', 'children' => [ 'CreateFigureClusteringTask', 'CreateFigureClustersMergingTask', 'GetFigureCluster', 'QueryFigureClusters', 'BatchGetFigureCluster', 'UpdateFigureCluster', 'SearchImageFigureCluster', 'CreateFacesSearchingTask', ], ], [ 'id' => 178702, 'title' => '时空聚类', 'type' => 'directory', 'children' => [ 'CreateLocationDateClusteringTask', 'QueryLocationDateClusters', 'UpdateLocationDateCluster', 'DeleteLocationDateCluster', ], ], [ 'id' => 178703, 'title' => '故事', 'type' => 'directory', 'children' => [ 'CreateStory', 'QueryStories', 'GetStory', 'CreateCustomizedStory', 'UpdateStory', 'AddStoryFiles', 'RemoveStoryFiles', 'DeleteStory', ], ], [ 'id' => 181692, 'title' => '图片聚类', 'type' => 'directory', 'children' => [ 'CreateSimilarImageClusteringTask', 'QuerySimilarImageClusters', ], ], ], ], [ 'id' => 178704, 'title' => '数据绑定', 'type' => 'directory', 'children' => [ 'CreateBinding', 'GetBinding', 'ListBindings', 'DeleteBinding', 'AttachOSSBucket', 'DetachOSSBucket', 'GetOSSBucketAttachment', ], ], ], ], [ 'id' => 178705, 'title' => '图片处理', 'type' => 'directory', 'children' => [ 'EncodeBlindWatermark', 'CreateDecodeBlindWatermarkTask', 'GetDecodeBlindWatermarkResult', 'DetectImageLabels', 'DetectImageScore', 'DetectImageCodes', 'DetectImageFaces', 'DetectImageCropping', 'AddImageMosaic', 'CreateImageToPDFTask', 'CreateImageSplicingTask', 'CompareImageFaces', 'DetectImageBodies', 'DetectImageCars', 'DetectImageTexts', ], ], [ 'id' => 178706, 'title' => '媒体处理', 'type' => 'directory', 'children' => [ 'CreateMediaConvertTask', 'DetectMediaMeta', 'CreateVideoLabelClassificationTask', 'GetVideoLabelClassificationResult', 'GenerateVideoPlaylist', ], ], [ 'id' => 178707, 'title' => '文档处理', 'type' => 'directory', 'children' => [ 'GenerateWebofficeToken', 'RefreshWebofficeToken', 'CreateOfficeConversionTask', 'ExtractDocumentText', ], ], [ 'id' => 178708, 'title' => '文件处理', 'type' => 'directory', 'children' => [ [ 'id' => 178709, 'title' => '压缩解压', 'type' => 'directory', 'children' => [ 'CreateFileCompressionTask', 'CreateArchiveFileInspectionTask', 'CreateFileUncompressionTask', ], ], [ 'id' => 178710, 'title' => '点云压缩', 'type' => 'directory', 'children' => [ 'CreateCompressPointCloudTask', ], ], ], ], [ 'id' => 178711, 'title' => '内容安全', 'type' => 'directory', 'children' => [ 'DetectTextAnomaly', 'CreateImageModerationTask', 'CreateVideoModerationTask', 'GetImageModerationResult', 'GetVideoModerationResult', ], ], [ 'id' => 178712, 'title' => '任务管理', 'type' => 'directory', 'children' => [ 'GetTask', 'ListTasks', [ 'id' => 178931, 'title' => '触发器', 'type' => 'directory', 'children' => [ 'CreateTrigger', 'SuspendTrigger', 'ResumeTrigger', 'UpdateTrigger', 'GetTrigger', 'ListTriggers', 'DeleteTrigger', ], ], [ 'id' => 180710, 'title' => '批处理', 'type' => 'directory', 'children' => [ 'CreateBatch', 'SuspendBatch', 'ResumeBatch', 'UpdateBatch', 'ListBatches', 'GetBatch', 'DeleteBatch', ], ], ], ], [ 'id' => 371156, 'title' => '其他', 'type' => 'directory', 'children' => [ 'ListAttachedOSSBuckets', 'ContextualAnswer', 'ContextualRetrieval', ], ], ], 'components' => [ 'schemas' => [ 'Address' => [ 'title' => 'A short description of struct', 'description' => '地址信息。', 'type' => 'object', 'properties' => [ 'Language' => [ 'title' => 'Language', 'description' => '语言，格式为BCP 47。', 'type' => 'string', 'example' => 'zh-Hans', ], 'AddressLine' => [ 'title' => 'AddressLine', 'description' => '完整地址。', 'type' => 'string', 'example' => '中国浙江省杭州市余杭区文一西路969号', ], 'Country' => [ 'title' => 'Country', 'description' => '国家或地区。', 'type' => 'string', 'example' => '中国', ], 'Province' => [ 'title' => 'Province', 'description' => '省。', 'type' => 'string', 'example' => '浙江省', ], 'City' => [ 'title' => 'City', 'description' => '城市。', 'type' => 'string', 'example' => '杭州市', ], 'District' => [ 'title' => 'District', 'description' => '区。', 'type' => 'string', 'example' => '余杭区', ], 'Township' => [ 'title' => 'Township', 'description' => '街道。', 'type' => 'string', 'example' => '文一西路', ], ], ], 'AddressForStory' => [ 'title' => 'A short description of struct', 'description' => '用于故事的地址对象。', 'type' => 'object', 'properties' => [ 'Country' => [ 'title' => '国家', 'description' => '国家。', 'type' => 'string', 'example' => '中国', ], 'Province' => [ 'title' => '省', 'description' => '省。', 'type' => 'string', 'example' => '浙江省', ], 'City' => [ 'title' => '城市', 'description' => '城市。', 'type' => 'string', 'example' => '杭州市', ], 'District' => [ 'title' => '地区', 'description' => '地区。', 'type' => 'string', 'example' => '滨江区', ], 'Township' => [ 'title' => '乡镇', 'description' => '乡镇。', 'type' => 'string', 'example' => '长河街道', ], ], ], 'AlgorithmDefinition' => [ 'title' => '算法定义结构体', 'description' => '算法定义结构体', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'test', ], 'OwnerId' => [ 'title' => '阿里云账号ID', 'description' => '阿里云账号ID', 'type' => 'string', 'example' => 'user1', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'traningtest', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-05-31T10:19:40.572325888+08:00', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2023-05-31T10:19:40.572325888+08:00', ], 'TrainingSpecification' => [ 'title' => '模型训练参数', 'description' => '模型训练参数', '$ref' => '#/components/schemas/TrainingSpecification', ], 'AlgorithmDefinitionId' => [ 'title' => '算法定义ID', 'description' => '算法定义ID', 'type' => 'string', 'example' => '8fc6e718-8d19-495f-a510-bcee3c598588', ], 'Name' => [ 'title' => '算法名称', 'description' => '算法名称', 'type' => 'string', 'example' => 'algoName', ], 'CustomLabels' => [ 'title' => '自定义标签', 'description' => '自定义标签', 'type' => 'array', 'items' => [ 'type' => 'object', 'additionalProperties' => [ 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索，详情请见[字段和操作符的支持列表](~~2743991~~)。', 'type' => 'string', 'example' => '{'."\n" .' "MemberName": "Tim",'."\n" .' "Enabled": "True",'."\n" .' "ItemCount": "10"'."\n" .'}', ], ], ], ], ], 'Answer' => [ 'title' => '大模型生成的答案', 'description' => 'AI助手二期，大模型生成的答案', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => '回答内容', 'description' => '回答内容', 'type' => 'string', 'example' => '你好', ], 'References' => [ 'title' => '回答内容的来源，即参考文件', 'description' => '回答内容的来源，即参考文件', 'type' => 'array', 'items' => [ 'description' => 'AI 机器人问答 API 中，回答内容对应的参考文献', '$ref' => '#/components/schemas/ReferenceFile', ], ], ], ], 'App' => [ 'title' => 'App', 'description' => 'App', 'type' => 'object', 'properties' => [ 'AppDescription' => [ 'title' => 'AppDescription', 'description' => '应用描述信息', 'type' => 'string', 'example' => '中国最大的电商购物商城', ], 'AppId' => [ 'title' => 'AppId', 'description' => '应用ID', 'type' => 'string', 'example' => '1234567890', ], 'PackageName' => [ 'title' => 'PackageName', 'description' => 'PackageName', 'type' => 'string', 'example' => 'ThisIsAPackageName', ], 'AppType' => [ 'title' => 'AppType', 'description' => '应用类型，0表示安卓，1表示IOS', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'EnglishName' => [ 'title' => 'EnglishName', 'description' => '应用英文名称', 'type' => 'string', 'example' => 'Taobao', ], 'AppName' => [ 'title' => 'AppName', 'description' => '应用名称', 'type' => 'string', 'example' => '淘宝', ], 'AppRegion' => [ 'title' => 'AppRegion', 'description' => '应用使用地区，0表示国内，1表示国外', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'OwnerId' => [ 'title' => 'OwnerId', 'description' => '客户ID', 'type' => 'string', 'example' => '1023210024677934', ], 'AppKey' => [ 'title' => 'AppKey', 'description' => '创建应用时返回的Key', 'type' => 'string', 'example' => 'ryBOBW0Z6NnQ3fV9', ], ], ], 'AssumeRoleChain' => [ 'title' => '链式授权', 'description' => '扮演角色链式授权对象。', 'type' => 'object', 'properties' => [ 'Policy' => [ 'title' => '当前用户 policy', 'description' => '授权策略。', 'type' => 'string', 'example' => '{'."\n" .' "Statement": ['."\n" .' {'."\n" .' "Action": "oss:*",'."\n" .' "Effect": "Allow",'."\n" .' "Resource": "*"'."\n" .' }'."\n" .' ],'."\n" .' "Version": "1"'."\n" .'}', ], 'Chain' => [ 'title' => '链式授权节点', 'description' => '授权链路列表。', 'type' => 'array', 'items' => [ 'description' => '链式授权节点。', '$ref' => '#/components/schemas/AssumeRoleChainNode', ], ], ], ], 'AssumeRoleChainNode' => [ 'title' => '链式授权节点', 'description' => '链式授权节点对象。', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '账号类型，普通账号填 user，服务账号填 service', 'description' => '账号类型，可选值如下。'."\n" ."\n" .'- user：阿里云账号。'."\n" .'- service：阿里云服务。', 'type' => 'string', 'required' => true, 'example' => 'user', ], 'OwnerId' => [ 'title' => '账号id', 'description' => '账号UID。', 'type' => 'string', 'required' => true, 'example' => '10232100********', ], 'Role' => [ 'title' => '授权角色名', 'description' => '授权角色。', 'type' => 'string', 'required' => true, 'example' => 'test-role', ], ], ], 'AudioStream' => [ 'title' => 'A short description of struct', 'description' => '音频流信息。', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => 'Index', 'description' => '音频流索引号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Language' => [ 'title' => 'Language', 'description' => '音频流中使用的语言，格式为BCP 47', 'type' => 'string', 'example' => 'en', ], 'CodecName' => [ 'title' => 'CodecName', 'description' => '编码器名称。', 'type' => 'string', 'example' => 'aac', ], 'CodecLongName' => [ 'title' => 'CodecLongName', 'description' => '编码器名称的全称。', 'type' => 'string', 'example' => 'AAC (Advanced Audio Coding)', ], 'CodecTimeBase' => [ 'title' => 'CodecTimeBase', 'description' => '编码器时间基准。', 'type' => 'string', 'example' => '1/44100', ], 'CodecTagString' => [ 'title' => 'CodecTagString', 'description' => '编码器标识描述信息。', 'type' => 'string', 'example' => 'mp4a', ], 'CodecTag' => [ 'title' => 'CodecTag', 'description' => '编码器标识。', 'type' => 'string', 'example' => '0x6134706d', ], 'TimeBase' => [ 'title' => 'TimeBase', 'description' => '时间基准。', 'type' => 'string', 'example' => '1/48000', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '音频流起始时间，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'example' => '0.0235', ], 'Duration' => [ 'title' => 'Duration', 'description' => '音频流持续时长，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'example' => '3.690667', ], 'Bitrate' => [ 'title' => 'Bitrate', 'description' => '码率，单位为比特每秒（bit/s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '320087', ], 'FrameCount' => [ 'title' => 'FrameCount', 'description' => '帧数。', 'type' => 'integer', 'format' => 'int64', 'example' => '173', ], 'Lyric' => [ 'title' => 'Lyric', 'description' => '歌词。', 'type' => 'string', 'example' => 'test', ], 'SampleFormat' => [ 'title' => 'SampleFormat', 'description' => '采样格式。', 'type' => 'string', 'example' => 'fltp', ], 'SampleRate' => [ 'title' => 'SampleRate', 'description' => '采样率，单位为赫兹（Hz）。', 'type' => 'integer', 'format' => 'int64', 'example' => '48000', ], 'Channels' => [ 'title' => 'Channels', 'description' => '声道数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'ChannelLayout' => [ 'title' => 'ChannelLayout', 'description' => '声道排布形式。', 'type' => 'string', 'example' => 'stereo', ], ], ], 'Binding' => [ 'title' => 'A short description of struct', 'description' => '绑定信息。', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => 'ProjectName', 'description' => '项目名称。', 'type' => 'string', 'example' => 'immtest', ], 'DatasetName' => [ 'title' => 'DatasetName', 'description' => '数据集名称。', 'type' => 'string', 'example' => 'dataset001', ], 'URI' => [ 'title' => 'URI', 'description' => '数据集绑定的对象存储（OSS） Bucket URI。'."\n" ."\n" .'对象存储（OSS） Bucket URI的格式为`oss://${bucketname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称。', 'type' => 'string', 'example' => 'oss://examplebucket', ], 'State' => [ 'title' => 'State', 'description' => '数据集和OSS Bucket绑定关系的状态。取值范围如下：'."\n" ."\n" .'- Ready：绑定关系创建后准备中。'."\n" .'- Stopped：绑定关系已暂停。'."\n" .'- Running：绑定关系运行中。'."\n" .'- Retrying：绑定关系创建后重试中。'."\n" .'- Failed：绑定关系创建失败。'."\n" .'- Deleted：绑定关系已删除。', 'type' => 'string', 'example' => 'Running', ], 'Phase' => [ 'title' => 'Phase', 'description' => '扫描类型。取值范围如下：'."\n" ."\n" .'- FullScanning：全量扫描中。'."\n" .'- IncrementalScanning：增量扫描中。', 'type' => 'string', 'example' => 'FullScanning', ], 'CreateTime' => [ 'title' => 'CreateTime', 'description' => '数据集和OSS Bucket绑定关系创建时间的时间戳，格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'UpdateTime' => [ 'title' => 'UpdateTime', 'description' => '数据集和OSS Bucket的绑定关系修改时间的时间戳，格式为RFC3339Nano。'."\n" ."\n" .'>创建绑定关系后，如果未暂停或者未重启过绑定关系，则绑定关系修改时间的时间戳和绑定关系创建时间的时间戳相同。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'Reason' => [ 'title' => 'Reason', 'description' => 'Reason', 'type' => 'string', 'example' => '暂停使用', ], ], ], 'Body' => [ 'title' => 'A short description of struct', 'description' => '人体信息对象。', 'type' => 'object', 'properties' => [ 'Confidence' => [ 'title' => 'Confidence', 'description' => '人体置信度，置信度越高越可信，大于 0.8 比较可信。', 'type' => 'number', 'format' => 'float', 'example' => '0.82', ], 'Boundary' => [ 'title' => 'Boundary', 'description' => '人体边界对象。', '$ref' => '#/components/schemas/Boundary', ], ], ], 'Boundary' => [ 'title' => 'A short description of struct', 'description' => '边界信息。', 'type' => 'object', 'properties' => [ 'Width' => [ 'title' => 'Width', 'description' => '宽度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Height' => [ 'title' => 'Height', 'description' => '高度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '300', ], 'Left' => [ 'title' => 'Left', 'description' => '顶点X坐标距离左端距离，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Top' => [ 'title' => 'Top', 'description' => '顶点Y坐标距离顶端距离，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'Polygon' => [ 'title' => '多边形的坐标列表', 'description' => '使用若干个点围成的闭合多边形范围，当Boundary描述的是多边形框而非矩形框时有效。'."\n" ."\n" .'>该字段与Width / Height / Left / Top 四个参数组成的矩形范围参数只会出现一种。即当前 Boundary 描述只可能是一个矩形框或多边形框的一种，具体种类和当前框内容的形态本身一致。>', 'type' => 'array', 'items' => [ 'description' => '使用若干个点围成的闭合多边形范围信息。', '$ref' => '#/components/schemas/PointInt64', ], ], ], ], 'Car' => [ 'title' => 'A short description of struct', 'description' => '车辆信息对象。', 'type' => 'object', 'properties' => [ 'LicensePlates' => [ 'title' => '车牌', 'description' => '车牌列表。', 'type' => 'array', 'items' => [ 'description' => '车牌详细信息。', '$ref' => '#/components/schemas/LicensePlate', ], ], 'CarType' => [ 'title' => '车辆类型', 'description' => '车辆类型，取值范围如下：'."\n" ."\n" .'- car：汽车'."\n" ."\n" .'- bus：公共汽车'."\n" ."\n" .'- truck：卡车'."\n" ."\n" .'- van：火车', 'type' => 'string', 'example' => 'van', ], 'CarTypeConfidence' => [ 'title' => '车辆类型置信度', 'description' => '车辆类型置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'double', 'example' => '0.516', ], 'CarColor' => [ 'title' => '车辆颜色', 'description' => '车辆颜色。取值范围如下：'."\n" ."\n" .'- white：白色'."\n" ."\n" .'- grey：灰色'."\n" ."\n" .'- yellow：黄色'."\n" ."\n" .'- red：红色'."\n" ."\n" .'- green：绿色'."\n" ."\n" .'- blue：蓝色'."\n" ."\n" .'- black：黑色'."\n" ."\n" .'- purple：紫色'."\n" ."\n" .'- brown：棕色', 'type' => 'string', 'example' => 'white', ], 'CarColorConfidence' => [ 'title' => '车辆颜色置信度', 'description' => '车辆颜色置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'double', 'example' => '0.604', ], 'Boundary' => [ 'title' => '车辆裁剪框', 'description' => '车辆裁剪框。', '$ref' => '#/components/schemas/Boundary', ], 'Confidence' => [ 'title' => '车辆置信度', 'description' => '车辆置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'double', 'example' => '0.999', ], ], ], 'ClusterForReq' => [ 'title' => 'A short description of struct', 'description' => '聚类分组信息对象。', 'type' => 'object', 'properties' => [ 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '分组对象Id。', 'type' => 'string', 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '自定义Id。', 'type' => 'string', 'example' => 'abc', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '自定义标签。', 'type' => 'object', 'example' => '{"Bucket": "examplebucket"}', ], 'Name' => [ 'title' => 'Name', 'description' => '分组名称。', 'type' => 'string', 'example' => 'abc', ], 'Cover' => [ 'title' => 'Cover', 'description' => '封面信息对象。', 'type' => 'object', 'properties' => [ 'Figures' => [ 'title' => 'Figures', 'description' => '人物列表。', 'type' => 'array', 'items' => [ 'description' => '人物对象。', 'type' => 'object', 'properties' => [ 'FigureId' => [ 'title' => 'FigureId', 'description' => '人物对象Id。', 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', ], ], ], ], ], ], ], ], 'Codes' => [ 'title' => 'A short description of struct', 'description' => '码信息。', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => 'Content', 'description' => '码内容。', 'type' => 'string', 'example' => 'https://www.example.com', ], 'Confidence' => [ 'title' => 'Confidence', 'description' => '码置信度，置信度越高越可信，大于0.8比较可信。', 'type' => 'number', 'format' => 'float', 'example' => '0.9', ], 'Boundary' => [ 'title' => 'Boundary', 'description' => '码边界信息。', '$ref' => '#/components/schemas/Boundary', ], 'Type' => [ 'title' => 'Type', 'description' => '码类型。', 'type' => 'string', 'enumValueTitles' => [ 'qrcode' => '二维码', 'barcode' => '条码', ], 'example' => 'qrcode', ], ], ], 'ContextualFile' => [ 'title' => 'A short description of struct', 'description' => '文件', 'type' => 'object', 'properties' => [ 'OwnerId' => [ 'title' => 'OwnerId', 'description' => '用户ID', 'type' => 'string', 'example' => '1482910009923706', ], 'ProjectName' => [ 'title' => 'ProjectName', 'description' => '项目名称', 'type' => 'string', 'example' => 'test-project', ], 'DatasetName' => [ 'title' => 'DatasetName', 'description' => '数据集名称', 'type' => 'string', 'example' => 'test-dataset', ], 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '对应File存在于Dataset中的标识符。', 'type' => 'string', 'example' => '0939d7ed-73fa-4009-bbe6-fbbe07b92b2e', ], 'URI' => [ 'title' => 'URI', 'description' => '文件URI。'."\n" .'OSS地址规则为oss://${bucketname}/${objectname}，其中${bucketname}为和当前项目处于同一地域的OSS Bucket名称，${objectname}为文件路径。'."\n" .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', 'type' => 'string', 'example' => 'oss://test-bucket', ], 'OSSURI' => [ 'title' => 'OSSURI', 'description' => 'OSS文件的URI路径。仅在URI为PDS地址时使用。', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg', ], 'MediaType' => [ 'title' => 'MediaType', 'description' => '当前File的媒体类型', 'type' => 'string', 'enumValueTitles' => [ 'image' => 'image', 'other' => 'other', 'document' => 'document', 'archive' => 'archive', 'audio' => 'audio', 'video' => 'video', ], 'example' => 'document', ], 'ContentType' => [ 'title' => 'ContentType', 'description' => '文件内容类型（MIME Type）。', 'type' => 'string', 'example' => 'text/x-imm-faq', ], 'Elements' => [ 'title' => 'Elements', 'description' => 'Elements', 'type' => 'array', 'items' => [ 'description' => '文档分析生成的文档元素信息。', '$ref' => '#/components/schemas/Element', ], ], ], ], 'ContextualMessage' => [ 'title' => '对话消息列表', 'description' => 'AI 助手二期中，多轮对话中的消息', 'type' => 'object', 'properties' => [ 'Role' => [ 'title' => '对话角色', 'description' => '对话角色', 'type' => 'string', 'example' => 'user', ], 'Content' => [ 'title' => '消息内容', 'description' => '消息内容', 'type' => 'string', 'example' => '你好', ], 'Files' => [ 'title' => '对话中的文件列表', 'description' => '对话中的文件列表', 'type' => 'array', 'items' => [ 'description' => '文件信息的结构体。', '$ref' => '#/components/schemas/ContextualFile', ], ], ], ], 'CredentialConfig' => [ 'title' => '链式授权配置', 'description' => '链式授权配置对象，一般留空即可。'."\n" .'> 假设当前使用A账号调用IMM接口处理B账号中的OSS数据。'."\n" .'ServiceRole参数应配置A账号中的角色，Chain参数应设置B账号准备好的角色，通过上述配置完成后，就可以使用A账号调用IMM接口处理B账号中的OSS数据。', 'type' => 'object', 'properties' => [ 'ServiceRole' => [ 'title' => '服务角色', 'description' => '服务角色，调用IMM接口的账号需要创建的一个角色，必须包含 `sts:AssumeRole` 权限，可以通过RAM控制台进行配置。', 'type' => 'string', 'example' => 'AliyunSTSAssumeForIMMServiceRole', ], 'Policy' => [ 'title' => '权限策略', 'description' => 'ServiceRole参数的角色所需配置的权限策略，例如允许访问OSS。可选', 'type' => 'string', 'example' => '{"Statement": [{"Action": "oss:*","Effect": "Allow","Resource": "*"}],"Version": "1"}', ], 'Chain' => [ 'title' => '授权链', 'description' => '需要传递授权的链列表，数组中的所有角色都需要赋予访问 `sts:AssumeRole` 权限。'."\n" .'只有数组中的最后一个角色需要额外配置需要真正访问的其他权限，比如OSS的读写权限，可以通过RAM控制台进行授权操作。', 'type' => 'array', 'items' => [ 'description' => '授权链对象。', 'type' => 'object', 'properties' => [ 'AssumeRoleFor' => [ 'title' => '授权对象', 'description' => '提供授权的账号ID。', 'type' => 'string', 'example' => '10232100246xxxxx', ], 'Role' => [ 'title' => '授权角色', 'description' => '允许扮演的RAM角色。', 'type' => 'string', 'example' => 'AliyunOSSRole', ], 'RoleType' => [ 'title' => '授权方类型', 'description' => '角色类型，可选值如下。'."\n" .'- user：阿里云账号。'."\n" .'- service：阿里云服务。', 'type' => 'string', 'example' => 'user', ], ], ], ], ], ], 'CroppingSuggestion' => [ 'title' => 'A short description of struct', 'description' => '裁剪建议。', 'type' => 'object', 'properties' => [ 'AspectRatio' => [ 'title' => 'AspectRatio', 'description' => '图片裁剪比例。', 'type' => 'string', 'example' => '2:3', ], 'Confidence' => [ 'title' => 'Confidence', 'description' => '置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '0.742', ], 'Boundary' => [ 'title' => 'Boundary', 'description' => '裁剪边界信息。', '$ref' => '#/components/schemas/Boundary', ], ], ], 'CustomParams' => [ 'title' => '模型训练自定义参数信息', 'description' => '模型训练自定义参数信息', 'type' => 'object', 'properties' => [ 'Properties' => [ 'title' => '属性列表', 'description' => '属性列表', 'type' => 'array', 'items' => [ 'description' => '属性信息。', '$ref' => '#/components/schemas/Property', ], ], 'Name' => [ 'title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'Normalize', ], ], ], 'CustomPrompt' => [ 'title' => 'AI助手自定义Prompt', 'type' => 'object', 'properties' => [ 'RoleDefinition' => [ 'title' => 'AI助手角色定义', 'type' => 'string', ], ], ], 'DataIngestion' => [ 'title' => 'A short description of struct', 'description' => '一个数据接入实例。', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据接入唯一标识', 'description' => '数据接入唯一标识。', 'type' => 'string', 'example' => 'trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****', ], 'Input' => [ 'title' => '数据源信息', 'description' => '数据源信息。', '$ref' => '#/components/schemas/Input', ], 'Actions' => [ 'title' => '运行模板', 'description' => '处理模板列表。', 'type' => 'array', 'items' => [ 'description' => '模版信息。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '动作名称', 'description' => '模板名称。', 'type' => 'string', 'example' => 'doc/convert', ], 'Parameters' => [ 'title' => '动作参数', 'description' => '模板参数。', 'type' => 'array', 'items' => [ 'description' => '模版参数。', 'type' => 'string', 'example' => 'pages=3', ], ], 'FastFailPolicy' => [ 'title' => '数据处理快速失败的策略配置', 'description' => '数据处理快速失败的策略配置', '$ref' => '#/components/schemas/FastFailPolicy', ], ], ], ], 'Notification' => [ 'title' => '通知地址', 'description' => '任务完成通知。', 'type' => 'object', 'properties' => [ 'Endpoint' => [ 'title' => 'MNS 地址', 'description' => 'MNS地址。', 'type' => 'string', 'example' => 'http://1111111111.mns.cn-hangzhou.aliyuncs.com', ], 'Topic' => [ 'title' => 'MNS 主题', 'description' => 'MNS主题。', 'type' => 'string', 'example' => 'topic1', ], 'MNS' => [ 'title' => 'MNS', 'description' => 'MNS', '$ref' => '#/components/schemas/MNS', ], 'RocketMQ' => [ 'title' => 'RocketMQ', 'description' => 'RocketMQ', '$ref' => '#/components/schemas/RocketMQ', ], ], ], 'Statistic' => [ 'title' => '统计信息', 'description' => '统计信息。', 'type' => 'object', 'properties' => [ 'SubmitSuccess' => [ 'title' => '提交成功个数', 'description' => '提交成功个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'SubmitFailure' => [ 'title' => '提交失败个数', 'description' => '提交失败个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'SkipFiles' => [ 'title' => '跳过文件个数', 'description' => '跳过文件个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'State' => [ 'title' => '任务执行状态', 'description' => '批处理任务状态：'."\n" ."\n" .'- Ready：任务就绪，刚创建的任务处于Ready状态。'."\n" .'- Running：正在执行，正常执行的任务状态。'."\n" .'- Failed：任务失败，任务执行出错，且无法自动恢复。'."\n" .'- Suspended：任务暂停。'."\n" .'- Succeeded：任务执行完成。', 'type' => 'string', 'example' => 'Succeeded', ], 'Marker' => [ 'title' => '任务执行进度', 'description' => '任务执行位置。', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', ], 'CreateTime' => [ 'title' => '任务创建时间', 'description' => '任务创建时间。', 'type' => 'string', 'example' => '2020-11-10T03:50:28Z', ], 'UpdateTime' => [ 'title' => '任务更新时间', 'description' => '任务更新时间。', 'type' => 'string', 'example' => '2021-12-18T07:40:29Z', ], 'Tags' => [ 'title' => '标签', 'description' => '任务标签。', 'type' => 'object', ], 'Error' => [ 'title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound', ], 'Phase' => [ 'title' => '扫描阶段', 'description' => '扫描阶段', 'type' => 'string', 'example' => 'IncrementalScanning', ], 'ServiceRole' => [ 'title' => '服务授权角色', 'description' => '服务授权角色', 'type' => 'string', 'example' => 'AliyunIMMBatchTriggerRole', ], ], ], 'Dataset' => [ 'title' => '媒体集结构体', 'description' => '数据集信息。', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称。', 'type' => 'string', 'example' => 'immtest', ], 'DatasetName' => [ 'title' => '媒体集名称', 'description' => '数据集名称。', 'type' => 'string', 'example' => 'dataset001', ], 'TemplateId' => [ 'title' => '模板Id', 'description' => '工作流模板ID。', 'type' => 'string', 'example' => 'Official:ImageManagement', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '数据集创建时间的时间戳，格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '数据集修改时间的时间戳，格式为RFC3339Nano。'."\n" ."\n" .'>创建数据集后，如果未更新过数据集，则数据集修改时间的时间戳和数据集创建时间的时间戳相同。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'Description' => [ 'title' => '描述', 'description' => '数据集描述信息。', 'type' => 'string', 'example' => '测试数据集', ], 'DatasetMaxBindCount' => [ 'title' => '媒体集最大绑定数', 'description' => '每个数据集绑定的最大个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'DatasetMaxFileCount' => [ 'title' => '媒体集最多文件数量', 'description' => '数据集中文件的最大个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000', ], 'DatasetMaxEntityCount' => [ 'title' => '媒体集最多实体数量', 'description' => '数据集中元数据实体的最大个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000', ], 'DatasetMaxRelationCount' => [ 'title' => '媒体集最多关系数量', 'description' => '数据集中元数据关系的最大个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000000', ], 'DatasetMaxTotalFileSize' => [ 'title' => '媒体集最大文件总大小', 'description' => '数据集中文件总大小的最大值，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '90000000000000000', ], 'BindCount' => [ 'title' => '媒体集当前绑定数', 'description' => '数据集当前绑定的OSS Bucket数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'FileCount' => [ 'title' => '媒体集当前文件数', 'description' => '数据集当前文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TotalFileSize' => [ 'title' => '媒体集当前文件总大小', 'description' => '数据集中文件总大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'WorkflowParameters' => [ 'title' => '自定义参数', 'description' => '自定义参数。', 'type' => 'array', 'items' => [ 'description' => '自定义参数结构体。', '$ref' => '#/components/schemas/WorkflowParameter', ], ], ], ], 'DatasetTaskStatus' => [ 'title' => 'A short description of struct', 'description' => 'Dataset 任务状态', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'Succeeded', ], 'LastSucceededTime' => [ 'title' => '上一次完成时间', 'description' => '上一次完成时间', 'type' => 'string', 'example' => '2024-06-29T14:50:13.011643661+08:00', ], 'StartTime' => [ 'title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2024-06-29T14:50:13.011643661+08:00', ], ], ], 'DocumentParseKeywordOption' => [ 'type' => 'object', 'properties' => [ 'Extract' => [ 'title' => '是否提取', 'type' => 'boolean', ], 'Count' => [ 'title' => '关键词数量', 'type' => 'integer', 'format' => 'int32', ], ], ], 'DocumentParseNarratorOption' => [ 'type' => 'object', 'properties' => [ 'Narrate' => [ 'title' => '文章导读', 'type' => 'boolean', ], ], ], 'DocumentParseOption' => [ 'type' => 'object', 'properties' => [ 'Narrator' => [ '$ref' => '#/components/schemas/DocumentParseNarratorOption', ], 'Summary' => [ '$ref' => '#/components/schemas/DocumentParseSummaryOption', ], 'Question' => [ '$ref' => '#/components/schemas/DocumentParseQuestionOption', ], 'Keyword' => [ '$ref' => '#/components/schemas/DocumentParseKeywordOption', ], ], ], 'DocumentParseQuestionOption' => [ 'type' => 'object', 'properties' => [ 'Extract' => [ 'title' => '是否提取', 'type' => 'boolean', ], 'Count' => [ 'title' => '问题数量', 'type' => 'integer', 'format' => 'int32', ], ], ], 'DocumentParseSummaryOption' => [ 'type' => 'object', 'properties' => [ 'Summarize' => [ 'title' => '文章总结', 'type' => 'boolean', ], 'ChapterSummarize' => [ 'title' => '文档分章节总结', 'type' => 'boolean', ], ], ], 'Element' => [ 'title' => 'A short description of struct', 'description' => '文档分析生成的文档元素信息。', 'type' => 'object', 'properties' => [ 'ElementContents' => [ 'title' => '元素内容列表', 'description' => '元素内容列表。', 'type' => 'array', 'items' => [ 'description' => '元素内容信息。', '$ref' => '#/components/schemas/ElementContent', ], ], 'ObjectId' => [ 'title' => '文档片段的唯一ID', 'description' => '文档片段的唯一ID', 'type' => 'string', 'example' => 'id1', ], 'ElementType' => [ 'title' => '文档片段的类型', 'description' => '文档片段的类型', 'type' => 'string', 'example' => 'title - 标题； image - 图片 ； table - 表格 ； narrative-text - 正文', ], 'SemanticSimilarity' => [ 'title' => '当前文件和语义匹配的相似度', 'description' => '当前文件和语义匹配的相似度', 'type' => 'number', 'format' => 'float', 'example' => '0.8', ], 'ElementRelations' => [ 'title' => '当前文档片段和其他文档片段的关系', 'description' => '当前文档片段和其他文档片段的关系', 'type' => 'array', 'items' => [ 'description' => '当前文档片段和其他文档片段的关系结构体', '$ref' => '#/components/schemas/ElementRelation', ], ], ], ], 'ElementContent' => [ 'title' => 'A short description of struct', 'description' => '文档分析生成的元素的内容信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '元素内容的类型', 'description' => '元素内容的类型。'."\n" ."\n" .'可选值如下：'."\n" ."\n" .'- text：文本。'."\n" .'- image：图片。'."\n" .'- link：链接。', 'type' => 'string', 'example' => 'text', ], 'Content' => [ 'title' => '元素内容正文', 'description' => '元素的内容。'."\n" ."\n" .'当元素内容类型为图片或链接时表示其占位符文本。', 'type' => 'string', 'example' => '文本片段', ], 'URL' => [ 'title' => '元素内容的链接', 'description' => '元素内容的链接。当元素内容类型为图片或链接时有效。', 'type' => 'string', 'example' => 'http://aliyun.com', ], 'TimeRange' => [ 'title' => '持续的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', 'description' => '持续的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', 'type' => 'array', 'items' => [ 'description' => '时间范围对象。', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], ], ], ], 'ElementRelation' => [ 'title' => 'A short description of struct', 'description' => '当前文档片段和其他文档片段的关系', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '类型', 'description' => '类型', 'type' => 'string', 'example' => 'child，parent', ], 'ObjectId' => [ 'title' => '文档片段的ID', 'description' => '文档片段的ID', 'type' => 'string', 'example' => 'id1', ], ], ], 'FastFailPolicy' => [ 'title' => '快速失败策略结构体', 'description' => '快速失败策略结构体', 'type' => 'object', 'properties' => [ 'Action' => [ 'title' => '失败执行策略', 'description' => '快速失败执行策略，批处理或触发器中根据该策略配置可以选择遇到错误停止运行或继续运行。', 'type' => 'string', 'enumValueTitles' => [ 'abort' => '遇到错误停止运行', 'ignore' => '忽略错误继续执行', ], 'example' => 'abort', ], ], ], 'Figure' => [ 'title' => 'A short description of struct', 'description' => '人物信息。', 'type' => 'object', 'properties' => [ 'FigureId' => [ 'title' => 'FigureId', 'description' => '人物对象ID。', 'type' => 'string', 'example' => '868a9e74-cde5-4c7a-9013-28bb984****', ], 'FigureConfidence' => [ 'title' => 'FigureConfidence', 'description' => '人物对象置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'FigureClusterId' => [ 'title' => 'FigureClusterId', 'description' => '人物聚类ID。包括如下保留的特殊聚类ID命名：'."\n" ."\n" .'- figure-cluster-id-independent：该人脸暂无合适的分组，后续在数据集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" ."\n" .'- figure-cluster-id-unavailable：该人脸暂未进行过聚类操作，即在数据集中新增图片后，未进行人脸聚类。', 'type' => 'string', 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****', ], 'FigureClusterConfidence' => [ 'title' => 'FigureClusterConfidence', 'description' => '聚类置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'FigureType' => [ 'title' => 'FigureType', 'description' => '人物类型。', 'type' => 'string', 'enumValueTitles' => [ 'face' => '人脸', ], 'example' => 'face', ], 'Age' => [ 'title' => 'Age', 'description' => '年龄。', 'type' => 'integer', 'format' => 'int64', 'example' => '29', ], 'AgeSD' => [ 'title' => 'AgeSD', 'description' => '年龄标准差。', 'type' => 'number', 'format' => 'float', 'example' => '5', ], 'Gender' => [ 'title' => 'Gender', 'description' => '性别。', 'type' => 'string', 'enumValueTitles' => [ 'female' => '女性', 'male' => '男性', ], 'example' => 'female', ], 'GenderConfidence' => [ 'title' => 'GenderConfidence', 'description' => '性别置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'Emotion' => [ 'title' => 'Emotion', 'description' => '心情。', 'type' => 'string', 'enumValueTitles' => [ 'happiness' => '开心', 'none' => '无', ], 'example' => 'happiness', ], 'EmotionConfidence' => [ 'title' => 'EmotionConfidence', 'description' => '心情置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '0.707845687866210', ], 'FaceQuality' => [ 'title' => 'FaceQuality', 'description' => '人脸质量，评价图像质量是否适合人脸识别，分数越高质量越好，取值范围为0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.960875928401947', ], 'Boundary' => [ 'title' => 'Boundary', 'description' => '人脸边界信息。', '$ref' => '#/components/schemas/Boundary', ], 'Mouth' => [ 'title' => 'Mouth', 'description' => '是否张口。', 'type' => 'string', 'enumValueTitles' => [ 'close' => '否', 'open' => '是', ], 'example' => 'close', ], 'MouthConfidence' => [ 'title' => 'MouthConfidence', 'description' => '是否张口置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'Beard' => [ 'title' => 'Beard', 'description' => '是否有胡子。', 'type' => 'string', 'enumValueTitles' => [ 'beard' => '是', 'none' => '否', ], 'example' => 'none', ], 'BeardConfidence' => [ 'title' => 'BeardConfidence', 'description' => '是否有胡子置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'Hat' => [ 'title' => 'Hat', 'description' => '是否有帽子。', 'type' => 'string', 'enumValueTitles' => [ 'hat' => '是', 'none' => '否', ], 'example' => 'none', ], 'HatConfidence' => [ 'title' => 'HatConfidence', 'description' => '是否戴帽子置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'Mask' => [ 'title' => 'Mask', 'description' => '是否带口罩。', 'type' => 'string', 'enumValueTitles' => [ 'none' => '否', 'mask' => '是', ], 'example' => 'none', ], 'MaskConfidence' => [ 'title' => 'MaskConfidence', 'description' => '是否带口罩置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'Glasses' => [ 'title' => 'Glasses', 'description' => '是否戴眼镜。', 'type' => 'string', 'enumValueTitles' => [ 'glasses' => '戴眼镜', 'sunglasses' => '戴太阳镜', 'none' => '否', ], 'example' => 'none', ], 'GlassesConfidence' => [ 'title' => 'GlassesConfidence', 'description' => '是否戴眼镜置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '0.8', ], 'Sharpness' => [ 'title' => 'Sharpness', 'description' => '清晰度，分数越高人脸越清晰，取值范围为0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.7', ], 'Attractive' => [ 'title' => 'Attractive', 'description' => '人脸吸引力，分数越高吸引力越强，取值范围为0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.96', ], 'HeadPose' => [ 'description' => '头部朝向信息。', '$ref' => '#/components/schemas/HeadPose', ], ], ], 'FigureCluster' => [ 'title' => 'A short description of struct', 'description' => '聚类分组信息对象。', 'type' => 'object', 'properties' => [ 'OwnerId' => [ 'title' => 'OwnerId', 'description' => '所属用户Id。', 'type' => 'string', 'example' => '102321002****', ], 'ProjectName' => [ 'title' => 'ProjectName', 'description' => '项目名称。', 'type' => 'string', 'example' => 'immtest', ], 'DatasetName' => [ 'title' => 'DatasetName', 'description' => '数据集名称。', 'type' => 'string', 'example' => 'dataset001', ], 'ObjectType' => [ 'title' => 'ObjectType', 'description' => '分组对象的类型。', 'type' => 'string', 'example' => 'figure-cluster', ], 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '分组对象Id。', 'type' => 'string', 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', ], 'UpdateTime' => [ 'title' => 'UpdateTime', 'description' => '更新时间。', 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00', ], 'CreateTime' => [ 'title' => 'CreateTime', 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00', ], 'Name' => [ 'title' => 'Name', 'description' => '分组名称。', 'type' => 'string', 'example' => 'abc', ], 'Gender' => [ 'title' => 'Gender', 'description' => '性别。', 'type' => 'string', 'example' => 'female', ], 'FaceCount' => [ 'title' => 'FaceCount', 'description' => '人脸数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ImageCount' => [ 'title' => 'ImageCount', 'description' => '图片数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'VideoCount' => [ 'title' => 'VideoCount', 'description' => '视频数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'AverageAge' => [ 'title' => 'AverageAge', 'description' => '平均年龄。', 'type' => 'number', 'format' => 'float', 'example' => '26', ], 'MinAge' => [ 'title' => 'MinAge', 'description' => '最小年龄。', 'type' => 'number', 'format' => 'float', 'example' => '12', ], 'MaxAge' => [ 'title' => 'MaxAge', 'description' => '最大年龄。', 'type' => 'number', 'format' => 'float', 'example' => '44', ], 'Cover' => [ 'title' => 'Cover', 'description' => '封面信息。', '$ref' => '#/components/schemas/File', ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '自定义ID。', 'type' => 'string', 'example' => 'abc', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '自定义标签，用于根据标签搜索分组。', 'type' => 'object', 'example' => '{"Bucket": "examplebucket"}', ], 'MetaLockVersion' => [ 'title' => 'MetaLockVersion', 'description' => '元数据锁版本。'."\n" .'在对分组进行更新时，传入当前数据的 MetaLockVersion（通常通过 Get/List 接口获得），服务端将校验 MetaLockVersion 字段的值是否和传入值一致，并仅当一致时才实际进行更新。用于在并发场景避免更新发生冲突。初始值为0，每次成功更新后自动加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'FigureClusterForReq' => [ 'title' => 'A short description of struct', 'description' => '用于更新聚类分组信息的对象。', 'type' => 'object', 'properties' => [ 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '分组的对象ID。', 'type' => 'string', 'example' => 'Cluster-99b1c333-86dc-45da-8c6****', ], 'Name' => [ 'title' => 'Name', 'description' => '分组名称。', 'type' => 'string', 'example' => 'abc', ], 'Cover' => [ 'title' => 'Cover', 'description' => '封面。', 'type' => 'object', 'properties' => [ 'Figures' => [ 'title' => 'Figures', 'description' => '人物列表。', 'type' => 'array', 'items' => [ 'description' => '人物对象。', 'type' => 'object', 'properties' => [ 'FigureId' => [ 'title' => 'FigureId', 'description' => '人物对象Id。', 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', ], ], ], ], ], ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '自定义ID。', 'type' => 'string', 'example' => 'abc', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '自定义标签，用于根据标签搜索分组。', 'type' => 'object', 'example' => '{"Bucket": "examplebucket"}', ], 'MetaLockVersion' => [ 'title' => 'MetaLockVersion', 'description' => '元数据锁版本。在分组进行更新时，传入当前数据的 MetaLockVersion（通常通过 Get/List 接口获得），服务端将校验 MetaLockVersion 字段的值是否和传入值一致，并仅当一致时才实际进行更新。用于在并发场景避免更新发生冲突。初始值为0，每次成功更新后自动加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'File' => [ 'title' => 'A short description of struct', 'description' => '文件元数据信息。', 'type' => 'object', 'properties' => [ 'OwnerId' => [ 'title' => 'OwnerId', 'description' => '阿里云账号ID。', 'type' => 'string', 'example' => '102321002467****', ], 'ProjectName' => [ 'title' => 'ProjectName', 'description' => '项目名称，见[创建项目](~~478153~~)。', 'type' => 'string', 'example' => 'test-project', ], 'DatasetName' => [ 'title' => 'DatasetName', 'description' => '数据集名称，见[创建数据集](~~478160~~)。', 'type' => 'string', 'example' => 'test-dataset', ], 'ObjectType' => [ 'title' => 'ObjectType', 'description' => '对象类型，固定取值为**file**。', 'type' => 'string', 'example' => 'file', ], 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '对象唯一ID。', 'type' => 'string', 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', ], 'UpdateTime' => [ 'title' => 'UpdateTime', 'description' => '元数据修改时间的时间戳， 格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'CreateTime' => [ 'title' => 'CreateTime', 'description' => '元数据创建时间的时间戳， 格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'URI' => [ 'title' => 'URI', 'description' => '文件地址。'."\n" ."\n" .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一地域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" ."\n" .'PDS地址规则为pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}。', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg', ], 'OSSURI' => [ 'title' => 'OSSURI', 'description' => 'OSS文件的URI路径。仅在URI为PDS地址时使用。', 'type' => 'string', 'example' => 'oss://examplebucket/sampleobject.jpg', ], 'Filename' => [ 'title' => 'Filename', 'description' => '文件名称。对于OSS文件则为其ObjectKey。', 'type' => 'string', 'example' => 'sampleobject.jpg', ], 'MediaType' => [ 'title' => 'MediaType', 'description' => '文件媒体类型。', 'type' => 'string', 'enumValueTitles' => [ 'image' => '图片', 'other' => '其他', 'document' => '文档', 'archive' => '压缩包', 'audio' => '音频', 'video' => '视频', ], 'example' => 'image', ], 'ContentType' => [ 'title' => 'ContentType', 'description' => '文件内容类型（MIME Type）。', 'type' => 'string', 'example' => 'image/jpeg', ], 'Size' => [ 'title' => 'Size', 'description' => '文件大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'FileHash' => [ 'title' => 'FileHash', 'description' => '文件哈希值。', 'type' => 'string', 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', ], 'FileModifiedTime' => [ 'title' => 'FileModifiedTime', 'description' => '文件最近一次修改时间的时间戳， 格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'FileCreateTime' => [ 'title' => 'FileCreateTime', 'description' => '文件创建时间的时间戳，格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'FileAccessTime' => [ 'title' => 'FileAccessTime', 'description' => '文件访问时间的时间戳，格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'ProduceTime' => [ 'title' => 'ProduceTime', 'description' => '照片拍摄时间。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'LatLong' => [ 'title' => 'LatLong', 'description' => 'GPS经纬度信息。', 'type' => 'string', 'example' => '30.134390,120.074997', ], 'Timezone' => [ 'title' => 'Timezone', 'description' => '时区。'."\n" .'> 暂时不支持。', 'type' => 'string', 'example' => '""', ], 'Addresses' => [ 'title' => 'Addresses', 'description' => '地址信息。', 'type' => 'array', 'items' => [ 'description' => '地址信息。', '$ref' => '#/components/schemas/Address', ], ], 'TravelClusterId' => [ 'title' => 'TravelClusterId', 'description' => '预留参数。'."\n" .'> 暂时不支持。', 'type' => 'string', 'example' => '-', ], 'Orientation' => [ 'title' => 'Orientation', 'description' => '图片旋转值，从EXIF信息中获取。'."\n" ."\n" .'如果图片EXIF信息无此信息，则返回结果中无此参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Figures' => [ 'title' => 'Figures', 'description' => '人物列表。通过AI模型自动检测。', 'type' => 'array', 'items' => [ 'description' => '人物信息。', '$ref' => '#/components/schemas/Figure', ], ], 'FigureCount' => [ 'title' => 'FigureCount', 'description' => '人物数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Labels' => [ 'title' => 'Labels', 'description' => '文件标签信息列表。通过AI模型自动检测。', 'type' => 'array', 'items' => [ 'description' => '文件标签信息。', '$ref' => '#/components/schemas/Label', ], ], 'Title' => [ 'title' => 'Title', 'description' => '文件标题。', 'type' => 'string', 'example' => 'test', ], 'ImageWidth' => [ 'title' => 'ImageWidth', 'description' => '图片宽度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '270', ], 'ImageHeight' => [ 'title' => 'ImageHeight', 'description' => '图片高度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'EXIF' => [ 'title' => 'EXIF', 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。参考[OSS获取图片信息](~~44975~~)。', 'type' => 'string', 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}', ], 'ImageScore' => [ 'description' => '图片评分信息。通过AI模型自动检测。', '$ref' => '#/components/schemas/ImageScore', ], 'CroppingSuggestions' => [ 'title' => 'CroppingSuggestions', 'description' => '图片的裁剪建议。'."\n" .'> 暂时不支持。', 'type' => 'array', 'items' => [ 'description' => '图片的剪裁建议。', '$ref' => '#/components/schemas/CroppingSuggestion', ], ], 'OCRContents' => [ 'title' => 'OCRContents', 'description' => 'OCR识别结果。'."\n" .'> 暂时不支持。', 'type' => 'array', 'items' => [ 'description' => 'OCR识别结果。', '$ref' => '#/components/schemas/OCRContents', ], ], 'VideoWidth' => [ 'title' => 'VideoWidth', 'description' => '视频画面宽度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', ], 'VideoHeight' => [ 'title' => 'VideoHeight', 'description' => '视频画面高度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', ], 'VideoStreams' => [ 'title' => 'VideoStreams', 'description' => '视频流列表。', 'type' => 'array', 'items' => [ 'description' => '视频流。', '$ref' => '#/components/schemas/VideoStream', ], ], 'Subtitles' => [ 'title' => 'Subtitles', 'description' => '字幕流列表。', 'type' => 'array', 'items' => [ 'description' => '字幕流。', '$ref' => '#/components/schemas/SubtitleStream', ], ], 'AudioStreams' => [ 'title' => 'AudioStreams', 'description' => '音频流列表。', 'type' => 'array', 'items' => [ 'description' => '音频流。', '$ref' => '#/components/schemas/AudioStream', ], ], 'Artist' => [ 'title' => 'Artist', 'description' => '艺术家。', 'type' => 'string', 'example' => 'Jane', ], 'AlbumArtist' => [ 'title' => 'AlbumArtist', 'description' => '演唱者。', 'type' => 'string', 'example' => 'Jane', ], 'AudioCovers' => [ 'title' => 'AudioCovers', 'description' => '音频封面。', 'type' => 'array', 'items' => [ 'description' => '音频封面。', '$ref' => '#/components/schemas/Image', ], ], 'Composer' => [ 'title' => 'Composer', 'description' => '作曲家。', 'type' => 'string', 'example' => 'Jane', ], 'Performer' => [ 'title' => 'Performer', 'description' => '演奏者。', 'type' => 'string', 'example' => 'Jane', ], 'Language' => [ 'title' => 'Language', 'description' => '语言，格式为BCP 47。', 'type' => 'string', 'example' => 'eng', ], 'Album' => [ 'title' => 'Album', 'description' => '专辑。', 'type' => 'string', 'example' => 'FirstAlbum', ], 'PageCount' => [ 'title' => 'PageCount', 'description' => '页数。'."\n" .'> 暂时不支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'ETag' => [ 'title' => 'ETag', 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。', 'type' => 'string', 'example' => '"1D9C280A7C4F67F7EF873E28449****"', ], 'CacheControl' => [ 'title' => 'CacheControl', 'description' => '指定Object被下载时网页的缓存行为。'."\n" ."\n" .'该字段需要设置OSS Object HTTP属性Cache-Control，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'string', 'example' => 'no-cache', ], 'ContentDisposition' => [ 'title' => 'ContentDisposition', 'description' => '指定Object被下载时的名称。'."\n" ."\n" .'该字段需要设置OSS Object HTTP属性Content-Disposition，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'string', 'example' => 'attachment; filename =test.jpg', ], 'ContentEncoding' => [ 'title' => 'ContentEncoding', 'description' => '指定该Object被下载时的内容编码格式。'."\n" ."\n" .'该字段需要设置OSS Object HTTP属性Content-Encoding，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'string', 'example' => 'UTF-8', ], 'ContentLanguage' => [ 'title' => 'ContentLanguage', 'description' => 'Object内容使用的语言。'."\n" ."\n" .'该字段需要设置OSS Object HTTP属性Content-Language，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'string', 'example' => 'zh-CN', ], 'AccessControlAllowOrigin' => [ 'title' => 'AccessControlAllowOrigin', 'description' => '允许的跨域请求的来源。', 'type' => 'string', 'example' => 'https://aliyundoc.com', ], 'AccessControlRequestMethod' => [ 'title' => 'AccessControlRequestMethod', 'description' => '在实际请求中会用到的方法。', 'type' => 'string', 'example' => 'PUT', ], 'ServerSideEncryptionCustomerAlgorithm' => [ 'title' => 'ServerSideEncryptionCustomerAlgorithm', 'description' => '用户在服务端自定义加密文件时使用的加密编码算法。', 'type' => 'string', 'example' => 'SM4', ], 'ServerSideEncryption' => [ 'title' => 'ServerSideEncryption', 'description' => '服务器端加密方式。'."\n" ."\n" .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', 'type' => 'string', 'example' => 'AES256', ], 'ServerSideDataEncryption' => [ 'title' => 'ServerSideDataEncryption', 'description' => 'Object的加密算法。'."\n" ."\n" .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', 'type' => 'string', 'example' => 'SM4', ], 'ServerSideEncryptionKeyId' => [ 'title' => 'ServerSideEncryptionKeyId', 'description' => '表示KMS托管的用户主密钥。'."\n" ."\n" .'该字段需要设置OSS Bucket服务端加密，详情请参见[服务端加密](~~31871~~)。', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], 'OSSStorageClass' => [ 'title' => 'OSSStorageClass', 'description' => 'OSS存储空间类型。', 'type' => 'string', 'example' => 'Standard', ], 'OSSCRC64' => [ 'title' => 'OSSCRC64', 'description' => 'CRC64值。', 'type' => 'string', 'example' => '559890638950338001', ], 'ObjectACL' => [ 'title' => 'ObjectACL', 'description' => 'OSS对象ACL。', 'type' => 'string', 'example' => 'default', ], 'ContentMd5' => [ 'title' => 'ContentMd5', 'description' => 'MD5值。', 'type' => 'string', 'example' => 'HZwoCnxPZ/fvhz4oRJ2+Fw==', ], 'OSSUserMeta' => [ 'title' => 'OSSUserMeta', 'description' => 'OSS自定义元数据。'."\n" ."\n" .'该字段需要设置OSS Object自定义元数据，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'object', 'example' => '{"key": "val"}', ], 'OSSTaggingCount' => [ 'title' => 'OSSTaggingCount', 'description' => 'OSS对象标签数量。'."\n" ."\n" .'该字段需要设置OSS Object对象标签，详情请参见[对象标签](~~106678~~)。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'OSSTagging' => [ 'title' => 'OSSTagging', 'description' => 'OSS对象标签。'."\n" ."\n" .'详情请参见[对象标签](~~106678~~)。', 'type' => 'object', 'example' => '{"key": "val"}', ], 'OSSExpiration' => [ 'title' => 'OSSExpiration', 'description' => 'OSS过期时间。'."\n" ."\n" .'该字段需要设置OSS Object HTTP属性Expires，详情请参见[管理文件元信息](~~31859~~)。', 'type' => 'string', 'example' => '2120-01-01T12:00:00.000Z', ], 'OSSVersionId' => [ 'title' => 'OSSVersionId', 'description' => 'OSS文件版本。'."\n" ."\n" .'该字段需要开启OSS Bucket版本控制，详情请参见[版本控制介绍](~~109695~~)。', 'type' => 'string', 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', ], 'OSSDeleteMarker' => [ 'title' => 'OSSDeleteMarker', 'description' => 'OSS删除标记。', 'type' => 'string', 'example' => 'CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****', ], 'OSSObjectType' => [ 'title' => 'OSSObjectType', 'description' => 'OSS Object类型。一般为`Normal`。', 'type' => 'string', 'example' => 'Normal', ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '该文件的自定义ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值，例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。', 'type' => 'string', 'example' => ' '."\n" .'member-image-id-0001', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索。', 'type' => 'object', 'example' => '{'."\n" .' "MemberName": "Tim",'."\n" .' "Enabled": "True",'."\n" .' "ItemCount": "10"'."\n" .'}', ], 'StreamCount' => [ 'title' => 'StreamCount', 'description' => ' 媒体容器中媒体流的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ProgramCount' => [ 'title' => 'ProgramCount', 'description' => '媒体容器中节目数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'FormatName' => [ 'title' => 'FormatName', 'description' => '媒体格式名称。', 'type' => 'string', 'example' => 'mov', ], 'FormatLongName' => [ 'title' => 'FormatLongName', 'description' => '媒体格式名称的全称。', 'type' => 'string', 'example' => 'QuickTime / MOV', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '首帧时间。单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.000000', ], 'Bitrate' => [ 'title' => 'Bitrate', 'description' => '码率，单位为比特每秒（bit/s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '13091201', ], 'Duration' => [ 'title' => 'Duration', 'description' => '视频的总时长。单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '15.263000', ], 'SemanticTypes' => [ 'title' => 'SemanticTypes', 'description' => '在使用 SemanticQuery API 进行语义搜索时，当前文件被搜索出来的原因列表。', 'type' => 'array', 'items' => [ 'description' => '在使用 SemanticQuery API 进行语义搜索时，当前文件被搜索出来的原因。'."\n" ."\n" .'可选值如下：'."\n" .'- content：文档语义内容、图片上的内容相符。'."\n" .'- text：文档的文字字符串、图片上的文字相符。'."\n" .'- datetime：文件的创作时间相符。'."\n" .'- address：文件的创作地点相符。'."\n" .'- figure：文件中包含的人物名称相符。'."\n" .'>可选值可能随着算法演进而增加。>', 'type' => 'string', 'example' => 'content', ], ], 'Elements' => [ 'title' => 'Elements', 'description' => '在使用 SemanticQuery API 进行语义搜索时，和当前搜索内容匹配的文档片段元素列表。', 'type' => 'array', 'items' => [ 'description' => '和当前搜索内容匹配的文档片段元素信息。', '$ref' => '#/components/schemas/Element', ], ], 'SceneElements' => [ 'title' => 'SceneElements', 'description' => '视频片段元素列表。使用AI大模型对视频进行分析后，抽取出来的若干场景片段元素。', 'type' => 'array', 'items' => [ 'description' => '视频片段元素信息。', '$ref' => '#/components/schemas/SceneElement', ], ], 'OCRTexts' => [ 'title' => 'OCRTexts', 'description' => '图片中检测到的文本。', 'type' => 'string', 'example' => '阿里云IMM', ], 'Reason' => [ 'title' => 'Reason', 'description' => '文件运行索引失败的原因。', 'type' => 'string', 'example' => '[InternalError] The request has been failed due to some unknown error. status: 500, requestId: CC5ACFBD-BB7A-496D-A9D6-****', ], 'ObjectStatus' => [ 'title' => 'ObjectStatus', 'description' => '文件索引状态。', 'type' => 'string', 'enumValueTitles' => [ 'Failed' => '文件执行索引构建失败。', 'Indexed' => '文件执行索引构建完成。', 'Pending' => '文件已经提交索引任务，准备进入索引构建。', 'Deleting' => '文件处于删除中，此时该文件进入清理阶段，此阶段用户无法对文件进行写操作，如IndexFileMeta、UpdateFileMeta会返回409', 'Indexing' => '文件执行索引构建任务过程中。', ], 'example' => 'Indexed', ], 'Insights' => [ 'description' => '文件的摘要与描述。'."\n" .'> 暂时不支持。', '$ref' => '#/components/schemas/Insights', ], ], ], 'FileSmartCluster' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'SmartClusterId' => [ 'title' => 'SmartClusterId', 'description' => 'SmartClusterId', 'type' => 'string', 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', ], 'Similarity' => [ 'title' => 'Similarity', 'description' => 'Similarity', 'type' => 'number', 'format' => 'float', 'example' => '0.9', ], ], ], 'FunctionCall' => [ 'title' => 'AI助手可调用函数的定义', 'description' => 'AI 助手可调用的function 的定义', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '函数名称', 'description' => '函数名称', 'type' => 'string', 'required' => true, 'example' => 'search_file', ], 'Arguments' => [ 'title' => '由LLM识别的实参列表', 'description' => '由LLM识别的实参列表', 'type' => 'string', 'example' => '{'."\n" .'                    "type": "object",'."\n" .'                        "name": {'."\n" .'                            "type": "string", '."\n" .'                            "description": "需要检索的文件的文件名。可以为空 null"'."\n" .'                        }, '."\n" .'                    "required": ['."\n" .'                        "category"'."\n" .'                    ]'."\n" .'}', ], ], ], 'HeadPose' => [ 'title' => 'A short description of struct', 'description' => '头部朝向信息。', 'type' => 'object', 'properties' => [ 'Pitch' => [ 'title' => 'Pitch', 'description' => '人脸的俯仰角，取值范围为-180度～180度，可信的范围建议为-30度～30度。', 'type' => 'number', 'format' => 'float', 'example' => '18.385589599609375', ], 'Roll' => [ 'title' => 'Roll', 'description' => '内偏转角，取值范围为-180度～180度，可信的建议范围为-45度～45度。', 'type' => 'number', 'format' => 'float', 'example' => '4.204030513763428', ], 'Yaw' => [ 'title' => 'Yaw', 'description' => '人脸的左右偏转角，取值范围为-180度～180度，可信的范围建议为-80度～80 度。', 'type' => 'number', 'format' => 'float', 'example' => '2.4945924282073975', ], ], ], 'Hyperparameters' => [ 'title' => '模型训练运行超参数信息', 'description' => '模型训练运行超参数信息', 'type' => 'object', 'properties' => [ 'BatchSize' => [ 'title' => '训练BatchSize', 'description' => '训练BatchSize', 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], 'InputSize' => [ 'title' => '图像大小, 数组内宽和高', 'description' => '图像大小, 数组内宽和高', 'type' => 'array', 'items' => [ 'description' => '图像大小, 数组内宽和高', 'type' => 'integer', 'format' => 'int64', 'example' => '640', ], 'required' => true, ], 'Schedule' => [ 'description' => '学习率变化策略', '$ref' => '#/components/schemas/Schedule', ], 'MaxEpoch' => [ 'title' => '总的训练迭代epoch轮数', 'description' => '总的训练迭代epoch轮数', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Evaluator' => [ 'description' => '模型训练自定义参数信息', 'required' => true, '$ref' => '#/components/schemas/CustomParams', ], 'DataLoaderWorkers' => [ 'title' => '读取训练数据线程数', 'description' => '读取训练数据线程数', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'Optimization' => [ 'description' => '优化算法信息', '$ref' => '#/components/schemas/Optimization', ], 'BackupInterval' => [ 'title' => '保存模型配置频率，1表示每过一遍训练数据保存一次', 'description' => '保存模型配置频率，1表示每过一遍训练数据保存一次', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], 'Image' => [ 'title' => 'A short description of struct', 'description' => '图片信息对象。', 'type' => 'object', 'properties' => [ 'ImageWidth' => [ 'title' => 'ImageWidth', 'description' => '图片宽度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'ImageHeight' => [ 'title' => 'ImageHeight', 'description' => '图片高度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '820', ], 'EXIF' => [ 'title' => 'EXIF', 'description' => '图片原始EXIF信息，以JSON Object序列化后的格式存储。参考[OSS获取图片信息](~~44975~~)。', 'type' => 'string', 'example' => '{"FileSize":{"value":"29304"},"Format":{"value":"jpg"}}', ], 'ImageScore' => [ 'description' => '图片评分信息。', '$ref' => '#/components/schemas/ImageScore', ], 'CroppingSuggestions' => [ 'title' => 'CroppingSuggestions', 'description' => '图片的裁减建议列表。预留参数，暂不提供。', 'type' => 'array', 'items' => [ 'description' => '图片的裁减建议。', '$ref' => '#/components/schemas/CroppingSuggestion', ], ], 'OCRContents' => [ 'title' => 'OCRContents', 'description' => 'OCR识别结果列表。预留参数，暂不提供。', 'type' => 'array', 'items' => [ 'description' => 'OCR识别结果。', '$ref' => '#/components/schemas/OCRContents', ], ], ], ], 'ImageInsight' => [ 'description' => '图片摘要与描述。', 'type' => 'object', 'properties' => [ 'Caption' => [ 'description' => '图片摘要。'."\n" ."\n" .'> 暂时不支持。', 'type' => 'string', 'example' => '无。', ], 'Description' => [ 'description' => '图片描述。', 'type' => 'string', 'example' => '图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色。', ], ], ], 'ImageScore' => [ 'title' => 'A short description of struct', 'description' => '图片评分信息。', 'type' => 'object', 'properties' => [ 'OverallQualityScore' => [ 'title' => 'OverallQualityScore', 'description' => '图片整体质量评分。该评分为AI自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。'."\n" ."\n" .'范围0-1，越高则质量越好。', 'type' => 'number', 'format' => 'float', 'example' => '0.736', ], ], ], 'ImageURL' => [ 'type' => 'object', 'properties' => [ 'URL' => [ 'type' => 'string', ], 'Thumbnail' => [ 'type' => 'string', ], ], ], 'Input' => [ 'title' => 'A short description of struct', 'description' => '数据接入的输入配置对象。', 'type' => 'object', 'properties' => [ 'OSS' => [ 'description' => '对象存储OSS数据源', '$ref' => '#/components/schemas/InputOSS', ], ], ], 'InputFile' => [ 'title' => 'A short description of struct', 'description' => '用于建立索引（如[IndexFileMeta](~~478166~~)）或更新索引（如[UpdateFileMeta](~~478168~~)）时的文件信息。', 'type' => 'object', 'properties' => [ 'URI' => [ 'title' => 'URI', 'description' => '必填项，本次请求进行索引、进行元数据更新的文件对象地址。支持OSS和PDS的URI地址。'."\n" ."\n" .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一区域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" ."\n" .'PDS地址规则为`pds://domains/${domain}/drives/${drive}/files/${file}/revisions/${revision}`。'."\n" ."\n" .'>不支持`HTTP`开头的地址>', 'type' => 'string', 'example' => 'oss://test-bucket/test-object', ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '可选项，该文件的自定义ID。该文件索引到数据集后，作为该行元数据的属性存储，用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值，例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。'."\n" ."\n" .'在查询时，该字段支持前缀查询和排序，详情请见[字段和操作符的支持列表](~~2743991~~)。', 'type' => 'string', 'example' => 'member-image-id-0001', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '可选项，文件自定义标签列表。储存您业务自定义的键名、键值对信息，用于在查询时可以据此为筛选项进行检索，详情请见[字段和操作符的支持列表](~~2743991~~)。', 'type' => 'object', 'example' => '{'."\n" .' "MemberName": "Tim",'."\n" .' "Enabled": "True",'."\n" .' "ItemCount": "10"'."\n" .'}', ], 'FileHash' => [ 'title' => 'FileHash', 'description' => '可选项，一般留空，文件哈希值。仅URI为PDS地址时需要传入。', 'type' => 'string', 'example' => '1d9c280a7c4f67f7ef873e28449dbe17', ], 'OSSURI' => [ 'title' => 'OSSURI', 'description' => '可选项，一般留空，OSS文件的路径。仅URI为PDS地址时可选传入。', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg', ], 'MediaType' => [ 'title' => 'MediaType', 'description' => '可选项，一般留空。文件媒体类型。', 'type' => 'string', 'enumValueTitles' => [ 'image' => '图片', 'other' => '其他', 'document' => '文档', 'archive' => '压缩包', 'video' => '视频', 'audio' => '音频', ], 'example' => 'image', ], 'ContentType' => [ 'title' => 'ContentType', 'description' => '可选项，一般留空。文件内容类型（MIME Type）。', 'type' => 'string', 'example' => 'image/jpeg', ], 'Figures' => [ 'title' => 'Figures', 'description' => '可选项。需要更新的人物列表。用于将某个人物移除出人物分组，或修改人物分组。请参考[人脸聚类](~~477175~~)能力。'."\n" .'>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。>', 'type' => 'array', 'items' => [ 'description' => '人物信息对象。', 'type' => 'object', 'properties' => [ 'FigureId' => [ 'title' => 'FigureId', 'description' => '人物对象ID。', 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', ], 'FigureClusterId' => [ 'title' => 'FigureClusterId', 'description' => '人物聚类ID。包括如下保留的特殊聚类ID命名：'."\n" ."\n" .'- figure-cluster-id-independent：该人脸暂无合适的分组，后续在数据集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" ."\n" .'- figure-cluster-id-unavailable：该人脸暂未进行过聚类操作，即在数据集中新增图片后，未进行人脸聚类。', 'type' => 'string', 'example' => 'Cluster-dbe72fec-b84c-4ab6-885b-3678e64****'."\n", ], 'FigureType' => [ 'title' => 'FigureType', 'description' => '人物类型。目前填入固定值`face`。', 'type' => 'string', 'enumValueTitles' => [ 'face' => 'face', ], 'example' => 'face', ], ], ], ], 'LatLong' => [ 'title' => 'LatLong', 'description' => 'GPS 经纬度信息。', 'type' => 'string', 'example' => '30.134390,120.074997', ], 'ProduceTime' => [ 'title' => 'ProduceTime', 'description' => '照片拍摄时间。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'Title' => [ 'title' => 'Title', 'description' => '文件标题。', 'type' => 'string', 'example' => 'test', ], 'Artist' => [ 'title' => 'Artist', 'description' => '艺术家。', 'type' => 'string', 'example' => 'Jane', ], 'AlbumArtist' => [ 'title' => 'AlbumArtist', 'description' => '演唱者。', 'type' => 'string', 'example' => 'Jane', ], 'Composer' => [ 'title' => 'Composer', 'description' => '作曲家。', 'type' => 'string', 'example' => 'Jane', ], 'Performer' => [ 'title' => 'Performer', 'description' => '演奏者。', 'type' => 'string', 'example' => 'Jane', ], 'Album' => [ 'title' => 'Album', 'description' => '专辑。', 'type' => 'string', 'example' => 'FirstAlbum', ], 'Labels' => [ 'title' => 'Labels', 'description' => '智能标签列表。'."\n" .'>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。>', 'type' => 'array', 'items' => [ 'description' => '智能标签对象。', '$ref' => '#/components/schemas/Label', ], ], 'Addresses' => [ 'title' => 'Addresses', 'description' => '地址信息列表。'."\n" .'>仅对UpdateFileMeta/BatchUpdateFileMeta接口生效。>', 'type' => 'array', 'items' => [ 'description' => '地址信息。', '$ref' => '#/components/schemas/Address', ], ], ], ], 'InputOSS' => [ 'title' => 'A short description of struct', 'description' => '数据接入的OSS输入配置对象。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => 'OSS Bucket 名字', 'description' => 'OSS Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], 'Prefix' => [ 'title' => '对象 Key 的前缀', 'description' => '对象Key的前缀。', 'type' => 'string', 'example' => 'test-object', ], 'MatchExpressions' => [ 'title' => '过滤表达式', 'description' => '过滤表达式。', 'type' => 'array', 'items' => [ 'description' => '匹配模式。', 'type' => 'string', 'example' => 'key prefix (abc)', ], ], ], ], 'Insights' => [ 'description' => '文件的摘要与描述。', 'type' => 'object', 'properties' => [ 'Video' => [ 'description' => '视频摘要与描述信息。', '$ref' => '#/components/schemas/VideoInsight', ], 'Image' => [ 'description' => '图片摘要与描述信息。', '$ref' => '#/components/schemas/ImageInsight', ], ], ], 'KdtreeOption' => [ 'title' => 'KdtreeOption', 'description' => 'Kdtree选项对象。', 'type' => 'object', 'properties' => [ 'CompressionLevel' => [ 'title' => 'CompressionLevel', 'description' => '压缩级别，取值范围：0~10，值越大细节效果越好，压缩率越高。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '5', ], 'QuantizationBits' => [ 'title' => 'QuantizationBits', 'description' => '量化位数，取值范围：0~31，越大细节保留越多，0表示不做顶点压缩。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '31', 'minimum' => '0', 'example' => '10', ], 'LibraryName' => [ 'title' => 'LibraryName', 'description' => '目前kdtree只支持“draco”，默认值是“draco”。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'draco', 'default' => 'draco', 'enum' => [ 'draco', ], ], ], ], 'KeyValuePair' => [ 'title' => 'A short description of struct', 'description' => '键值对信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '键', 'description' => '键。', 'type' => 'string', 'example' => 'bucket', ], 'Value' => [ 'title' => '值', 'description' => '值。', 'type' => 'string', 'example' => 'testbucket', ], ], ], 'Label' => [ 'title' => 'A short description of struct', 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'Language' => [ 'title' => 'Language', 'description' => '标签语言，格式为BCP 47。', 'type' => 'string', 'example' => 'zh-Hans', ], 'LabelName' => [ 'title' => 'LabelName', 'description' => '标签名称。', 'type' => 'string', 'example' => '椅子', ], 'LabelLevel' => [ 'title' => 'LabelLevel', 'description' => '标签等级，当前标签等级可以取1、2、3，分别表示该标签为第一、二、三级标签。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'LabelConfidence' => [ 'title' => 'LabelConfidence', 'description' => '标签置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '0.95', ], 'ParentLabelName' => [ 'title' => 'ParentLabelName', 'description' => '父级标签名称。', 'type' => 'string', 'example' => '家具', ], 'CentricScore' => [ 'title' => 'CentricScore', 'description' => '标签的中心值分数，指该标签在图片中是否为主体，取值范围为0~1，数值越高表示该标签为图片主体的置信度越高。', 'type' => 'number', 'format' => 'float', 'example' => '0.877', ], ], ], 'LicensePlate' => [ 'title' => 'A short description of struct', 'description' => '车牌。', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => '车牌号', 'description' => '车牌号。', 'type' => 'string', 'enumValueTitles' => [], 'example' => '鲁A8***8', ], 'Boundary' => [ 'title' => '车牌裁剪框', 'description' => '车牌裁剪框。', '$ref' => '#/components/schemas/Boundary', ], 'Confidence' => [ 'title' => '置信度', 'description' => '置信度。', 'type' => 'number', 'format' => 'double', 'example' => '0.789', ], ], ], 'LocationDateCluster' => [ 'title' => '时空聚类对象', 'description' => '时空聚类对象。', 'type' => 'object', 'properties' => [ 'Title' => [ 'title' => '标题', 'description' => '用户自定义的标题。', 'type' => 'string', 'example' => '杭州一日游', ], 'LocationDateClusterLevel' => [ 'title' => '级别', 'description' => '分组的行政级别。', 'type' => 'string', 'enumValueTitles' => [ 'country' => '国家或地区', 'province' => '省', 'city' => '市', 'district' => '区', 'township' => '街道', ], 'example' => 'province', ], 'LocationDateClusterStartTime' => [ 'title' => '开始时间', 'description' => '分组起始时间。', 'type' => 'string', 'example' => '2022-05-01T00:00:00+08:00', ], 'LocationDateClusterEndTime' => [ 'title' => '结束时间', 'description' => '分组结束时间。', 'type' => 'string', 'example' => '2022-05-02T23:59:59.999999999+08:00', ], 'Addresses' => [ 'title' => '地址', 'description' => '分组地址列表。', 'type' => 'array', 'items' => [ 'description' => '地址对象。', '$ref' => '#/components/schemas/Address', ], ], 'ObjectId' => [ 'title' => '唯一ID', 'description' => '分组ID。', 'type' => 'string', 'example' => 'location-date-cluster-14f48cb3-079d-4595-80c4-5735284b****', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '分组更新时间。', 'type' => 'string', 'example' => '2022-11-16T13:15:05.65746784+08:00', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '分组创建时间。', 'type' => 'string', 'example' => '2022-11-16T13:14:34.882523669+08:00', ], 'CustomId' => [ 'title' => '自定义ID', 'description' => '自定义ID。', 'type' => 'string', 'example' => 'user-01', ], 'CustomLabels' => [ 'title' => '自定义标签', 'description' => '自定义标签。', 'type' => 'object', 'example' => '{'."\n" .' "User": "Jane"'."\n" .'}', ], ], ], 'MNS' => [ 'title' => 'A short description of struct', 'description' => '轻量消息队列（原 MNS）消息通知参数。', 'type' => 'object', 'properties' => [ 'TopicName' => [ 'title' => 'TopicName', 'description' => '轻量消息队列SMQ（原 MNS）主题名称。可登录[轻量消息队列SMQ（原MNS）控制台](https://mns.console.aliyun.com/),在左侧导航栏中点击当前地域下主题列表中获取。如果需使用轻量消息队列（原 MNS）做消息通知，该参数必填。', 'type' => 'string', 'example' => 'topic1', ], ], ], 'Message' => [ 'title' => '智能助手消息', 'description' => '智能助手消息', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'title' => '时间', 'description' => '时间', 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00', ], 'Regenerate' => [ 'title' => '是否为重新生成的答案', 'description' => '是否为重新生成的答案', 'type' => 'boolean', 'example' => 'false', ], 'Score' => [ 'title' => '打分', 'description' => '打分', 'type' => 'number', 'format' => 'double', 'example' => '0.99', ], 'AssistantType' => [ 'title' => '助手类型', 'description' => '助手类型', 'type' => 'string', 'example' => 'doc/translate', ], 'DatasetName' => [ 'title' => '问答引用的数据集', 'description' => '问答引用的数据集', 'type' => 'string', 'example' => 'test-dataset', ], 'SourceURI' => [ 'title' => '问答来源文件地址', 'description' => '问答来源文件地址', 'type' => 'string', 'example' => 'oss://test-bucket/sample.docx', ], 'Topic' => [ 'title' => '问题主题', 'description' => '问题主题', 'type' => 'string', 'example' => '根据 AssistantType 不同具体含义不同。', ], 'Content' => [ 'title' => '问题内容', 'description' => '问题内容', 'type' => 'string', 'example' => '你好，哪个公园距离我最近？', ], 'Language' => [ 'title' => '回答语言', 'description' => '回答语言', 'type' => 'string', 'example' => 'zh-Hans', ], 'Tone' => [ 'title' => '回答语气', 'description' => '回答语气', 'type' => 'string', 'example' => 'professional', ], 'Reply' => [ 'title' => '回答', 'description' => '回答', 'type' => 'string', 'example' => '你好，我是你的助手', ], 'Suggestion' => [ 'title' => '合规检测结果', 'description' => '合规检查结果，可选值：'."\n" .'pass'."\n" .'block', 'type' => 'string', 'example' => 'pass', ], ], ], 'MetaData' => [ 'title' => '模型基本信息', 'description' => '模型基本信息', 'type' => 'object', 'properties' => [ 'Identifier' => [ 'title' => '模型类别标识', 'description' => '模型类别标识', 'type' => 'string', 'example' => 'detection', ], 'Version' => [ 'title' => '模型版本', 'description' => '模型版本', 'type' => 'string', 'example' => 'v1', ], 'Provider' => [ 'title' => '模型提供者', 'description' => '模型提供者', 'type' => 'string', 'example' => 'imm', ], ], ], 'ModelSpecification' => [ 'title' => '模型详细规格信息', 'description' => '模型详细规格信息', 'type' => 'object', 'properties' => [ 'MetaData' => [ 'description' => '模型基本信息', 'required' => true, '$ref' => '#/components/schemas/MetaData', ], 'Spec' => [ 'description' => '模型规格信息', 'required' => true, '$ref' => '#/components/schemas/Spec', ], ], ], 'Notification' => [ 'description' => '消息通知对象，支持多种消息中间件，消息格式详情请见[异步通知消息格式](~~2743997~~)，请选择其中一种方式接收消息，使用方式如下所示：'."\n" .'- 在与智能媒体管理相同的地域下开通并接入[事件总线EventBridge](~~161886~~)服务，及时获取任务信息通知。更多信息，请参见[智能媒体管理IMM事件](~~205730~~)。'."\n" .'- 在与智能媒体管理相同的地域下开通[MNS](~~27412~~)服务，并配置订阅关系。'."\n" .'- 在与智能媒体管理相同的地域下开通[RocketMQ](~~29530~~)服务，并创建RocketMQ 4.0实例、Topic、Group。'."\n" .'>Notification不支持自定义回调地址。>', 'type' => 'object', 'properties' => [ 'MNS' => [ 'title' => 'MNS', 'description' => 'MNS通知参数对象。', '$ref' => '#/components/schemas/MNS', ], 'RocketMQ' => [ 'title' => 'RocketMQ', 'description' => 'RocketMQ通知参数对象。', '$ref' => '#/components/schemas/RocketMQ', ], 'ExtendedMessageURI' => [ 'title' => 'ExtendedMessageURI', 'description' => '使用OSS文件接受任务消息通知。提供该文件地址后，任务执行的具体信息会以JSON结构写入到该文件中。一般情况下，您只需要通过[事件总线EventBridge](~~161886~~)服务、[MNS](~~27412~~)服务或[RocketMQ](~~29530~~)服务接受消息通知，但部分任务执行的信息会比较大（例如压缩包文件预览、解压任务），您可以通过提供该文件获取具体的任务执行结果。'."\n" ."\n" .'OSS地址规则为oss://${Bucket}/${Object}，其中`${Bucket}`为和当前项目处于同一地域(Region)的OSS Bucket名称，`${Object}`为包含文件扩展名的文件完整路径。'."\n" ."\n\n" .'>该文件并不作为消息通知的方式，仅作为接受任务执行具体信息的载体。任务的状态信息会通过消息通知的方式发送，该文件仅包含任务执行的具体信息。 '."\n" .'>', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.json', ], ], ], 'OCRContents' => [ 'title' => 'A short description of struct', 'description' => 'OCR内容。', 'type' => 'object', 'properties' => [ 'Language' => [ 'title' => 'Language', 'description' => '语言，格式为BCP 47。当前版本不支持此参数。', 'type' => 'string', 'example' => 'zh-hans', ], 'Contents' => [ 'title' => 'Contents', 'description' => '文字内容。', 'type' => 'string', 'example' => '欢迎使用智能媒体管理', ], 'Confidence' => [ 'title' => 'Confidence', 'description' => '文字置信度，取值范围为0（表示置信度最低）~1（表示置信度最高）。', 'type' => 'number', 'format' => 'float', 'example' => '0.8254936695098877', ], 'Boundary' => [ 'title' => 'Boundary', 'description' => '边界。', '$ref' => '#/components/schemas/Boundary', ], ], ], 'OctreeOption' => [ 'title' => 'OctreeOption', 'description' => 'Octree选项对象。', 'type' => 'object', 'properties' => [ 'PointResolution' => [ 'title' => 'PointResolution', 'description' => '点云分辨率，该变量决定了点的坐标在编码时可以精确的程度，默认值为 0.01。', 'type' => 'number', 'format' => 'double', 'maximum' => '1', 'minimum' => '0', 'example' => '0.01', 'default' => '0.01', ], 'OctreeResolution' => [ 'title' => 'OctreeResolution', 'description' => '划分八叉树时最小块，即voxel的边长，默认值为 0.01。', 'type' => 'number', 'format' => 'double', 'maximum' => '1', 'minimum' => '0', 'example' => '0.01', 'default' => '0.01', ], 'DoVoxelGridDownDownSampling' => [ 'title' => 'DoVoxelGridDownDownSampling', 'description' => '是否对点云文件进行下采样，可选值如下：'."\n" ."\n" .'- true：对点云文件进行下采样,，以体素的中心点的坐标来代替整个体素内的点的坐标,，而颜色则以体素内所有点的颜色的均值为代表，此时PointResolution不会生效。'."\n" .'- false： 则进行细节编码，即编码一个体素内的具体坐标与颜色，实现方式是计算体素内每个点到体素左下角的偏移量，并通过整除PointResolution来得到整数坐标，而颜色则需编码体素内每个点的颜色相对于平均值的残差。', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', ], 'LibraryName' => [ 'title' => 'LibraryName', 'description' => '目前octree只支持“pcl”，默认值为“pcl”。', 'type' => 'string', 'example' => 'pcl', 'default' => 'pcl', 'enum' => [ 'pcl', ], ], ], ], 'Optimization' => [ 'title' => '优化算法信息', 'description' => '优化算法信息', 'type' => 'object', 'properties' => [ 'LearningRate' => [ 'title' => '初始学习率', 'description' => '初始学习率', 'type' => 'number', 'format' => 'float', 'example' => '0.01', ], 'Optimizer' => [ 'title' => '优化方法', 'description' => '优化方法', 'type' => 'string', 'example' => 'SGD', ], ], ], 'PointInt64' => [ 'title' => '点坐标', 'description' => '点坐标信息。', 'type' => 'object', 'properties' => [ 'X' => [ 'title' => '横坐标X', 'description' => '顶点X坐标距离左端距离，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Y' => [ 'title' => '纵坐标Y', 'description' => '顶点Y坐标距离顶端距离，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], 'Project' => [ 'title' => '项目结构体', 'description' => '项目信息。', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称。', 'type' => 'string', 'example' => 'immtest', ], 'ServiceRole' => [ 'title' => '服务角色', 'description' => '服务角色。', 'type' => 'string', 'example' => 'AliyunIMMDefaultRole', ], 'TemplateId' => [ 'title' => '模板Id', 'description' => '工作流模板Id。', 'type' => 'string', 'example' => 'Official:ImageManagement', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '项目创建时间的时间戳，格式为RFC3339Nano。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '项目修改时间的时间戳，格式为RFC3339Nano。'."\n" ."\n" .'>创建项目后，如果未更新过项目，则项目修改时间的时间戳和项目创建时间的时间戳相同。', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'Description' => [ 'title' => '描述', 'description' => '项目描述信息。', 'type' => 'string', 'example' => '测试项目', ], 'ProjectQueriesPerSecond' => [ 'title' => '项目QPS', 'description' => '项目每秒能处理请求的最大个数，即每秒钟允许调用该项目所属各API的个数，默认值为100。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'EngineConcurrency' => [ 'title' => '项目最大并发数', 'description' => '项目每秒能处理任务的最大个数。即该项目所有算子在同一时间可以并行运行的个数，默认值为100。'."\n" ."\n" .'- 同步任务：同时运行的数量超过该限制时，会导致任务执行时间延长，直至超时。'."\n" ."\n" .'- 异步任务：同时运行的数量超过该限制时，会导致任务排队一段时间，任务完成时间延后。当排队时间也超过限制（一般数十分钟）后，该任务返回失败。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'ProjectMaxDatasetCount' => [ 'title' => '项目最多媒体集数量', 'description' => '项目中数据集的最大个数，取值范围为1~1000000000，默认值为1000000000。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000', ], 'DatasetMaxBindCount' => [ 'title' => '项目最多绑定数', 'description' => '每个数据集绑定的最大个数，取值范围为1~10，默认值为10。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'DatasetMaxFileCount' => [ 'title' => '项目最多文件数', 'description' => '每个数据集中文件的最大个数，取值范围为1~100000000，默认值为100000000。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000', ], 'DatasetMaxEntityCount' => [ 'title' => '项目最多实体数', 'description' => '每个数据集中元数据实体的最大个数，默认值为10000000000。'."\n" ."\n" .'> 当前该字段仅为预留，使用中并不做实际限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000', ], 'DatasetMaxRelationCount' => [ 'title' => '项目最多关系数', 'description' => '每个数据集中元数据关系的最大个数，默认值为100000000000。'."\n" ."\n" .'> 当前该字段仅为预留，使用中并不做实际限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000000', ], 'DatasetMaxTotalFileSize' => [ 'title' => '项目最大文件总大小', 'description' => '每个数据集中文件总大小的最大值，超过限制后无法再添加索引。默认值为90000000000000000，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '90000000000000000', ], 'DatasetCount' => [ 'title' => '项目当前媒体集数', 'description' => '项目当前数据集数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'FileCount' => [ 'title' => '项目当前文件数', 'description' => '项目当前文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TotalFileSize' => [ 'title' => '项目当前文件总大小', 'description' => '项目当前文件总大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'Tags' => [ 'title' => '标签', 'description' => '标签列表。', 'type' => 'array', 'items' => [ 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'TagKey' => [ 'title' => 'TagKey', 'description' => '标签键。', 'type' => 'string', 'example' => 'TestKey', ], 'TagValue' => [ 'title' => 'TagValue', 'description' => '标签值。', 'type' => 'string', 'example' => 'TestValue', ], ], ], ], ], ], 'Property' => [ 'title' => '属性信息', 'description' => '属性信息', 'type' => 'object', 'properties' => [ 'ItemsType' => [ 'title' => '如果字段ValueType类型是array, 则需要指定内部的子项类型，枚举值有: float 、integer、string', 'description' => '如果字段ValueType类型是array, 则需要指定内部的子项类型，枚举值有: float、integer、string。', 'type' => 'string', 'example' => 'float', ], 'ValueType' => [ 'title' => '属性类型, 枚举值有：float、integer、string、array', 'description' => '属性类型, 枚举值有：float、integer、string、array。', 'type' => 'string', 'example' => 'array', ], 'Value' => [ 'title' => '属性值', 'description' => '属性值', 'type' => 'string', 'example' => '[40, 80, 160, 320]', ], 'Name' => [ 'title' => '属性名称', 'description' => '属性名称', 'type' => 'string', 'example' => 'channels', ], ], ], 'ReferenceFile' => [ 'title' => 'A short description of struct', 'description' => 'AI 机器人问答API中，回答内容对应的参考文献', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'test-project', ], 'DatasetName' => [ 'title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'test-dataset', ], 'ObjectId' => [ 'title' => '文件的唯一ID', 'description' => '文件的唯一ID', 'type' => 'string', 'example' => '75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7', ], 'URI' => [ 'title' => '文件URI', 'description' => '文件URI', 'type' => 'string', 'example' => 'oss://test-bucket/test-object.jpg', ], ], ], 'RegionType' => [ 'title' => 'RegionType', 'description' => '地域对象。', 'type' => 'object', 'properties' => [ 'RegionId' => [ 'title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing', ], 'LocalName' => [ 'title' => 'LocalName', 'description' => '地域名称。', 'type' => 'string', 'example' => '华北2（北京）', ], ], ], 'Resource' => [ 'title' => '执行资源配置信息', 'description' => '执行资源配置信息', 'type' => 'object', 'properties' => [ 'ECSInstance' => [ 'title' => 'ECS实例', 'description' => 'ECS实例', 'type' => 'string', 'example' => 'ecs.gn5i-c2g1.large', ], 'CPU' => [ 'title' => 'CPU核心数 范围4~96', 'description' => 'CPU核心数范围4~96', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'GPUNum' => [ 'title' => 'GPU个数', 'description' => 'GPU个数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'title' => '展示文案', 'description' => '展示文案', 'type' => 'string', 'example' => 'ecs.gn5i-c2g1.large-2vCPU-8GB-1*NVIDIA_P4', ], 'RAM' => [ 'title' => '内存大小（单位G）30~736', 'description' => '内存大小（单位G）30~736', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'GPUModel' => [ 'title' => 'GPU型号', 'description' => 'GPU型号', 'type' => 'string', 'example' => 'NVIDIA_P4', ], ], ], 'RocketMQ' => [ 'title' => 'A short description of struct', 'description' => 'RocketMQ消息通知参数。', 'type' => 'object', 'properties' => [ 'TopicName' => [ 'title' => 'TopicName', 'description' => 'RocketMQ Topic名称。如果需使用RocketMQ做消息通知，该参数必填。', 'type' => 'string', 'example' => 'topic1', ], 'InstanceId' => [ 'title' => 'InstanceId', 'description' => 'RocketMQ实例Id。如果需使用RocketMQ做消息通知，该参数必填。', 'type' => 'string', 'example' => 'MQ_INST_11111111111_BYcNy2Nc', ], ], ], 'Row' => [ 'title' => 'A short description of struct', 'description' => '单个文件信息。', 'type' => 'object', 'properties' => [ 'URI' => [ 'title' => 'URI', 'description' => 'OSS文件的存储位置。'."\n" ."\n" .'OSS地址规则为`oss://${bucketname}/${objectname}`，其中`bucketname`为和当前项目处于同一地域的OSS Bucket名称，`objectname`为文件路径。', 'type' => 'string', 'example' => 'oss://examplebucket/exampleobject.jpg', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '自定义标签列表。', 'type' => 'array', 'items' => [ 'description' => '标签键值对。', '$ref' => '#/components/schemas/KeyValuePair', ], ], ], ], 'Runtime' => [ 'title' => '模型训练运行时信息', 'description' => '模型训练运行时信息', 'type' => 'object', 'properties' => [ 'Hyperparameters' => [ 'description' => '模型训练运行超参数信息', 'required' => true, '$ref' => '#/components/schemas/Hyperparameters', ], 'Resource' => [ 'description' => '执行资源配置信息', 'required' => true, '$ref' => '#/components/schemas/Resource', ], ], ], 'SceneElement' => [ 'title' => '视频场景元素', 'description' => '视频场景元素。', 'type' => 'object', 'properties' => [ 'TimeRange' => [ 'title' => '视频元素的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', 'description' => '视频元素的时间范围，数组长度固定为2，分别代表开始时间和结束时间，单位为毫秒。', 'type' => 'array', 'items' => [ 'description' => '视频元素的时间范围。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], 'FrameTimes' => [ 'title' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', 'description' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', 'type' => 'array', 'items' => [ 'description' => '当前视频元素内，和检索内容匹配的若干个帧的时间，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], ], 'VideoStreamIndex' => [ 'description' => '当前视频场景元素所属的视频流编号，对应视频流数组（[VideoStreams](https://help.aliyun.com/zh/imm/developer-reference/api-imm-2020-09-30-detectmediameta?spm=a2c4g.11186623.0.0.463e600fIDdM8r#api-detail-40)）的下标。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'Schedule' => [ 'title' => '学习率变化策略', 'description' => '学习率变化策略', 'type' => 'object', 'properties' => [ 'Gamma' => [ 'title' => 'lr衰减率,仅当选择StepLR策略时生效', 'description' => 'lr衰减率,仅当选择StepLR策略时生效', 'type' => 'number', 'format' => 'float', 'example' => '0.97', ], 'StepSize' => [ 'title' => 'lr衰减间隔的epoch数量,仅当选择StepLR策略时生效', 'description' => 'lr衰减间隔的epoch数量,仅当选择StepLR策略时生效', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'LRScheduler' => [ 'title' => '学习率调整策略', 'description' => '学习率调整策略', 'type' => 'string', 'example' => 'StepLR', ], ], ], 'SimilarImage' => [ 'title' => 'A short description of struct', 'description' => '相似图片。', 'type' => 'object', 'properties' => [ 'URI' => [ 'title' => '图片URI', 'description' => '图片URI。', 'type' => 'string', 'example' => 'oss://test-bucket/test-object', ], 'ImageScore' => [ 'title' => '美学分数', 'description' => '美学分数。', 'type' => 'number', 'format' => 'double', 'example' => '0.709', ], ], ], 'SimilarImageCluster' => [ 'title' => 'A short description of struct', 'description' => '相似图片分类信息。', 'type' => 'object', 'properties' => [ 'ObjectId' => [ 'title' => '唯一ID', 'description' => '相似图片分类ID。', 'type' => 'string', 'example' => 'SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '更新时间。', 'type' => 'string', 'example' => '2023-02-08T09:42:34.354969088+08:00', ], 'CreateTime' => [ 'title' => '结束时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2023-02-08T09:42:34.354969088+08:00', ], 'CustomLabels' => [ 'title' => '自定义标签', 'description' => '自定义标签。', 'type' => 'object', ], 'Files' => [ 'title' => '相似图片文件', 'description' => '相似图片文件列表。', 'type' => 'array', 'items' => [ 'description' => '相似图片。', '$ref' => '#/components/schemas/SimilarImage', ], ], ], ], 'SimpleQuery' => [ 'title' => 'SimpleQuery 简单查询所用到的查询结构体', 'description' => 'SimpleQuery查询参数条件，可自嵌套。', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '需要查询的字段名', 'description' => '必填。字段名称。关于支持的字段，请参见[字段和操作符的支持列表](~~2743991~~)。', 'type' => 'string', 'example' => 'Size', ], 'Value' => [ 'title' => '需要查询的字段值', 'description' => '查询的字段值。当Operations为逻辑运算符（and、or、not或nested）时，该字段无效。', 'type' => 'string', 'example' => '10', ], 'Operation' => [ 'title' => '运算符', 'description' => '必填。操作运算符。', 'type' => 'string', 'enumValueTitles' => [ 'exist' => '存在性查询', 'not' => '逻辑非', 'or' => '逻辑或', 'prefix' => '前缀查询', 'and' => '逻辑与', 'lt' => '小于', 'match-phrase' => '字符串匹配查询', 'gte' => '大于等于', 'eq' => '等于', 'lte' => '小于等于', 'gt' => '大于', 'nested' => '字段为数组时，其中同一对象内逻辑条件查询', ], 'example' => 'and', ], 'SubQueries' => [ 'title' => '由 SimpleQuery 结构体组成的子查询数组', 'description' => '子查询的结构体。'."\n" ."\n" .'只有当Operations为逻辑运算符（and、or、not或nested）时，才能设置子查询条件。'."\n" ."\n" .'在逻辑运算符为and/or/not时，其SubQueries内描述的所有条件需符合父级设置的and/or/not逻辑关系。'."\n" ."\n" .'在逻辑运算符为nested时，其父级的Field必须为一个数组类的字段（如：Labels）。子查询条件SimpleQuery组的Operation必须为and/or/not中的一个或多个，其Field必须为父级Field的子属性。'."\n" ."\n" .'请参考[SimpleQuery - 简单查询](~~478175~~)查看使用用例。', 'type' => 'array', 'items' => [ 'description' => '子查询条件。', '$ref' => '#/components/schemas/SimpleQuery', ], ], ], ], 'SmartCluster' => [ 'title' => 'A short description of struct', 'description' => '智能分组', 'type' => 'object', 'properties' => [ 'OwnerId' => [ 'title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '1023210024677934', ], 'ProjectName' => [ 'title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'MyProject', ], 'DatasetName' => [ 'title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'MyDataset', ], 'ObjectType' => [ 'title' => '分组类型', 'description' => '分组类型', 'type' => 'string', 'example' => 'smart-cluster', ], 'ObjectId' => [ 'title' => '智能分组ID', 'description' => '智能分组ID', 'type' => 'string', 'example' => 'SmartCluster-12cd1645-deae-4b5e-9434-613747b75f6d', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'Name' => [ 'title' => '分组名称', 'description' => '分组名称', 'type' => 'string', 'example' => 'MySmartCluster1', ], 'Description' => [ 'title' => '分组的描述', 'description' => '分组的描述', 'type' => 'string', 'example' => '这是一个智能分组的描述示例，它用于展示记录的格式。', ], 'ObjectStatus' => [ 'title' => '分组状态', 'description' => '分组状态', 'type' => 'string', 'example' => 'Succeeded', ], 'Rule' => [ 'title' => '分组规则', 'description' => '分组规则', '$ref' => '#/components/schemas/SmartClusterRule', ], ], ], 'SmartClusterRule' => [ 'title' => 'A short description of struct', 'description' => '智能分组规则', 'type' => 'object', 'properties' => [ 'Keywords' => [ 'title' => '关键词', 'description' => '关键词', 'type' => 'array', 'items' => [ 'description' => '关键字', 'type' => 'string', 'example' => '机器学习', ], ], 'Sensitivity' => [ 'title' => '敏感度', 'description' => '敏感度', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], ], ], 'Spec' => [ 'title' => '模型规格信息', 'description' => '模型规格信息', 'type' => 'object', 'properties' => [ 'Backbone' => [ 'description' => '模型训练自定义参数信息', '$ref' => '#/components/schemas/CustomParams', ], 'ClassNum' => [ 'title' => '最后一层输出的类别数量', 'description' => '最后一层输出的类别数量', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Head' => [ 'description' => '模型训练自定义参数信息', '$ref' => '#/components/schemas/CustomParams', ], 'Loss' => [ 'description' => '模型训练自定义参数信息', '$ref' => '#/components/schemas/CustomParams', ], 'InputChannel' => [ 'title' => '3', 'description' => '3', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Name' => [ 'title' => '模型名称，根绝模型类别，可选择名称不同', 'description' => '模型名称，根绝模型类别，可选择名称不同', 'type' => 'string', 'required' => true, 'example' => 'ClsResNet', ], 'Neck' => [ 'description' => '模型训练自定义参数信息', '$ref' => '#/components/schemas/CustomParams', ], 'NumLandmarks' => [ 'title' => '人脸标定点，一般为5, 当做人脸检测时才需要', 'description' => '人脸标定点，一般为5, 当做人脸检测时才需要', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'PretrainedPath' => [ 'title' => '预训练模型地址', 'description' => '预训练模型地址', 'type' => 'string', 'example' => 'oss://bucket/abc/xxx.json', ], ], ], 'Story' => [ 'title' => 'A short description of struct', 'description' => '故事信息。', 'type' => 'object', 'properties' => [ 'OwnerId' => [ 'title' => 'OwnerId', 'description' => '故事所属用户Id。', 'type' => 'string', 'example' => '102321002****', ], 'ProjectName' => [ 'title' => 'ProjectName', 'description' => '项目名称。', 'type' => 'string', 'example' => 'immtest', ], 'DatasetName' => [ 'title' => 'DatasetName', 'description' => '数据集名称。', 'type' => 'string', 'example' => 'dataset001', ], 'ObjectId' => [ 'title' => 'ObjectId', 'description' => '故事对象ID。', 'type' => 'string', 'example' => 'id1', ], 'ObjectType' => [ 'title' => 'ObjectType', 'description' => '故事对象类型。', 'type' => 'string', 'example' => 'story', ], 'UpdateTime' => [ 'title' => 'UpdateTime', 'description' => '故事更新时间。', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'CreateTime' => [ 'title' => 'CreateTime', 'description' => '故事创建时间。', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'StoryName' => [ 'title' => 'StoryName', 'description' => '故事名称。', 'type' => 'string', 'example' => 'name1', ], 'StoryType' => [ 'title' => 'StoryType', 'description' => '故事类型。', 'type' => 'string', 'example' => 'PeopleMemory', ], 'StorySubType' => [ 'title' => 'StorySubType', 'description' => '故事子类型。', 'type' => 'string', 'example' => 'ImportantPerson', ], 'StoryStartTime' => [ 'title' => 'StoryStartTime', 'description' => '故事开始时间。', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'StoryEndTime' => [ 'title' => 'StoryEndTime', 'description' => '故事结束时间。', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00', ], 'Files' => [ 'title' => 'Files', 'description' => '故事中包含的文件列表。', 'type' => 'array', 'items' => [ 'description' => '故事文件信息。', '$ref' => '#/components/schemas/File', ], ], 'Cover' => [ 'description' => '故事封面。', '$ref' => '#/components/schemas/File', ], 'FigureClusterIds' => [ 'title' => 'FigureClusterIds', 'description' => '人物聚类Id列表。', 'type' => 'array', 'items' => [ 'description' => '聚类Id。', 'type' => 'string', 'example' => '2cb3c51e-b406-4b0c-af1b-897d88e1****', ], ], 'CustomId' => [ 'title' => 'CustomId', 'description' => '自定义Id。', 'type' => 'string', 'example' => 'test', ], 'CustomLabels' => [ 'title' => 'CustomLabels', 'description' => '自定义标签。', 'type' => 'object', 'required' => false, 'example' => '{"key": "val"}', ], 'Addresses' => [ 'title' => 'Addresses', 'description' => '地址信息列表。', 'type' => 'array', 'items' => [ 'description' => '地址信息。', '$ref' => '#/components/schemas/Address', ], ], ], ], 'StreamOptions' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'IncrementalOutput' => [ 'title' => '是否增量输出', 'type' => 'boolean', ], 'NeedReturnFinalResult' => [ 'title' => '增量返回的情况下，在AI助手完成全部回答后，最后是否需要再返回一次全量的结果作为兜底', 'type' => 'boolean', ], ], ], 'SubtitleStream' => [ 'title' => 'A short description of struct', 'description' => '字幕流信息。', 'type' => 'object', 'properties' => [ 'Index' => [ 'title' => 'Index', 'description' => '字幕流索引号。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Language' => [ 'title' => 'Language', 'description' => '字幕语言，格式为BCP 47。', 'type' => 'string', 'example' => 'en', ], 'CodecName' => [ 'title' => 'CodecName', 'description' => '编码器名称。', 'type' => 'string', 'example' => 'mov_text', ], 'CodecLongName' => [ 'title' => 'CodecLongName', 'description' => '编码器名称的全称。', 'type' => 'string', 'example' => 'MOV text', ], 'CodecTagString' => [ 'title' => 'CodecTagString', 'description' => '编码器标识描述信息。', 'type' => 'string', 'example' => 'tx3g', ], 'CodecTag' => [ 'title' => 'CodecTag', 'description' => '编码器标识。', 'type' => 'string', 'example' => '0x67337874', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '字幕流起始时间，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'example' => '0.000000', ], 'Duration' => [ 'title' => 'Duration', 'description' => '字幕流持续时长，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'example' => '71.378', ], 'Bitrate' => [ 'title' => 'Bitrate', 'description' => '码率，单位为比特每秒（bit/s）。', 'type' => 'integer', 'format' => 'int64', 'example' => '74', ], 'Content' => [ 'title' => 'Content', 'description' => '字幕内容。', 'type' => 'string', 'example' => '欢迎', ], 'Width' => [ 'title' => 'Width', 'description' => '字幕的宽度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '600', ], 'Height' => [ 'title' => 'Height', 'description' => '字幕的高度，单位为像素（px）。', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], ], ], 'TargetAudio' => [ 'title' => 'Audio Struct', 'description' => '音频处理参数配置。', 'type' => 'object', 'properties' => [ 'DisableAudio' => [ 'title' => 'DisableAudio', 'description' => '是否禁用音频处理，取值范围如下：'."\n" ."\n" .'- true：禁用，输出文件中将不包含音频流。'."\n" .'- false（默认）：不禁用。', 'type' => 'boolean', 'example' => 'false', ], 'Stream' => [ 'title' => 'Stream', 'description' => '需要处理的源文件音频流索引号列表。空值（默认）表示处理索引号最小的音频流（第一路音频流），索引号大于100表示处理所有音频流。'."\n" ."\n" .'- 示例：`[0,1]`处理索引号为0和1的音频流；`[1]`处理索引号为1的音频流；`[101]`处理所有音频流。'."\n" ."\n" .'> 只处理索引号存在的音频流，索引号对应的音频流不存在时将忽略该索引号。', 'type' => 'array', 'items' => [ 'description' => '需要处理的音频流索引号。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], 'TranscodeAudio' => [ 'title' => 'TranscodeAudio', 'description' => '音频转码参数，空值表示禁用音频处理，输出文件中将不包含音频流。'."\n" ."\n" .'> 不推荐通过将该参数设为空值来禁用音频处理。', 'type' => 'object', 'properties' => [ 'Codec' => [ 'title' => 'Codec', 'description' => '音频编码方式。取值范围如下：'."\n" ."\n" .'- API为CreateMediaConvert时：copy（默认），mp3，vorbis，aac，flac，ac3，opus，amr。'."\n" .'- API为GenerateVideoPlaylist时：aac（默认）。'."\n" ."\n" .'> 当该参数为copy时，表示将需要处理的音频流直接拷贝到输出文件，此时**TranscodeAudio**下的其余参数无效。copy不可用于音频拼接，通常应用于转封装场景。', 'type' => 'string', 'example' => 'aac', ], 'BitrateOption' => [ 'title' => 'BitrateOption', 'description' => '音频码率选项。取值范围如下：'."\n" ."\n" .'- fixed：始终使用设置的目标音频码率。'."\n" .'- adaptive：源音频码率小于设置的目标音频码率时使用源音频码率。'."\n" .'- fall：源音频码率小于设置的目标音频码率时返回失败。'."\n" ."\n" .'默认值：'."\n" .'- API为CreateMediaConvert时，默认值为fixed。'."\n" .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" ."\n" .'> 该参数需要与参数**Bitrate**一同设置。', 'type' => 'string', 'example' => 'fixed', ], 'Bitrate' => [ 'title' => 'Bitrate', 'description' => '音频码率，与参数**Quality**互斥，单位为比特每秒（bps）。取值范围：1000~10000000。', 'type' => 'integer', 'format' => 'int32', 'example' => '64000', ], 'Quality' => [ 'title' => 'Quality', 'description' => '音频质量，与参数**Bitrate**互斥，取值范围：0～100（值越大质量越高）。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'SampleRateOption' => [ 'title' => 'SampleRateOption', 'description' => '音频采样率。取值范围如下：'."\n" ."\n" .'- fixed：始终使用设置的目标音频采样率。'."\n" .'- adaptive：源音频采样率小于设置的目标音频采样率时使用源音频采样率。'."\n" .'- fall：源音频采样率小于设置的目标音频采样率时返回失败。'."\n" ."\n" .'默认值：'."\n" .'- API为CreateMediaConvert时，默认值为fixed。'."\n" .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" ."\n" .'> 该参数需要与参数**SampleRate**一同设置。', 'type' => 'string', 'example' => 'fixed', ], 'SampleRate' => [ 'title' => 'SampleRate', 'description' => '音频采样率。单位为赫兹（Hz）。默认保持源音频的采样频率，取值范围：8000、12025、12000，16000、22050、24000，32000、44100、48000、64000、88200和96000。'."\n" ."\n" .'> 不同格式支持的采样率有所不同，mp3仅支持48kHz及以下；opus支持8kHz、12kHz、16kHz、24kHz与48kHz；ac3支持32kHz、44.1kHz与48kHz；amr仅支持8kHz与16kHz。', 'type' => 'integer', 'format' => 'int32', 'example' => '12050', ], 'Channel' => [ 'title' => 'Channel', 'description' => '声道数。默认保持源音频的声道数。取值范围：[1,8]。'."\n" ."\n" .'> 不同格式支持的声道数有所不同，mp3仅支持单、双声道；ac3最大支持6声道（5.1）；amr仅支持单声道。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'BitsPerSample' => [ 'title' => 'BitsPerSample', 'description' => '音频采样位深，取值为16或24。'."\n" .'>该参数仅在**Codec**为flac时有效。>', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], ], ], 'FilterAudio' => [ 'title' => 'FilterAudio', 'description' => '音频处理参数，参数**TranscodeAudio**为空时或**TranscodeAudio.Codec**为copy时，本参数无效。'."\n" ."\n" .'>API为GenerateVideoPlaylist时不支持设置此参数。', 'type' => 'object', 'properties' => [ 'Mixing' => [ 'title' => 'Mixing', 'description' => '是否将所有音轨混合为单轨。取值范围如下：'."\n" ."\n" .'- false（默认）：否。'."\n" ."\n" .'- true：是。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'TargetImage' => [ 'title' => 'Image Struct', 'description' => '截帧、雪碧图或动图目标图片信息。', 'type' => 'object', 'properties' => [ 'Sprites' => [ 'title' => 'Sprites', 'description' => '雪碧图处理列表。', 'type' => 'array', 'items' => [ 'description' => '雪碧图处理详细信息。', 'type' => 'object', 'properties' => [ 'ScaleType' => [ 'title' => 'ScaleType', 'description' => '缩放方式。取值范围如下：'."\n" ."\n" .'- stretch（默认）：拉伸以填满。'."\n" ."\n" .'- crop：缩放并裁剪。'."\n" ."\n" .'- fill：缩放并保留黑边。'."\n" ."\n" .'- fit：缩放并不保留黑边。', 'type' => 'string', 'example' => 'crop', ], 'Mode' => [ 'description' => '雪碧图子图截帧模式，取值范围如下：'."\n" .'- interval（默认）：固定时间间隔模式，截帧间隔由Interval参数决定。'."\n" .'- keyframe：关键帧模式，仅截取源视频中的IDR帧，此时Interval参数无效。'."\n" .'- average：平均模式，根据Number参数按均匀时间间隔截帧，此时Interval参数无效。'."\n" .'- dhash：dhash模式，根据Number参数设置，在固定时间间隔截帧的基础上截取视频帧内容变化超过Threshold参数的Top Number帧。'."\n" .' > 当Number参数为0时，则截取所有视频帧内容变化超过Threshold参数的帧。', 'type' => 'string', 'example' => 'interval', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '视频截帧的开始时间，单位为秒（s）。默认值为0，表示从视频起始时间开始。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], 'TileHeight' => [ 'title' => 'TileHeight', 'description' => '每列包含的图片数量，默认值为6。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'URI' => [ 'title' => 'URI', 'description' => '保存雪碧图的OSS地址。'."\n" ."\n" .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/sprites', ], 'ScaleWidth' => [ 'title' => 'ScaleWidth', 'description' => '单张图片的宽度，默认值为1，取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 整数：像素值，单位为像素（px），取值范围为(1,4096)。'."\n" ."\n" .'- 小数：表示相对输出视频分辨率宽度的比率，取值范围为(0,1]。', 'type' => 'number', 'format' => 'float', 'example' => '1280', ], 'Pad' => [ 'title' => 'Pad', 'description' => '小图之间的间隔，默认值为2。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Format' => [ 'title' => 'Format', 'description' => '雪碧图的格式。取值范围如下：'."\n" ."\n" .'- jpg'."\n" ."\n" .'- png', 'type' => 'string', 'required' => true, 'example' => 'jpg'."\n", ], 'Number' => [ 'title' => 'Number', 'description' => '小图数量。默认值为0，表示截取到视频结束位置。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ScaleHeight' => [ 'title' => 'ScaleHeight', 'description' => '单张图片的高度，默认值为1，取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 整数：像素值，单位为像素（px），取值范围为(1,4096)。'."\n" ."\n" .'- 小数：表示相对输出视频分辨率高度的比率，取值范围为(0,1]。', 'type' => 'number', 'format' => 'float', 'example' => '960', ], 'TileWidth' => [ 'title' => 'TileWidth', 'description' => '每行包含的图片数量，默认值为6。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'Interval' => [ 'title' => 'Interval', 'description' => '视频截帧的时间间隔，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', ], 'Margin' => [ 'title' => 'Margin', 'description' => '小图和雪碧图边缘的间隔，默认值为2。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Threshold' => [ 'description' => '截帧阈值，值越大截帧数量越少，取值范围为 0~100，默认值为 0。'."\n" .'> - 仅在使用dhash截帧模式时有效。'."\n" .'> - dhash模式对阈值较为敏感，推荐该参数设置不大于25，并根据具体场景调整。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], 'Animations' => [ 'title' => 'Animations', 'description' => '动图处理列表。', 'type' => 'array', 'items' => [ 'description' => '动图处理详细信息。', 'type' => 'object', 'properties' => [ 'FrameRate' => [ 'title' => 'FrameRate', 'description' => '动图帧率。可以配合Interval实现加减速。', 'type' => 'number', 'format' => 'double', 'example' => '25', ], 'Format' => [ 'title' => 'Format', 'description' => '输出动图格式。取值范围如下：'."\n" ."\n" .'- gif'."\n" .'- webp', 'type' => 'string', 'required' => true, 'example' => 'gif', ], 'Number' => [ 'title' => 'Number', 'description' => '抽帧数量。0表示到末尾，默认0。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'ScaleType' => [ 'title' => 'ScaleType', 'description' => '缩放方式。取值范围如下：'."\n" ."\n" .'- stretch（默认）：拉伸以填满。'."\n" ."\n" .'- crop：缩放并裁剪。'."\n" ."\n" .'- fill：缩放并保留黑边。'."\n" ."\n" .'- fit：缩放并不保留黑边。', 'type' => 'string', 'example' => 'crop', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '动图抽帧起始时间，单位秒。默认0。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], 'Height' => [ 'title' => 'Height', 'description' => '动图高度。默认保持原高度。取值为整数或小数时的不同含义如下：'."\n" ."\n\n" .'- 整数：代表像素值，单位为px，取值范围为[1,4096]。'."\n" .'- 小数：代表相对输出图片分辨率高度的比率，取值范围为(0,1)', 'type' => 'number', 'format' => 'double', 'example' => '960', ], 'URI' => [ 'title' => 'URI', 'description' => '保存动图的OSS地址。'."\n" ."\n" .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/animations', ], 'Width' => [ 'title' => 'Width', 'description' => '动图宽度。默认保持原宽度。取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 整数：代表像素值，单位为px，取值范围为[1,4096]。'."\n" .'- 小数：代表相对输出图片分辨率宽度的比率，取值范围为(0,1)', 'type' => 'number', 'format' => 'double', 'example' => '1280', ], 'Interval' => [ 'title' => 'Interval', 'description' => '抽帧间隔，单位为秒。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], ], ], ], 'Snapshots' => [ 'title' => 'Snapshots', 'description' => '截帧处理列表。', 'type' => 'array', 'items' => [ 'description' => '截帧处理详细信息。', 'type' => 'object', 'properties' => [ 'Format' => [ 'title' => 'Format', 'description' => '截帧的格式。取值范围如下：'."\n" ."\n" .'- jpg'."\n" ."\n" .'- png', 'type' => 'string', 'required' => true, 'example' => 'jpg', ], 'Number' => [ 'title' => 'Number', 'description' => '截帧数量。默认值为0，表示截取到视频结束位置。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'ScaleType' => [ 'title' => 'ScaleType', 'description' => '缩放方式。取值范围如下：'."\n" ."\n" .'- stretch（默认）：拉伸以填满。'."\n" ."\n" .'- crop：缩放并裁剪。'."\n" ."\n" .'- fill：缩放并保留黑边。'."\n" ."\n" .'- fit：缩放并不保留黑边。', 'type' => 'string', 'example' => 'crop', ], 'Mode' => [ 'description' => '雪碧图子图截帧模式，取值范围如下：'."\n" .'- interval（默认）：固定时间间隔模式，截帧间隔由Interval参数决定。'."\n" .'- keyframe：关键帧模式，只截取源视频中的IDR帧，此时Interval参数无效。'."\n" .'- average：平均模式，根据Number参数按均匀时间间隔截帧，此时Interval参数无效。'."\n" .'- dhash：dhash模式，根据Number参数设置，在固定时间间隔截帧的基础上截取视频帧内容变化超过Threshold参数的Top Number帧。'."\n" .' > 当Number参数为0时，则截取所有视频帧内容变化超过Threshold参数的帧。', 'type' => 'string', 'example' => 'interval', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '视频截帧的开始时间，单位为秒（s）。默认值为0，表示从视频起始时间开始。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], 'Height' => [ 'title' => 'Height', 'description' => '图片高度，默认保持源视频高度。取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" ."\n" .'- 小数：表示相对输出图片分辨率高度的比率，取值范围为(0,1)。', 'type' => 'number', 'format' => 'double', 'example' => '960', ], 'URI' => [ 'title' => 'URI', 'description' => '保存截帧的OSS地址。'."\n" ."\n" .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket/snapshots', ], 'Width' => [ 'title' => 'Width', 'description' => '图片宽度，默认保持源视频宽度。取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 整数：像素值，单位为像素（px），取值范围为[1,4096]。'."\n" ."\n" .'- 小数：表示相对输出图片分辨率宽度的比率，取值范围为(0,1)。', 'type' => 'number', 'format' => 'double', 'example' => '1280', ], 'Interval' => [ 'title' => 'Interval', 'description' => '视频截帧的时间间隔，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'Threshold' => [ 'description' => '截帧阈值，值越大截帧数量越少，取值范围为 0~100，默认值为 0。'."\n" .'> - 仅在使用dhash截帧模式时有效。'."\n" .'> - dhash模式对阈值较为敏感，推荐该参数设置不大于25，并根据具体场景调整。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], ], 'TargetSubtitle' => [ 'title' => 'Subtitle Struct', 'description' => '字幕处理参数配置。', 'type' => 'object', 'properties' => [ 'DisableSubtitle' => [ 'title' => 'DisableSubtitle', 'description' => '是否禁用字幕处理，取值范围如下：'."\n" ."\n" .'- true：禁用，输出文件中将不包含字幕。'."\n" .'- false（默认）：不禁用。'."\n" ."\n" .'> API为GenerateVideoPlaylist时，如果生成字幕，该字段为必现且必须填为false。', 'type' => 'boolean', 'example' => 'false', ], 'Stream' => [ 'title' => 'Stream', 'description' => '需要处理的源文件字幕流索引号列表。空值（默认）或者索引号大于100 表示处理所有字幕流。'."\n" ."\n" .'- 示例：`[0,1]`处理索引号为0和1的字幕流；`[1]`处理索引号为1的字幕流；`[101]`处理所有字幕流。'."\n" ."\n" .'> 只处理索引号存在的字幕流，索引号对应的字幕流不存在时将忽略该索引号。', 'type' => 'array', 'items' => [ 'description' => '需要转换的字幕流索引号。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], 'ExtractSubtitle' => [ 'title' => 'ExtractSubtitle', 'description' => '字幕提取配置。'."\n" .'> API为GenerateVideoPlaylist时，不支持该字段配置。', 'type' => 'object', 'properties' => [ 'URI' => [ 'title' => 'URI', 'description' => '保存提取字幕的OSS地址前缀。'."\n" .'地址规则为oss://bucket/object，其中bucket为和当前项目处于同一地域的OSS Bucket名称，object为包含文件扩展名的文件完整路径。'."\n" .'- 示例：URI为oss://examplebucket/outputSubtitle，则将产生多个OSS地址为oss://examplebucket/outputSubitile_${index}.${ext}文件，其中${ext}为字幕文件的拓展名，${index}为生成的从0开始编号的与源视频字幕流对应的字幕文件序号。', 'type' => 'string', 'example' => 'oss://test-bucket/extractsubtitle', ], 'Format' => [ 'title' => 'Format', 'description' => '字幕提取的输出格式。取值范围如下：'."\n" ."\n" .'- ass'."\n" .'- srt'."\n" .'- webvtt', 'type' => 'string', 'example' => 'webvtt', ], ], ], ], ], 'TargetVideo' => [ 'title' => 'Video Struct', 'description' => '视频处理参数配置。', 'type' => 'object', 'properties' => [ 'DisableVideo' => [ 'title' => 'DisableVideo', 'description' => '是否禁用视频流生成，取值范围如下：'."\n" ."\n" .'- true：禁用，输出文件中将不包含视频流。'."\n" .'- false（默认）：不禁用。', 'type' => 'boolean', 'example' => 'false', ], 'Stream' => [ 'title' => 'Stream', 'description' => '需要处理的源文件视频流索引号列表。空值（默认）表示处理索引号最小的视频流（第一路视频流），索引号大于100表示处理所有视频流。'."\n" ."\n" .'- 示例：`[0,1]`处理索引号为0和1的视频流；`[1]`处理索引号为1的视频流；`[101]`处理所有视频流。'."\n" ."\n" .'> 只处理索引号存在的视频流，索引号对应的视频流不存在时将忽略该索引号。', 'type' => 'array', 'items' => [ 'description' => '需要处理的视频流索引号。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], 'TranscodeVideo' => [ 'title' => 'TranscodeVideo', 'description' => '视频转码参数，空值表示禁用视频处理，输出文件中将不包含视频流。'."\n" ."\n" .'> 不推荐通过将该参数设为空值来禁用视频处理。', 'type' => 'object', 'properties' => [ 'Codec' => [ 'title' => 'Codec', 'description' => '视频编码格式。取值范围如下：'."\n" ."\n" .'- API为CreateMediaConvert时：copy（默认），h264，h265，vp9。'."\n" .'当该参数为copy时，表示将需要处理的视频流直接拷贝到输出文件，此时**TranscodeVideo**下的其余参数无效。copy不可用于视频拼接，通常应用于转封装场景。>'."\n" .'- API为GenerateVideoPlaylist时：h264（默认），h265。', 'type' => 'string', 'example' => 'h264', ], 'PixelFormat' => [ 'title' => 'PixelFormat', 'description' => '像素格式，默认与源视频一致。取值范围如下：'."\n" ."\n" .'- yuv420p'."\n" .'- yuv422p'."\n" .'- yuv444p'."\n" .'- yuv420p10le'."\n" .'- yuv422p10le'."\n" .'- yuv444p10le'."\n" .'- yuva420p'."\n" ."\n" .'> yuva420p仅在API为CreateMediaConvert时可用，且参数**Codec**必须为vp9。', 'type' => 'string', 'example' => 'yuv420p', ], 'FrameRateOption' => [ 'title' => 'FrameRateOption', 'description' => '帧率选项。取值范围如下：'."\n" ."\n" .'- fixed：始终使用设置的目标视频帧率。'."\n" .'- adaptive：源视频帧率小于设置的目标视频帧率时使用源视频帧率。'."\n" .'- fall：源视频帧率小于设置的目标视频帧率时返回失败。'."\n" ."\n" .'默认值：'."\n" .'- 当API为CreateMediaConvert时，默认值为fixed。'."\n" .'- 当API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" ."\n" .'> 该参数需要与参数**FrameRate**一同设置。', 'type' => 'string', 'example' => 'fixed', ], 'FrameRate' => [ 'title' => 'FrameRate', 'description' => '视频帧率，默认与源视频一致。', 'type' => 'number', 'format' => 'float', 'example' => '25', ], 'ResolutionOption' => [ 'title' => 'ResolutionOption', 'description' => '分辨率选项。取值范围如下：'."\n" ."\n" .'- fixed：始终使用设置的目标视频分辨率。'."\n" .'- adaptive：源视频分辨率面积小于设置的目标视频分辨率面积时使用源视频分辨率。'."\n" .'- fall：源视频分辨率面积小于设置的目标视频分辨率面积时返回失败。'."\n" ."\n" .'默认值：'."\n" .'- 当API为CreateMediaConvert时，默认值为fixed。'."\n" .'- 当API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" ."\n" .'> 该参数需要与参数**Resolution**一同设置。', 'type' => 'string', 'example' => 'fixed', ], 'Resolution' => [ 'title' => 'Resolution', 'description' => '输出视频的分辨率，格式为`宽x高`，默认与源视频播放分辨率一致。支持同时配置宽高或单独配置宽或高，也可配合参数**AdaptiveResolutionDirection**同时配置长短边或单独配置长边或短边，单边取值范围为（0,4096]。'."\n" ."\n" .'- 示例1：若**AdaptiveResolutionDirection**为false，`1280x720`表示设置宽为1280，高为720；`1280x`表示设置宽为1280，高与源视频一致；`x720`表示设置高为720，宽与源视频一致。'."\n" .'- 示例2：若**AdaptiveResolutionDirection**为true，`1280x720`表示设置长边为1280，短边为720；`1280x`表示设置长边为1280，短边与源视频一致；`x720`表示设置短边为720，长边与源视频一致。'."\n" ."\n" .'> 若源视频存在旋转信息，宽高、长短边的判断以旋转后的情况为准，即以播放分辨率为准。', 'type' => 'string', 'example' => '640x480', ], 'AdaptiveResolutionDirection' => [ 'title' => 'AdaptiveResolutionDirection', 'description' => '是否开启长短边自适应。取值范围如下：'."\n" ."\n" .'- true（默认）：是，此时参数**Resolution**的格式为`长边×短边`。'."\n" .'- false：否，此时参数**Resolution**的格式为`宽×高`。', 'type' => 'boolean', 'example' => 'true', ], 'ScaleType' => [ 'title' => 'ScaleType', 'description' => '缩放模式。取值范围如下：'."\n" ."\n" .'- stretch（默认）：固定宽高或长短边，强制缩放，拉伸以填满空白部分。'."\n" .'- crop：等比缩放，缩放为延伸出指定宽高或长短边的矩形框外的最小分辨率，然后将超出的部分进行居中裁剪。'."\n" .'- fill：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率，然后使用黑色居中填充空白部分。'."\n" .'- fit：等比缩放，缩放为指定宽高或长短边的矩形内的最大分辨率。'."\n" ."\n" .'> 该参数需要与参数**Resolution**一同设置。', 'type' => 'string', 'example' => 'crop', ], 'Rotation' => [ 'title' => 'Rotation', 'description' => '视频顺时针旋转的度数。取值范围如下：'."\n" ."\n" .'- 0（默认）'."\n" .'- 90'."\n" .'- 180'."\n" .'- 270', 'type' => 'integer', 'format' => 'int32', 'example' => '90', ], 'BitrateOption' => [ 'title' => 'BitrateOption', 'description' => '视频码率选项。取值范围如下：'."\n" ."\n" .'- fixed：始终使用设置的目标视频码率。'."\n" .'- adaptive：源视频码率小于设置的目标视频码率时使用源视频码率。'."\n" .'- fall：源视频码率小于设置的目标视频码率时返回失败。'."\n" ."\n" .'默认值：'."\n" .'- API为CreateMediaConvert时，默认值为fixed。'."\n" .'- API为GenerateVideoPlaylist时，默认值为adaptive。'."\n" ."\n" .'> 该参数需要与参数**Bitrate**一同设置。', 'type' => 'string', 'example' => 'fixed', ], 'Bitrate' => [ 'title' => 'Bitrate', 'description' => '视频流码率，单位为比特每秒（bit/s），'."\n" ."\n" .'> 该参数与**CRF**互斥，若该参数与参数**CRF**都为空值则按照参数**CRF**为23进行编码。', 'type' => 'integer', 'format' => 'int32', 'example' => '128000', ], 'GOPSize' => [ 'title' => 'GOPSize', 'description' => '关键帧间隔帧数，默认值为150。'."\n" ."\n" .'> API为GenerateVideoPlaylist 时不支持该参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'CRF' => [ 'title' => 'CRF', 'description' => '指定恒定质量模式。与参数**Bitrate**互斥，取值范围为[0,51]，数值越大画质越差，建议取值范围为[18,38]。', 'type' => 'number', 'format' => 'float', 'example' => '18', ], 'BufferSize' => [ 'title' => 'BufferSize', 'description' => '动态码率下解码缓存大小，单位为比特每秒（bps）。'."\n" ."\n" .'> 该参数需要与参数**CRF**一起使用才有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '4000000', ], 'MaxBitrate' => [ 'title' => 'MaxBitrate', 'description' => '动态码率下限定最大码率。使用该参数时，必须指定参数BufferSize。'."\n" ."\n" .'> 该参数需要与参数**CRF**一起使用才有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '128000', ], 'BFrames' => [ 'title' => 'BFrames', 'description' => '连续B帧的数量，默认值为3。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Refs' => [ 'title' => 'Refs', 'description' => '参考帧的数量，默认值为2。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VideoSlim' => [ 'description' => '启用轻码高清模式，设置值如下：'."\n" ."\n" .'0：默认值，表示关闭。'."\n" ."\n" .'1：表示使用轻码高清模式转码。'."\n" .'> 为获得最佳效果，轻码高清推荐使用官方推荐Bitrate或CRF参数进行视频转码编码。'."\n" .'>'."\n" .'>轻码高清仅支持h.264/h.265格式，仅支持yuv420p，8bit位深，不支持多路目标视频转码输出以及视频拼接。详情参考轻码高清产品介绍:[https://help.aliyun.com/zh/imm/user-guide/video-slim](url)', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'FilterVideo' => [ 'title' => 'FilterVideo', 'description' => '视频处理参数，参数**TranscodeVideo**为空时或**TranscodeVideo.Codec**为copy时，本参数无效。'."\n" ."\n" .'>API为GenerateVideoPlaylist时不支持设置此参数。', 'type' => 'object', 'properties' => [ 'Watermarks' => [ 'title' => 'Watermarks', 'description' => '视频水印列表。', 'type' => 'array', 'items' => [ 'description' => '视频水印信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => 'Type', 'description' => '水印类型。取值范围如下：'."\n" ."\n" .'- text（默认）：文字水印。'."\n" .'- file：图片或动图水印。', 'type' => 'string', 'example' => 'text', ], 'Dx' => [ 'title' => 'Dx', 'description' => '取值为整数或小数时不同含义如下：'."\n" ."\n" .'- 0（默认）：偏移像素和水平偏移量与输出分辨率高的比率都为0。'."\n" .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" .'- 小数：表示水平偏移量与输出分辨率高的比率，取值范围为(0,1)。', 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'Dy' => [ 'title' => 'Dy', 'description' => '取值为整数或小数时的不同含义如下：'."\n" ."\n" .'- 0（默认）：表示偏移像素和垂直偏移量与输出分辨率高的比率都为0。'."\n" ."\n" .'- 整数：表示偏移像素，单位为像素（px），取值范围为[1,4096]。'."\n" ."\n" .'- 小数：表示垂直偏移量与输出分辨率高的比率，取值范围为(0,1)。', 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '添加水印的开始时间，单位为秒（s），默认从视频起始时间开始。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], 'Duration' => [ 'title' => 'Duration', 'description' => '添加水印持续的时间，单位为秒（s），默认值持续到视频结束。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], 'ReferPos' => [ 'title' => 'ReferPos', 'description' => '添加水印的基准位置。取值范围如下：'."\n" ."\n" .'- topleft（默认）：左上角'."\n" .'- topright：右上角'."\n" .'- bottomright：右下角'."\n" .'- bottomleft：左下角', 'type' => 'string', 'example' => 'topleft', ], 'Content' => [ 'title' => 'Content', 'description' => '文字水印的内容，默认值为空。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'string', 'example' => 'example', ], 'FontName' => [ 'title' => 'FontName', 'description' => '文字水印的字体名称。取值范围如下：'."\n" ."\n" .'- SourceHanSans-Regular（默认）'."\n" .'- SourceHanSans-Bold'."\n" .'- SourceHanSerif-Regular'."\n" .'- SourceHanSerif-Bold'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'string', 'example' => 'SourceHanSans-Bold', ], 'FontSize' => [ 'title' => 'FontSize', 'description' => '文字水印的字体大小，默认值为16。取值为整数，取值范围为(4,120)。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'integer', 'format' => 'int32', 'example' => '18', ], 'FontColor' => [ 'title' => 'FontColor', 'description' => '水印文字的字体颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'string', 'example' => 'red', ], 'FontApha' => [ 'title' => 'FontApha', 'description' => '文字水印的字体透明度。取值范围为(0,1]，默认值为1，表示完全不透明。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'number', 'format' => 'float', 'example' => '0.8', ], 'BorderWidth' => [ 'title' => 'BorderWidth', 'description' => '文字水印的描边宽度，单位为像素（px）。取值只能为整数，取值范围为[0,4096]，默认值为0。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'BorderColor' => [ 'title' => 'BorderColor', 'description' => '水印文字的描边颜色。格式为#RRGGBB，默认值为#000000。也支持输入“red”、"green"等值。'."\n" ."\n" .'> 当参数`Type`取值为`text`时此参数生效。>', 'type' => 'string', 'example' => 'red', ], 'URI' => [ 'title' => 'URI', 'description' => '水印文件的OSS地址，支持的格式为PNG和MOV。'."\n" ."\n" .'OSS地址规则为`oss:///