summaryrefslogtreecommitdiff
path: root/data/en_us/quanmiaolightapp
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/quanmiaolightapp
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/quanmiaolightapp')
-rw-r--r--data/en_us/quanmiaolightapp/2024-08-01/api-docs.php15445
1 files changed, 6878 insertions, 8567 deletions
diff --git a/data/en_us/quanmiaolightapp/2024-08-01/api-docs.php b/data/en_us/quanmiaolightapp/2024-08-01/api-docs.php
index 3237e0c..3522457 100644
--- a/data/en_us/quanmiaolightapp/2024-08-01/api-docs.php
+++ b/data/en_us/quanmiaolightapp/2024-08-01/api-docs.php
@@ -1,554 +1,207 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'QuanMiaoLightApp',
- 'version' => '2024-08-01',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'QuanMiaoLightApp', 'version' => '2024-08-01'],
'directories' => [
[
- 'id' => 197181,
- 'title' => null,
+ 'children' => ['RunMarketingInformationWriting', 'RunMarketingInformationExtract'],
'type' => 'directory',
- 'children' => [
- 'RunMarketingInformationWriting',
- 'RunMarketingInformationExtract',
- ],
+ 'title' => 'E-commerce and retail promotional copywriting',
],
[
- 'id' => 197183,
- 'title' => null,
+ 'children' => ['RunStyleWriting'],
'type' => 'directory',
- 'children' => [
- 'RunStyleWriting',
- ],
+ 'title' => 'Media and retail article style and format learning',
],
[
- 'id' => 197180,
- 'title' => null,
+ 'children' => ['RunScriptRefine', 'RunScriptChat', 'RunScriptPlanning', 'RunScriptContinue'],
'type' => 'directory',
- 'children' => [
- 'RunScriptRefine',
- 'RunScriptChat',
- 'RunScriptPlanning',
- 'RunScriptContinue',
- ],
+ 'title' => 'Film and entertainment scriptwriting',
],
[
- 'id' => 197182,
- 'title' => null,
+ 'children' => ['SubmitVideoAnalysisTask', 'GetVideoAnalysisTask', 'UpdateVideoAnalysisConfig', 'GetVideoAnalysisConfig', 'RunVideoAnalysis', 'UpdateVideoAnalysisTask', 'UpdateVideoAnalysisTasks'],
'type' => 'directory',
- 'children' => [
- 'SubmitVideoAnalysisTask',
- 'GetVideoAnalysisTask',
- 'UpdateVideoAnalysisTask',
- 'UpdateVideoAnalysisTasks',
- 'UpdateVideoAnalysisConfig',
- 'GetVideoAnalysisConfig',
- 'RunVideoAnalysis',
- ],
+ 'title' => 'Film and media video understanding',
],
[
- 'id' => 302549,
- 'title' => null,
+ 'children' => ['SubmitVideoDetectShotTask', 'GetVideoDetectShotTask', 'UpdateVideoDetectShotTask', 'UpdateVideoDetectShotConfig', 'GetVideoDetectShotConfig', 'RunVideoDetectShot'],
'type' => 'directory',
- 'children' => [
- 'SubmitVideoDetectShotTask',
- 'GetVideoDetectShotTask',
- 'UpdateVideoDetectShotTask',
- 'UpdateVideoDetectShotConfig',
- 'GetVideoDetectShotConfig',
- 'RunVideoDetectShot',
- ],
+ 'title' => 'Film and media intelligent video splitting',
],
[
- 'id' => 197184,
- 'title' => null,
+ 'children' => ['RunHotTopicChat', 'RunHotTopicSummary'],
'type' => 'directory',
- 'children' => [
- 'RunHotTopicChat',
- 'RunHotTopicSummary',
- ],
+ 'title' => 'In-vehicle network hotspot interactive Q&A',
],
[
- 'id' => 204667,
- 'title' => null,
+ 'children' => ['RunEnterpriseVocAnalysis'],
'type' => 'directory',
- 'children' => [
- 'RunEnterpriseVocAnalysis',
- 'SubmitEnterpriseVocAnalysisTask',
- 'GetEnterpriseVocAnalysisTask',
- 'ExportAnalysisTagDetailByTaskId',
- 'ListAnalysisTagDetailByTaskId',
- ],
+ 'title' => 'Enterprise VOC mining',
],
[
- 'id' => 201588,
- 'title' => null,
+ 'children' => ['GenerateOutputFormat', 'RunTagMiningAnalysis'],
'type' => 'directory',
- 'children' => [
- 'GenerateOutputFormat',
- 'RunTagMiningAnalysis',
- ],
+ 'title' => 'Enterprise lead mining',
],
[
- 'id' => 201577,
- 'title' => null,
+ 'children' => ['RunNetworkContentAudit'],
'type' => 'directory',
- 'children' => [
- 'RunNetworkContentAudit',
- ],
+ 'title' => 'Online content safety moderation',
],
[
- 'id' => 222910,
- 'title' => null,
+ 'children' => ['RunEssayCorrection', 'RunOcrParse', 'SubmitEssayCorrectionTask', 'GetEssayCorrectionTask'],
'type' => 'directory',
- 'children' => [
- 'RunEssayCorrection',
- 'RunOcrParse',
- 'SubmitEssayCorrectionTask',
- 'GetEssayCorrectionTask',
- ],
+ 'title' => 'Essay grading',
],
[
- 'id' => 203451,
- 'title' => null,
+ 'children' => ['GenerateBroadcastNews', 'SubmitTagMiningAnalysisTask', 'ListHotTopicSummaries', 'GetTagMiningAnalysisTask', 'HotNewsRecommend', 'GetFileContent', 'BatchCancelTasks', 'BatchQueryTaskStatus', 'CancelAsyncTask', 'ExportAnalysisTagDetailByTaskId', 'GetEnterpriseVocAnalysisTask', 'GetTaskExecutionStatistics', 'ListAnalysisTagDetailByTaskId', 'SubmitEnterpriseVocAnalysisTask'],
'type' => 'directory',
- 'children' => [
- 'GenerateBroadcastNews',
- 'SubmitTagMiningAnalysisTask',
- 'ListHotTopicSummaries',
- 'GetTagMiningAnalysisTask',
- 'CancelAsyncTask',
- 'HotNewsRecommend',
- 'GetFileContent',
- ],
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [
'ModelUsage' => [
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Model usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '951',
- 'backendName' => 'inputTokens',
- ],
- 'outputTokens' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- 'backendName' => 'outputTokens',
- ],
- 'totalTokens' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '964',
- 'backendName' => 'totalTokens',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens for the model ', 'title' => '模型输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '951'],
+ 'outputTokens' => ['description' => 'Number of output tokens for the model ', 'title' => '模型输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'totalTokens' => ['description' => 'Total token data ', 'title' => '总token数据', 'type' => 'integer', 'format' => 'int64', 'example' => '964'],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'apis' => [
- 'RunMarketingInformationWriting' => [
- 'summary' => '营销文案写作服务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationWriting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'BatchCancelTasks' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/batchCancelTasks',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREsfmJIZ0TW',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-26ca1703f6d71e6e',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max'."\n"
- .'qwen-plus',
- ],
- ],
- [
- 'name' => 'writingType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'generateProductTitle',
- ],
- ],
- [
- 'name' => 'customPrompt',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请根据商品特点生成吸引人的标题',
- ],
- ],
- [
- 'name' => 'sourceMaterial',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '时尚休闲运动鞋',
- ],
- ],
- [
- 'name' => 'customLimitation',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'example' => '标题长度不超过30个字符',
- ],
- ],
- [
- 'name' => 'inputExample',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'example' => '商品特点:透气、减震、舒适',
- ],
- ],
- [
- 'name' => 'outputExample',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'example' => '透气减震运动鞋,舒适跑步首选',
- ],
- ],
- [
- 'name' => 'language',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '目标语言(用于商品标题翻译)',
- 'type' => 'string',
- 'example' => 'en',
- ],
- ],
- [
- 'name' => 'keywords',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '关键词(用于生成商品标题和商品摘要)',
- 'type' => 'string',
- 'example' => '运动鞋 透气 减震 跑步',
- ],
- ],
- [
- 'name' => 'generateCount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '生成数量(用于生成商品标题和商品摘要,取值范围:1-15)',
- 'type' => 'string',
- 'example' => '5',
- ],
- ],
- [
- 'name' => 'wordCountRange',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '字数范围(用于商品标题翻译,格式:最小字数-最大字数)',
- 'type' => 'string',
- 'example' => '10-20',
- ],
- ],
- [
- 'name' => 'otherRequirements',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '其他要求(用于三种新的写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'type' => 'string',
- 'example' => '要求标题简洁有力,突出产品特点',
- ],
+ 'schema' => ['description' => 'The unique identifier for the Model Studio workspace. For more information, see [How to obtain a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''],
],
[
- 'name' => 'prompt',
+ 'name' => 'taskCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义提示词(用于可控式生成模型,适用写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'type' => 'string',
- 'example' => '请根据关键词生成吸引人的商品标题',
- ],
+ 'schema' => ['description' => 'The identifier for the task type.', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask', 'title' => ''],
],
[
- 'name' => 'extParameters',
+ 'name' => 'taskIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展参数(Map结构,包含 minWordLength、maxWordLength、enableThinking、thinkingBudget 等参数,所有参数值均为 String 类型)',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => '参数KEY',
- 'type' => 'string',
- ],
- 'example' => '{'."\n"
- .' "minWordLength": "10",'."\n"
- .' "maxWordLength": "50",'."\n"
- .' "enableThinking": "true",'."\n"
- .' "thinkingBudget": "2000"'."\n"
- .' }',
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => 'The unique ID of a task to be canceled.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'],
+ 'example' => '["xxxx1","xxxx2"]',
+ 'title' => '',
+ 'description' => 'A list of task IDs. You can specify up to 10,000 IDs.',
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => '2024-06-21T10:29:52+08:00',
- ],
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'requestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '436BC5AE-0573-59D8-9803-6B5FDCD3BBA1',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13312125943232',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '213e20e517049392478441155e8b2a',
- ],
- 'errorMessage' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST', 'title' => ''],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'The error message if the request fails.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'data' => [
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'reasonContent' => [
- 'title' => '模型推理内容',
- 'type' => 'string',
- 'example' => '推理内容',
- ],
- ],
- ],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'results' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the individual task was successfully canceled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message for a failed task cancellation.', 'type' => 'string', 'example' => '错误信息(取消失败时)', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The cancellation result for a single task.',
+ 'example' => '',
],
+ 'title' => '',
+ 'description' => 'A list of the cancellation results.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The result object.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"requestId\\": \\"436BC5AE-0573-59D8-9803-6B5FDCD3BBA1\\",\\n \\"sessionId\\": \\"uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd\\",\\n \\"taskId\\": \\"13312125943232\\",\\n \\"traceId\\": \\"213e20e517049392478441155e8b2a\\",\\n \\"errorMessage\\": \\"错误消息\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"playstation5新时代的...\\",\\n \\"reasonContent\\": \\"推理内容\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'BatchCancelTasks',
+ 'summary' => 'Cancels multiple tasks.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST\\",\\n \\"code\\": \\"Success\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"成功\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"results\\": [\\n {\\n \\"taskId\\": \\"xxxx\\",\\n \\"success\\": true,\\n \\"errorMessage\\": \\"错误信息(取消失败时)\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'RunMarketingInformationExtract' => [
- 'summary' => '营销信息抽取服务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationExtract',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'BatchQueryTaskStatus' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/batchQueryTaskStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-08a4a3ba7104917c',
- ],
+ 'schema' => ['description' => 'The ID of the Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''],
],
[
- 'name' => 'modelId',
+ 'name' => 'taskCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max'."\n"
- .'qwen-plus',
- ],
+ 'schema' => ['description' => 'The identifier for the task type.', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask', 'title' => ''],
],
[
- 'name' => 'extractType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'customPrompt',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'sourceMaterials',
+ 'name' => 'taskIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'items' => ['description' => 'A task ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'],
+ 'example' => '["xxxx1","xxxx2"]',
+ 'title' => '',
+ 'description' => 'A list of task IDs. You can specify a maximum of 100 IDs.',
'required' => false,
],
],
@@ -556,220 +209,167 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => '{\'TimeZone\': \'Asia/Shanghai\', \'DateTime\': \'2024-03-07T17:00:09+08:00\'}',
- ],
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'requestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F08C71C0-9399-548C-838B-1DA01DE211B0',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12826092918145',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST', 'title' => ''],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success, and false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'data' => [
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'taskStatusList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'status' => ['description' => 'The task status. Valid values: PENDING (awaiting execution), RUNNING (in progress), SUCCEEDED (completed successfully), FAILED (failed), CANCELED (canceled), and NOT\\_FOUND (not found).', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message. This parameter is returned only if the task status is FAILED.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'An object that contains the status of a task.',
+ 'example' => '',
],
+ 'title' => '',
+ 'description' => 'The list of task statuses.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The result object.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response object.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"requestId\\": \\"F08C71C0-9399-548C-838B-1DA01DE211B0\\",\\n \\"sessionId\\": \\"121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2\\",\\n \\"taskId\\": \\"12826092918145\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"playstation 5新一代的...\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'BatchQueryTaskStatus',
+ 'summary' => 'Queries the statuses of multiple tasks.',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST\\",\\n \\"code\\": \\"Success\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"成功\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"taskStatusList\\": [\\n {\\n \\"taskId\\": \\"xxxx\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"errorMessage\\": \\"错误信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'RunStyleWriting' => [
- 'summary' => '文体学习和写作推理服务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runStyleWriting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'CancelAsyncTask' => [
+ 'summary' => 'Cancels an asynchronous task.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/cancelAsyncTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9xb8mx',
- ],
+ 'schema' => ['description' => 'The ID of the [Alibaba Cloud Model Studio workspace](~~2782167~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-xxxxxxx'],
],
[
- 'name' => 'learningSamples',
+ 'name' => 'taskId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '需要作为学习样本的文章集合',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response schema.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'NoPermission'],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '无权限访问接口'],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '403'],
+ 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'data' => ['description' => 'Indicates whether the task was successfully canceled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
- 'required' => false,
'example' => '',
- 'maxItems' => 10,
- 'minItems' => 1,
],
],
- [
- 'name' => 'writingTheme',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户输入的写作主题,可以对主题进行自定义调整效果',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'maxLength' => 2000,
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"message\\": \\"无权限访问接口\\",\\n \\"httpStatusCode\\": 403,\\n \\"success\\": false,\\n \\"data\\": true\\n}","type":"json"}]',
+ 'title' => 'Cancel the execution of an asynchronous task by task ID ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ExportAnalysisTagDetailByTaskId' => [
+ 'summary' => 'Exports mining task details.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/exportAnalysisTagDetailByTaskId',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'styleFeature',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文体特征标识符。如果指定了此参数,接口会按照指定的文体特征进行写作',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'maxLength' => 1000,
- ],
+ 'AK' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'referenceMaterials',
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-xxxxxxxx'],
+ ],
+ [
+ 'name' => 'taskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '大模型生成功能的内容素材模型集合',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
- 'name' => 'processStage',
+ 'name' => 'category',
'in' => 'formData',
- 'schema' => [
- 'title' => ' * 代表处理阶段'."\n"
- .' * "full": 生成特点分析和创作内容'."\n"
- .' * "analysisStage": 仅生成特点分析'."\n"
- .' * "creationStage": 仅生成创作内容',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Classification filter', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '标签分类'],
],
[
- 'name' => 'useSearch',
+ 'name' => 'categories',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否自动检索互联网补充素材',
- 'type' => 'boolean',
+ 'title' => '',
+ 'description' => 'Multiclass classification filter',
+ 'type' => 'array',
+ 'items' => ['description' => 'Tag categorization', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '标签分类列表'],
+ 'required' => false,
+ 'example' => '',
],
],
],
@@ -777,422 +377,229 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '异常错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'errorMessage' => [
- 'title' => '异常错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check log.',
- ],
- 'event' => [
- 'title' => '事件类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-progress-start-generating',
- ],
- 'eventInfo' => [
- 'title' => '事件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- 'example' => '{"event":"task-progress-start-generating","sessionId":"3cd10828-0e42-471c-8f1a-931cde20b035","taskId":"d3be9981-ca2d-4e17-bf31-1c0a628e9f99","traceId":"66bef4a7f5d61ff3c43f3b710574e175"}',
- ],
- 'payload' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出内容对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- 'example' => '',
- ],
- 'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- 'example' => '{'."\n"
- .' "inputTokens": 1816,'."\n"
- .' "outputTokens": 96,'."\n"
- .' "totalTokens": 1912'."\n"
- .' }',
- ],
- ],
- 'example' => '',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'data' => ['description' => 'URL (temporary public-network download URL, expires in one hour)', 'type' => 'string', 'title' => '', 'example' => 'http://www.example.com/xxxx.xlsx'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": \\"http://www.example.com/xxxx.xlsx\\"\\n}","type":"json"}]',
+ 'title' => 'Export analysis details by job ID ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-progress-start-generating\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
],
- 'RunScriptRefine' => [
- 'summary' => '剧本对话内容的整理',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptRefine',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'GenerateBroadcastNews' => [
+ 'summary' => 'Alibaba Cloud Model Studio lightweight app — Enables in-vehicle systems and content platforms to interact with news hotlists. Recommends a single trending topic for broadcast by understanding user intent and retrieving the hot topics list for the corresponding channel.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/GenerateBroadcastNews',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-zna577pdximvztk5',
- ],
+ 'schema' => ['description' => '[Unique identifier of the workspace](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
],
[
- 'name' => 'taskId',
+ 'name' => 'prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,相同的任务ID,表示一组任务对话',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- 'maxLength' => 1000,
- ],
+ 'schema' => ['description' => 'User intent', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '帮我播报体育热点'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '',
- 'type' => 'boolean',
- ],
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '异常错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'errorMessage' => [
- 'title' => '异常错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check log.',
- ],
- 'event' => [
- 'title' => '事件类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'title' => '事件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '14356391-6c6c-40d5-b80a-8ecd03b69d72',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'data' => [
+ 'description' => 'Categorization and hot topic data',
'type' => 'object',
'properties' => [
- 'output' => [
- 'title' => '输出内容对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'scene' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'summary' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'outline' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'content' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
+ 'hotTopicSummaries' => [
+ 'description' => 'List of hot topic data',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Hot topic data',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'Hot topic category', 'type' => 'string', 'example' => '体育', 'title' => ''],
+ 'hotTopic' => ['description' => 'Hot topic name', 'type' => 'string', 'example' => '热点', 'title' => ''],
+ 'hotTopicVersion' => ['description' => 'Hot topic version', 'type' => 'string', 'example' => '2024-09-13_08', 'title' => ''],
+ 'hotValue' => ['description' => 'Hotness score', 'type' => 'number', 'format' => 'double', 'example' => '1000000', 'title' => ''],
+ 'id' => ['description' => 'Hot topic ID', 'type' => 'string', 'example' => '1458tb3bjo7531kap42a', 'title' => ''],
+ 'images' => [
+ 'description' => 'List of related images',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Related image',
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['description' => 'Image URL', 'type' => 'string', 'example' => 'http://xxx.com/xxx.jpeg', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
- 'description' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'textSummary' => ['description' => 'Text summarization of the hot topic', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'sessionId' => ['description' => 'Conversation ID', 'type' => 'string', 'example' => '2bb0ea82dafd48a8817fadc4c90e2b52', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300', 'title' => ''],
+ 'text' => ['description' => 'Parsed result', 'type' => 'string', 'example' => '体育', 'title' => ''],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '',
+ 'description' => 'Token usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'success' => ['description' => 'Operation status: true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"xx\\",\\n \\"data\\": {\\n \\"hotTopicSummaries\\": [\\n {\\n \\"category\\": \\"体育\\",\\n \\"hotTopic\\": \\"热点\\",\\n \\"hotTopicVersion\\": \\"2024-09-13_08\\",\\n \\"hotValue\\": 1000000,\\n \\"id\\": \\"1458tb3bjo7531kap42a\\",\\n \\"images\\": [\\n {\\n \\"url\\": \\"http://xxx.com/xxx.jpeg\\"\\n }\\n ],\\n \\"textSummary\\": \\"xxx\\"\\n }\\n ],\\n \\"sessionId\\": \\"2bb0ea82dafd48a8817fadc4c90e2b52\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"text\\": \\"体育\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 2,\\n \\"totalTokens\\": 3\\n }\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true\\n}","type":"json"}]',
+ 'title' => 'Hotspot Recommendation for Broadcast List (Trending Rankings) ',
+ 'description' => 'This API understands user intent and retrieves the hot topics list for the corresponding channel. For example, if the user says “Broadcast sports news,” the API returns relevant trending sports topics. This is a legacy API. You should use the RunHotTopicChat API instead because it fully replaces this API’s functionality.'."\n"
+ ."\n"
+ .'Try it in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).'."\n"
+ ."\n"
+ .'To call this API using an SDK, see the Java and Python examples under “API” in the console.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateBroadcastNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"F8A35034-EDCF-5C50-95A5-1044316F36E3\\",\\n \\"sessionId\\": \\"17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824\\",\\n \\"taskId\\": \\"14356391-6c6c-40d5-b80a-8ecd03b69d72\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xx\\",\\n \\"role\\": \\"用户角色信息\\",\\n \\"scene\\": \\"保留字段,暂无赋值\\",\\n \\"summary\\": \\"在充满机遇与挑战的大都市,平凡女孩林苏怀揣梦想却处处碰壁。一次偶然的机会\\",\\n \\"outline\\": \\"在繁华都市的夜晚,林苏因面试失败心情低落时意外撞上了沈逸\\",\\n \\"content\\": [\\n {\\n \\"key\\": \\"{\\\\\\"第一幕\\\\\\":\\\\\\" 幕次: 第一幕\\\\\\\\n\\\\\\\\n 场面描述\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
],
- 'RunScriptChat' => [
- 'summary' => '长剧本创作',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptChat',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'GenerateOutputFormat' => [
+ 'summary' => 'Generates a sample output format for Tag Mining in LightApp.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/generateOutputFormat',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-rz8db8d00rcn2p0xc',
- ],
+ 'schema' => ['description' => 'Unique identifier of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxxxx', 'title' => ''],
],
[
- 'name' => 'prompt',
+ 'name' => 'businessType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Business type.', 'type' => 'string', 'example' => 'clueMining', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Task description.', 'type' => 'string', 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'content',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Text to be analyzed.', 'type' => 'string', 'example' => '待分析文本', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'tags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '用户输入的剧本指令',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Tag System List.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Tag System object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'tagDefinePrompt' => ['description' => 'Tag definition prompt.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
'example' => '',
- 'maxLength' => 9000,
],
],
[
- 'name' => 'taskId',
+ 'name' => 'extraInfo',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,相同的任务ID,表示一组任务对话',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- 'maxLength' => 1000,
- ],
+ 'schema' => ['description' => 'Extra information.', 'type' => 'string', 'example' => '额外信息', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -1202,1070 +609,643 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '异常错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'errorMessage' => [
- 'title' => '异常错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check log.',
- ],
- 'event' => [
- 'title' => '事件类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'title' => '事件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '147648697127_914847410985_1730600302167',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
+ 'code' => ['description' => 'Status code.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'Example format object.',
'type' => 'object',
'properties' => [
- 'output' => [
- 'title' => '输出内容对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- 'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
+ 'outputFormat' => ['description' => 'Output format.', 'type' => 'string', 'title' => '', 'example' => '请直接以如下JSON格式输出,不要输出其他内容:'."\n"
+ .'{'."\n"
+ .' "是否近期买房": "",'."\n"
+ .' "购房付款方式": "",'."\n"
+ .' "家庭人口数量": "",'."\n"
+ .' "房间数量需求": "",'."\n"
+ .' "买房投资诉求": "",'."\n"
+ .' "客户买房类型": "",'."\n"
+ .' "客户买房预算": "",'."\n"
+ .' "客户居住地": "",'."\n"
+ .' "用户核心需求": ['."\n"
+ .' ""'."\n"
+ .' ],'."\n"
+ .' "年龄": "",'."\n"
+ .' "性别": "",'."\n"
+ .' "职业":""'."\n"
+ .'}'."\n"],
],
+ 'example' => '',
],
+ 'httpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
+ 'message' => ['description' => 'Error description.', 'type' => 'string', 'title' => '', 'example' => 'ok'],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'success' => ['description' => 'Is successful: true for success, false for failure.', 'type' => 'boolean', 'title' => '', 'example' => 'True'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"successful\\",\\n \\"data\\": {\\n \\"outputFormat\\": \\"请直接以如下JSON格式输出,不要输出其他内容:\\\\n{\\\\n \\\\\\"是否近期买房\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"购房付款方式\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"家庭人口数量\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"房间数量需求\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"买房投资诉求\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户买房类型\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户买房预算\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户居住地\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"用户核心需求\\\\\\": [\\\\n \\\\\\"\\\\\\"\\\\n ],\\\\n \\\\\\"年龄\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"性别\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"职业\\\\\\":\\\\\\"\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true\\n}","type":"json"}]',
+ 'title' => 'Obtain Sample Output Format',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateOutputFormat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件描述\\",\\n \\"requestId\\": \\"F8A35034-EDCF-5C50-95A5-1044316F36E3\\",\\n \\"sessionId\\": \\"147648697127_914847410985_1730600302167\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"以下是角色信息\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
],
- 'RunScriptPlanning' => [
- 'summary' => '剧本策划',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptPlanning',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'GetEnterpriseVocAnalysisTask' => [
+ 'summary' => 'Retrieves the task result of an enterprise VOC analysis node.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getEnterpriseVocAnalysisTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-e9zzbkg0aj2mlXX',
- ],
+ 'schema' => ['description' => 'The unique identifier of the Bailian business workspace. For more information, see [Obtain workspaceId](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx', 'title' => ''],
],
[
- 'name' => 'scriptName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '自然语言输入剧本名称'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '都市战神',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptTypeKeyword',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '现代,都市,爱情,玄幻',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptSummary',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '在一个宁静的小镇上,每个家庭都在同一天收到一个神秘的、没有标记的包裹。',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptShotCount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的分镜数量:单个剧本内用户可以定义生成对应的镜头描述数量【1-10个】',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10',
- 'minimum' => '1',
- 'example' => '3',
- 'default' => '3',
- ],
- ],
- [
- 'name' => 'dialogueInScene',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否需要具体分镜对白,default=false',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'plotConflict',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '可读性:用户可以勾选是否增加剧情冲突、反转情节的策划内容,勾选后可自动生成在剧情中',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'true',
- ],
- ],
- [
- 'name' => 'additionalNote',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '其他补充:用户可以在文本输入框中,通过自然语言的描述进行开放性调整,例如增加紧张刺激时刻的描述等等,帮助用户进行效果调整',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '故事尽可能狗血',
- 'maxLength' => 5000,
- ],
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'title' => '输出是否完成,true 表示完成',
- 'description' => '',
- 'type' => 'boolean',
- ],
- 'header' => [
- 'title' => '流式输出 header 头,包含返回通用信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '异常错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'errorMessage' => [
- 'title' => '异常错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check.',
- ],
- 'event' => [
- 'title' => '事件类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'title' => '事件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '',
+ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['title' => '', 'description' => '错误码', 'type' => 'string', 'example' => 'NoPermission'],
+ 'httpStatusCode' => ['title' => '', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '403'],
+ 'message' => ['title' => '', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => '无权限访问接口'],
+ 'success' => ['title' => '', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'false'],
+ 'data' => [
+ 'title' => '',
+ 'description' => '结果对象',
'type' => 'object',
'properties' => [
- 'output' => [
- 'title' => '输出内容对象',
- 'description' => '',
+ 'status' => ['title' => '', 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'type' => 'string', 'example' => 'PENDING'],
+ 'errorMessage' => ['title' => '', 'description' => '错误信息', 'type' => 'string', 'example' => '任务错误消息'."\n"
+ ."\n"],
+ 'usage' => [
+ 'title' => '',
+ 'description' => '消耗量统计',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => '这是测试输出',
- ],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'inputTokens' => ['description' => '输入token量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'example' => '',
],
- 'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '',
+ 'statisticsOverview' => [
+ 'title' => '',
+ 'description' => '统计概览',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
+ 'count' => ['title' => '', 'description' => '总分析数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '17'],
+ 'tagDimensionStatistics' => [
+ 'title' => '',
+ 'description' => '标签统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagValueCountStatistic' => [
+ 'title' => '',
+ 'description' => '标签值数量统计',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => '标签值数量统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['title' => '', 'description' => '标签名称', 'type' => 'string', 'example' => '标签名称'],
+ 'valueCount' => ['title' => '', 'description' => '标签值数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'."\n"],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'filterDimensionStatistics' => [
+ 'title' => '',
+ 'description' => '筛选标签统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagValueCountStatistic' => [
+ 'title' => '',
+ 'description' => '标签值数量统计',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => '标签值数量统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['title' => '', 'description' => '标签名称', 'type' => 'string', 'example' => '标签名称'."\n"],
+ 'valueCount' => ['title' => '', 'description' => '标签值数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
+ 'modelId' => ['title' => '', 'description' => '此次使用的模型ID', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelName' => ['title' => '', 'description' => '此次使用的模型名称', 'type' => 'string', 'example' => '通义千问-MAX'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"httpStatusCode\\": 403,\\n \\"message\\": \\"无权限访问接口\\",\\n \\"success\\": false,\\n \\"data\\": {\\n \\"status\\": \\"PENDING\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\",\\n \\"usage\\": {\\n \\"outputTokens\\": 2,\\n \\"inputTokens\\": 1\\n },\\n \\"statisticsOverview\\": {\\n \\"count\\": 17,\\n \\"tagDimensionStatistics\\": {\\n \\"tagValueCountStatistic\\": [\\n {\\n \\"tagName\\": \\"标签名称\\",\\n \\"valueCount\\": 10\\n }\\n ]\\n },\\n \\"filterDimensionStatistics\\": {\\n \\"tagValueCountStatistic\\": [\\n {\\n \\"tagName\\": \\"标签名称\\\\n\\",\\n \\"valueCount\\": 10\\n }\\n ]\\n }\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelName\\": \\"通义千问-MAX\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve enterprise VOC analysis task results',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
],
- 'RunScriptContinue' => [
- 'summary' => '剧本续写',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptContinue',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'GetEssayCorrectionTask' => [
+ 'summary' => 'Getting essay grading results',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getEssayCorrectionTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-e9zzbkg0aj2mlXX',
- ],
- ],
- [
- 'name' => 'scriptTypeKeyword',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '悬疑,都市,惊悚',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptSummary',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一队全副武装的执法人员和消防员闯入了一间明显已被遗弃多日、门窗紧闭并用胶带封死的公寓,面对着屋内令人作呕的恶臭和门厅里的混乱场面,他们似乎在寻找某种隐藏的真相或危险源,而一封日期为16号的信件成为了揭开谜团的关键线索,随着便衣探员深入探索,一系列封闭的房间暗示着这里曾发生过不为人知的秘密事件。',
- 'maxLength' => 5000,
- ],
+ 'schema' => ['description' => '[The Model Studio workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx', 'title' => ''],
],
[
- 'name' => 'userProvidedContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '上文补充描述:用户针对某一段小说内容续写,需要用户提供上文补充',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '门厅一片狼藉。朝向天井的窗户开着。公寓门突然被撞开了。\\n一名便衣探员、两名穿制服的警察和几位消防员———也身着工作服———进来,四下张望。他们都戴着手套以及盖住口鼻的面罩。在他们身后,门房和他妻子也挤进门厅。他们都捂着鼻子。门房的另一只手里拿着一叠信件和促销广告单。他们身后,跟着一位女邻居。\\n便衣探员(对门房和邻居):请在外面等候。\\n他向一名警察示意,警察正忙着把好奇的旁观者请出门外。\\n警察(对门房,指着那一叠信件):最近的一封是哪天的?\\n门房(查对信件):最近的一封似乎是16号的......等一下......\\n便衣探员想打开左侧的门,却是徒劳。门用胶带封上了。\\n便衣探员(对消防员):你来试一下好吗?\\n消防员摆弄门的时候,便衣探员进了卧室隔壁的餐厅。他迅速打开窗,转身,想经过对开门进左侧的房间。这两扇门也锁着,门缝被贴上了胶带。他右转进入起居室,也打开了窗户',
- 'maxLength' => 5000,
- ],
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier for the task.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'end' => [
- 'title' => '输出是否完成,true 表示完成',
- 'description' => '',
- 'type' => 'boolean',
- ],
- 'header' => [
- 'title' => '流式输出 header 头,包含返回通用信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '异常错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'errorMessage' => [
- 'title' => '异常错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check.',
- ],
- 'event' => [
- 'title' => '事件类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'title' => '事件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` (success) and `false` (failure).', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'The result object.',
'type' => 'object',
'properties' => [
- 'output' => [
- 'title' => '输出内容对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => '这是测试输出',
- ],
- ],
- ],
- 'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'status' => ['description' => 'The task status. Valid values: `PENDING` (Pending), `RUNNING` (Running), `SUCCEEDED` (Succeeded), `FAILED` (Failed), and `CANCELED` (Canceled).', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '任务错误消息'."\n"
+ ."\n", 'title' => ''],
+ 'results' => [
+ 'title' => '',
+ 'description' => 'A list of results.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'customId' => ['title' => 'xxx', 'description' => 'The custom ID that you specified for the task.', 'type' => 'string', 'example' => '1'],
+ 'errorMessage' => ['description' => 'The error message. This field is returned only if an error occurs for the specific task.', 'type' => 'string', 'example' => '触发模型限流', 'title' => ''],
+ 'errorCode' => ['description' => 'The error code. This field is returned only if an error occurs for the specific task.', 'type' => 'string', 'example' => 'RateLimit', 'title' => ''],
+ 'result' => ['description' => 'The review result.', 'type' => 'string', 'example' => '评阅结果'."\n"
+ ."\n", 'title' => ''],
+ 'score' => ['description' => 'The essay review score.', 'type' => 'integer', 'format' => 'int32', 'example' => '58', 'title' => ''],
+ 'dimensionResults' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The dimension name.', 'type' => 'string', 'example' => '内容完整度', 'title' => ''],
+ 'analysis' => ['description' => 'An analysis of strengths and weaknesses for the dimension.', 'type' => 'string', 'example' => '文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。', 'title' => ''],
+ 'score' => ['description' => 'The score for the dimension.', 'type' => 'number', 'format' => 'double', 'example' => '25.5', 'title' => ''],
+ 'maxScore' => ['description' => 'The maximum score for the dimension.', 'type' => 'number', 'format' => 'double', 'example' => '30', 'title' => ''],
+ ],
+ 'description' => 'The scoring result for a dimension.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'The scoring results for each dimension. This parameter is returned in the custom dimension mode.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'overallComment' => ['description' => 'The overall comment.', 'type' => 'string', 'example' => '整体表现良好,建议在论述深度上进一步加强。', 'title' => ''],
+ 'usage' => ['title' => 'Token consumption for a single job ', 'description' => 'The token usage for the task.', '$ref' => '#/components/schemas/ModelUsage', 'example' => ''],
],
+ 'example' => '',
],
+ 'example' => '',
],
+ 'totalUsage' => ['title' => 'Total model token consumption across all Jobs ', 'description' => 'The total token usage for all tasks.', '$ref' => '#/components/schemas/ModelUsage', 'example' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"successful\\",\\n \\"success\\": false,\\n \\"data\\": {\\n \\"status\\": \\"PENDING\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\",\\n \\"results\\": [\\n {\\n \\"customId\\": \\"1\\",\\n \\"errorMessage\\": \\"触发模型限流\\",\\n \\"errorCode\\": \\"RateLimit\\",\\n \\"result\\": \\"评阅结果\\\\n\\\\n\\",\\n \\"score\\": 58,\\n \\"dimensionResults\\": [\\n {\\n \\"name\\": \\"内容完整度\\",\\n \\"analysis\\": \\"文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。\\",\\n \\"score\\": 25.5,\\n \\"maxScore\\": 30\\n }\\n ],\\n \\"overallComment\\": \\"整体表现良好,建议在论述深度上进一步加强。\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 951,\\n \\"outputTokens\\": 13,\\n \\"totalTokens\\": 964\\n }\\n }\\n ],\\n \\"totalUsage\\": {\\n \\"inputTokens\\": 951,\\n \\"outputTokens\\": 13,\\n \\"totalTokens\\": 964\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve the result of an essay grading job',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
],
- 'SubmitVideoAnalysisTask' => [
- 'summary' => '轻应用-提交视频理解任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/submitVideoAnalysisTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetFileContent' => [
+ 'summary' => 'Retrieve the content of a file.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getFileContent',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'videoUrl',
+ 'name' => 'fileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频url',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxx.mp4',
- ],
+ 'schema' => ['description' => 'FileKey (unique identifier for Miaobi service files)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/1154600634854327_10045847/300469535473178749_300469535473178749_ee11508152b74137ac5747a6f632256e.docx', 'title' => ''],
],
[
- 'name' => 'videoModelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-vl-max-latest',
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Alibaba Cloud Model Studio [workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''],
],
- [
- 'name' => 'videoModelCustomPromptTemplate',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BE603C85-90AA-50FC-A2D6-128AA9FA200D'],
+ 'success' => ['description' => 'Is successful: true for success, false for failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'data' => [
+ 'description' => 'Result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => 'Content.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'httpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'Error description.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ ],
'example' => '',
],
],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'modelCustomPromptTemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
- ],
- [
- 'name' => 'modelCustomPromptTemplate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
- [
- 'name' => 'generateOptions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoGenerate',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BE603C85-90AA-50FC-A2D6-128AA9FA200D\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"content\\": \\"xxxx\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"successful\\",\\n \\"code\\": \\"successful\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve file content ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetFileContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'videoExtraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
],
],
+ ],
+ ],
+ 'GetTagMiningAnalysisTask' => [
+ 'summary' => 'Retrieve the result of a tag mining analysis task.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getTagMiningAnalysisTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'snapshotInterval',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '2',
- ],
+ 'AK' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'splitInterval',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
- 'name' => 'language',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chinese',
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => 'workspaceId', 'description' => '[workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
- [
- 'name' => 'frameSampleMethod',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'methodName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
- 'interval' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '2',
- ],
- 'pixel' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '768',
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'videoRoles',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '角色列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'roleInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'urls' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
- ],
- 'required' => false,
- ],
- 'isAutoRecognition' => [
- 'type' => 'boolean',
- ],
- 'timeIntervals' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'endTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'string', 'title' => '', 'example' => '200'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'Business response data',
+ 'type' => 'object',
+ 'properties' => [
+ 'results' => [
+ 'title' => '',
+ 'description' => 'List of analysis results',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Analysis object',
+ 'type' => 'object',
+ 'properties' => [
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'Payload object',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '',
+ 'description' => 'Output object',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'Large Language Model (LLM) response text', 'type' => 'string', 'title' => '', 'example' => 'xxxx'],
+ ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'Usage data',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputToken' => ['description' => 'The number of tokens in the input.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputToken' => ['description' => 'Output token', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ 'totalToken' => ['description' => 'Total token count', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '300'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'header' => [
+ 'title' => '',
+ 'description' => 'Response header',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['description' => 'Large Language Model (LLM) request ID', 'type' => 'string', 'title' => '', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'event' => ['description' => 'Event', 'type' => 'string', 'title' => '', 'example' => 'task-finished'],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => 'DataNotExists'],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => '数据不存在'],
+ ],
+ 'example' => '',
+ ],
+ 'customId' => ['description' => 'Index', 'type' => 'string', 'title' => '', 'example' => '1'],
],
+ 'example' => '',
],
+ 'example' => '',
],
+ 'status' => ['description' => 'Task status. Valid values: SUCCESSED (task succeeded), FAILED (task failed), CANCELED (task canceled), PENDING (task queued), SUSPENDED (task suspended), RUNNING (task in progress)', 'type' => 'string', 'title' => '', 'example' => 'RUNNIN'],
+ 'errorCode' => ['description' => 'Task error code', 'type' => 'string', 'title' => '', 'example' => '任务错误Code'."\n"
+ ."\n"],
+ 'errorMessage' => ['description' => 'Task error message', 'type' => 'string', 'title' => '', 'example' => '任务错误消息'."\n"
+ ."\n"],
],
+ 'example' => '',
],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'textProcessTasks',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'modelId' => [
- 'type' => 'string',
- ],
- 'modelCustomPromptTemplate' => [
- 'type' => 'string',
- ],
- 'modelCustomPromptTemplateId' => [
- 'type' => 'string',
- ],
- ],
+ 'message' => ['description' => 'API error message', 'type' => 'string', 'title' => '', 'example' => 'DataNotExists'],
+ 'requestId' => ['title' => 'requestId', 'description' => 'Request ID', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'example' => '',
],
],
- [
- 'name' => 'faceIdentitySimilarityMinScore',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- ],
- [
- 'name' => 'videoShotFaceIdentityCount',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- [
- 'name' => 'deduplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'type' => 'string',
- 'example' => '1',
- ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
- [
- 'name' => 'excludeGenerateOptions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"successful\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"results\\": [\\n {\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xxxx\\"\\n },\\n \\"usage\\": {\\n \\"inputToken\\": 100,\\n \\"outputToken\\": 200,\\n \\"totalToken\\": 300\\n }\\n },\\n \\"header\\": {\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"event\\": \\"task-finished\\",\\n \\"errorCode\\": \\"DataNotExists\\",\\n \\"errorMessage\\": \\"数据不存在\\"\\n },\\n \\"customId\\": \\"1\\"\\n }\\n ],\\n \\"status\\": \\"RUNNIN\\",\\n \\"errorCode\\": \\"任务错误Code\\\\n\\\\n\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\"\\n },\\n \\"message\\": \\"DataNotExists\\",\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"success\\": true\\n}","type":"json"}]',
+ 'title' => 'Retrieve label mining analysis task result ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
+ ],
+ ],
+ 'GetTaskExecutionStatistics' => [
+ 'summary' => 'Retrieves statistics on task execution.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getTaskExecutionStatistics',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'videoCaptionInfo',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '字幕(asr)信息',
- 'type' => 'object',
- 'properties' => [
- 'videoCaptions' => [
- 'title' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
- 'type' => 'array',
- 'items' => [
- 'title' => '字幕(asr)内容',
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '当前句子开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'endTime' => [
- 'title' => '当前句子结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'text' => [
- 'title' => '内容',
- 'type' => 'string',
- 'example' => '你好',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
- ],
- ],
- ],
- 'videoCaptionFileUrl' => [
- 'title' => '视频字幕(ASR)文件',
- 'type' => 'string',
- 'example' => 'oss:// | http://',
- ],
- ],
- ],
+ 'AK' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'autoRoleRecognitionVideoUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '自动识别专属url',
- 'type' => 'string',
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The unique identifier of the Model Studio workspace. To obtain the workspace ID, see [Get a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx', 'title' => ''],
],
[
- 'name' => 'splitType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'type' => 'string',
- 'example' => 'fixDuration',
- ],
+ 'name' => 'taskCode',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The identifier of the task type.', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask', 'title' => ''],
],
- [
- 'name' => 'addDocumentParam',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '结果自动保存(自动上传妙搜数据集)',
'type' => 'object',
'properties' => [
- 'datasetId' => [
- 'title' => '数据集id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'datasetName' => [
- 'title' => '数据集名称',
- 'type' => 'string',
- ],
- 'document' => [
- 'title' => '自动保存视频参数',
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST', 'title' => ''],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'The response message. A value of `Success` indicates that the request was successful. Otherwise, an error message is returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'data' => [
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '视频名称',
- 'type' => 'string',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'type' => 'string',
- ],
- 'categoryUuid' => [
- 'title' => '类目唯一标识',
- 'type' => 'string',
- ],
- 'tags' => [
- 'title' => '标签',
+ 'runningCount' => ['description' => 'The number of running tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'waitingCount' => ['description' => 'The number of waiting tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'completedCount' => ['description' => 'The number of completed tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'tpmPerMinute' => [
'type' => 'array',
'items' => [
- 'title' => 'value',
- 'type' => 'string',
- ],
- ],
- 'extend1' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'extend2' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'extend3' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'metadata' => [
- 'title' => '字典信息',
- 'type' => 'object',
- 'properties' => [
- 'keyValues' => [
- 'title' => 'key-value格式字典',
- 'type' => 'array',
- 'items' => [
- 'title' => 'key-value格式字典',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'value' => [
- 'title' => '取值',
- 'type' => 'string',
- ],
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'time' => ['description' => 'The timestamp of the data point, aggregated by the minute. The format is `yyyy-MM-dd HH:mm`.', 'type' => 'string', 'example' => '2024-08-01 10:00', 'title' => ''],
+ 'count' => ['description' => 'The number of tasks completed within the specified minute.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'An object containing the task completion statistics for a specific minute.',
+ 'example' => '',
],
+ 'title' => '',
+ 'description' => 'Statistics on the number of tasks completed per minute (TPM) over the last 24 hours.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The object that contains the returned data.',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The data returned in the response.',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetTaskExecutionStatistics',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST\\",\\n \\"code\\": \\"Success\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"成功\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"runningCount\\": 5,\\n \\"waitingCount\\": 10,\\n \\"completedCount\\": 100,\\n \\"tpmPerMinute\\": [\\n {\\n \\"time\\": \\"2024-08-01 10:00\\",\\n \\"count\\": 3\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetVideoAnalysisConfig' => [
+ 'summary' => 'Video Comprehension: Obtain basic configuration.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisConfig',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'videoUrls',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '多视频url',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '', 'description' => 'UUID of the Alibaba Cloud Model Studio workspace: [Obtain workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
],
'responses' => [
@@ -2275,112 +1255,70 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Fault description', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the operation succeeded: true indicates success, and false indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Concurrency of asynchronous tasks',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
+ 'asyncConcurrency' => ['title' => '', 'description' => 'Concurrency of asynchronous tasks: value range [2~10]', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Video Comprehension - Get Configuration',
+ 'description' => 'Alibaba Cloud Model Studio lightweight application - Video Comprehension - Get Configuration: You can use this API to view the concurrency configuration for asynchronous tasks. Visit the [Video Comprehension console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend) to try it out. For invoking the API via a software development kit (SDK), refer to the Sample under “API” in the console.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"success\\": true,\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"asyncConcurrency\\": 2\\n }\\n}","type":"json"}]',
+ 'translator' => 'machine',
],
'GetVideoAnalysisTask' => [
- 'summary' => '轻应用-获取视频理解异步任务结果',
+ 'summary' => 'Light application – retrieve the result of an asynchronous video understanding task.',
'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxx',
- ],
+ 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace: [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'],
],
[
'name' => 'taskId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => 'Unique task identifier', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
],
'responses' => [
@@ -2390,1076 +1328,707 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'data' => [
- 'description' => '',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
'header' => [
- 'description' => '',
+ 'description' => 'Event name',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'',
- ],
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TIMEOUT_CLOSE_ORDER',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd5c38cf6-a4bf-4a57-a697-9f449926f0c9',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6e223291-729b-4e84-9271-c13ada1a776b',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '215045f817272303448235204efdef',
- ],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'', 'title' => ''],
+ 'event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'TIMEOUT_CLOSE_ORDER', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'sessionId' => ['description' => 'Unique session identifier', 'type' => 'string', 'example' => 'd5c38cf6-a4bf-4a57-a697-9f449926f0c9', 'title' => ''],
+ 'taskId' => ['description' => 'Unique generation identifier', 'type' => 'string', 'example' => '6e223291-729b-4e84-9271-c13ada1a776b', 'title' => ''],
+ 'traceId' => ['description' => 'Trace ID', 'type' => 'string', 'example' => '215045f817272303448235204efdef', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'payload' => [
- 'description' => '',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
'output' => [
- 'description' => '',
+ 'description' => 'Result',
'type' => 'object',
'properties' => [
'videoAnalysisResult' => [
- 'description' => '',
+ 'description' => 'Generated content from language analysis',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'VL-generated text result', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'usage' => [
- 'description' => '',
+ 'description' => 'Token count',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'imageTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'imageTokens' => ['description' => 'Image tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'videoShotAnalysisResults' => [
- 'description' => '',
+ 'description' => 'Language analysis results for each video shot. Due to large content size, obtain this data from the file at resultJsonFileUrl.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Video shot result',
'type' => 'object',
'properties' => [
- 'endTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1710432000000',
- ],
- 'startTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2024-10-05 06:22:00',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'endTime' => ['description' => 'End time in relative time (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'startTime' => ['description' => 'Start time in relative time (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'text' => ['description' => 'Generated raw content', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'videoCaptionResult' => [
- 'description' => '',
+ 'description' => 'Video captions',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'videoCaptions' => [
- 'description' => '',
+ 'description' => 'Video captions',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Video captions',
'type' => 'object',
'properties' => [
- 'endTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1736129678000',
- ],
- 'endTimeFormat' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'startTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '00:01',
- ],
- 'startTimeFormat' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-01-07 11:52:06',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
+ 'endTime' => ['description' => 'End time in relative time (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''],
+ 'endTimeFormat' => ['description' => 'Formatted end time', 'type' => 'string', 'example' => '00:01', 'title' => ''],
+ 'startTime' => ['description' => 'Start time in relative time (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'startTimeFormat' => ['description' => 'Formatted start time', 'type' => 'string', 'example' => '00:01', 'title' => ''],
+ 'text' => ['description' => 'Caption content', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'speaker' => ['title' => 'Role ', 'description' => 'Role', 'type' => 'string', 'example' => '张三'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'videoGenerateResult' => [
- 'description' => '',
+ 'description' => 'Text summarization result. For multitasking, get results from the videoGenerateResults field.',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Generated text', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'usage' => [
- 'description' => '',
+ 'description' => 'Output token count',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'modelId' => [
- 'type' => 'string',
- ],
- 'modelReduce' => [
- 'type' => 'boolean',
- ],
- 'reasonText' => [
- 'type' => 'string',
- ],
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'example' => 'qwen-max-latest', 'title' => ''],
+ 'modelReduce' => ['description' => 'Indicates whether the model was downgraded. If the model is qwen-max or qwen-max-latest and exceeds the prompt input limit, it attempts to downgrade to qwen-plus-latest to preserve information integrity.', 'type' => 'boolean', 'example' => 'qwen-plus-latest', 'title' => ''],
+ 'reasonText' => ['description' => 'Model reasoning process', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'index' => ['description' => 'Multitask index starting from 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'videoMindMappingGenerateResult' => [
- 'description' => '',
+ 'description' => 'Mind map generation complete',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Generated text', 'type' => 'string', 'example' => '小吃街', 'title' => ''],
'usage' => [
- 'description' => '',
+ 'description' => 'Input token count',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'videoMindMappings' => [
- 'description' => '',
+ 'description' => 'Mind map results',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Child node',
'type' => 'object',
'properties' => [
'childNodes' => [
- 'description' => '',
+ 'description' => 'Child node',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Child node',
'type' => 'object',
'properties' => [
'childNodes' => [
- 'description' => '',
+ 'description' => 'Child node',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Node description',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '三级节点', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '二级节点', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '三级节点', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'videoTitleGenerateResult' => [
- 'description' => '',
+ 'description' => 'Title generation result',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Text generation result', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'usage' => [
- 'description' => '',
+ 'description' => 'Token count',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'resultJsonFileUrl' => [
- 'title' => '全量结果文件地址:'."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
- .'当前包含的字段:'."\n"
- .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
- .'其他字段获取方式不变,文本方式返回。'."\n"
- .'文件类型:json'."\n"
- .'文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'type' => 'string',
- ],
+ 'resultJsonFileUrl' => ['title' => 'URL of the full result file: '."\n"
+ .'Due to the large size of the response result, data retrieval for certain fields is provided via a file. You can download the file using the URL in this field and parse it as follows: '."\n"
+ .'Fields currently included: '."\n"
+ .'- videoShotSnapshotResult (frame extraction information per shard); for data structure definition, see the RunVideoAnalysis API '."\n"
+ .'Other fields remain unchanged and are returned in text format. '."\n"
+ .'File type: JSON '."\n"
+ .'File content: Full message, including the data returned in text format '."\n"
+ .'Returned event: task-finished'."\n", 'description' => 'Result JSON file URL:'."\n"
+ ."\n"
+ .'Due to large response size, some data is provided via file download. Use the URL in this field to download and parse the file:'."\n"
+ ."\n"
+ .'- Fields included: See data structure definition in RunVideoAnalysis API'."\n"
+ ."\n"
+ .' - videoShotSnapshotResult: Frame extraction info for each shard, including frame URLs'."\n"
+ ."\n"
+ .' - videoShotAnalysisResults: Detailed language analysis results for each shard'."\n"
+ ."\n"
+ .'- Other fields remain unchanged and are returned as text.'."\n"
+ ."\n"
+ .'- File type: JSON'."\n"
+ ."\n"
+ .'- File content: Full message body, including text-based responses with event: task-finished', 'type' => 'string', 'example' => 'http://xxx'],
'videoGenerateResults' => [
+ 'description' => 'When input parameters include multitasking (textProcessTasks has a value), text processing results are returned in this field. Locate the corresponding result by array index (starting from 0) or by index (starting from 1).',
'type' => 'array',
'items' => [
+ 'description' => 'Text processing task result',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'type' => 'boolean',
- ],
- 'modelId' => [
- 'type' => 'string',
- ],
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'text' => [
- 'type' => 'string',
- ],
- 'reasonText' => [
- 'type' => 'string',
- ],
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'index' => ['description' => 'Multitask index starting from 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'text' => ['description' => 'Generated content', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'reasonText' => ['description' => 'Model reasoning process', 'type' => 'string', 'example' => 'xx', 'title' => ''],
'usage' => [
+ 'description' => 'Usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'totalTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'videoRoleRecognitionResult' => [
+ 'description' => 'Automatic recognition result',
'type' => 'object',
'properties' => [
'videoRoles' => [
+ 'description' => 'List of roles',
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'roleName' => [
- 'type' => 'string',
- ],
- 'roleInfo' => [
- 'type' => 'string',
- ],
+ 'roleName' => ['description' => 'Role name', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'roleInfo' => ['description' => 'Character information', 'type' => 'string', 'example' => 'xx', 'title' => ''],
'timeIntervals' => [
+ 'description' => 'List of role appearance time intervals',
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'endTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timestamp' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'url' => [
- 'type' => 'string',
- ],
+ 'startTime' => ['description' => 'Start time', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'endTime' => ['description' => 'End time', 'type' => 'integer', 'format' => 'int64', 'example' => '342463553646', 'title' => ''],
+ 'timestamp' => ['description' => 'Timestamp of role appearance in current time interval', 'type' => 'integer', 'format' => 'int64', 'example' => '42553453253', 'title' => ''],
+ 'url' => ['description' => 'Role image', 'type' => 'string', 'example' => 'http://', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'ratio' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'isAutoRecognition' => [
- 'type' => 'boolean',
- ],
+ 'ratio' => ['description' => 'Appearance rate', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''],
+ 'isAutoRecognition' => ['description' => 'Indicates whether automatic recognition used a separate video URL. If true, face images cannot be matched to video frames by timestamp because they may come from different videos.', 'type' => 'boolean', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'videoCalculatorResult' => [
- 'title' => '费用估算结果',
+ 'description' => 'Cost estimation result',
+ 'title' => 'Fee estimation result',
'type' => 'object',
'properties' => [
'items' => [
- 'title' => '计费项明细',
+ 'description' => 'Billing item details',
+ 'title' => 'Billing item details',
'type' => 'array',
'items' => [
- 'title' => '计费项明细',
+ 'description' => 'Billing item details',
+ 'title' => 'Billing item details',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '计费项名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'type' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'inputToken' => [
- 'title' => '类型',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputToken' => [
- 'title' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'time' => [
- 'title' => '计费时长',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'inputExpense' => [
- 'title' => '输入token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'outputExpense' => [
- 'title' => '输入token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'timeExpense' => [
- 'title' => '输出token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'totalExpense' => [
- 'title' => '费用',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.098',
- ],
+ 'name' => ['title' => 'Billing item name', 'description' => 'Billing item name', 'type' => 'string', 'example' => 'xxx'],
+ 'type' => ['title' => 'Name', 'description' => 'Type', 'type' => 'string', 'example' => 'token'],
+ 'inputToken' => ['title' => 'Type', 'description' => 'Input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputToken' => ['title' => 'Input token', 'description' => 'Output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'time' => ['title' => 'Billing duration', 'description' => 'Billed duration', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'inputExpense' => ['title' => 'Input token billing', 'description' => 'Input token billing', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'outputExpense' => ['title' => 'Input token billing', 'description' => 'Input token billing', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'timeExpense' => ['title' => 'Output token billing', 'description' => 'Output token billing', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'totalExpense' => ['title' => 'Fee ', 'description' => 'Cost', 'type' => 'number', 'format' => 'double', 'example' => '0.098'],
],
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
'addDatasetDocumentsResult' => [
- 'title' => '自动保存执行结果',
+ 'description' => 'Automatic save execution result',
+ 'title' => 'Automatically save the execution result ',
'type' => 'object',
'properties' => [
- 'status' => [
- 'title' => '自动保存任务状态:1 成功,0 失败',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'title' => [
- 'title' => '视频名称',
- 'type' => 'string',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '如果自动保存失败,则输出错误信息',
- 'type' => 'string',
- ],
- 'docUuid' => [
- 'title' => '视频的docUuid',
- 'type' => 'string',
- ],
+ 'status' => ['title' => 'Auto-save job status: 1 Succeeded, 0 failed', 'description' => 'Automatic save task status: 1 for success, 0 for failure', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'title' => ['title' => 'Video Name', 'description' => 'Video title', 'type' => 'string', 'example' => 'xx'],
+ 'docId' => ['title' => 'Video docId ', 'description' => 'Video docId', 'type' => 'string', 'example' => 'xxx'],
+ 'errorMessage' => ['title' => 'If automatic saving failed, output the error message', 'description' => 'If automatic saving fails, this field contains the error message.', 'type' => 'string', 'example' => 'xx'],
+ 'docUuid' => ['title' => 'Video docUuid ', 'description' => 'Video docUuid', 'type' => 'string', 'example' => 'xxx'],
],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'usage' => [
- 'description' => '',
+ 'description' => 'Token description',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'taskRunInfo' => [
- 'title' => '运行信息',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Runtime information',
'type' => 'object',
'properties' => [
- 'concurrentChargeEnable' => [
- 'title' => '是否使用付给并发:true时,按照实际运行时长计量',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'responseTime' => [
- 'title' => '运行时长:rt',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'concurrentChargeEnable' => ['description' => 'Indicates whether paid concurrency is used. When true, billing is based on actual runtime duration.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'responseTime' => ['description' => 'Runtime duration: Time elapsed from task scheduling to completion, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'],
],
+ 'example' => '',
],
- 'taskStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Access was denied, message: No such namespace namespaces/mjp-test-default.',
- ],
+ 'taskStatus' => ['description' => 'Task status.'."\n"
+ ."\n"
+ .'- PENDING: Pending'."\n"
+ ."\n"
+ .'- RUNNING: Running'."\n"
+ ."\n"
+ .'- SUCCESSED: Succeeded'."\n"
+ ."\n"
+ .'- SUSPENDED: Suspended'."\n"
+ ."\n"
+ .'- FAILED: Failed'."\n"
+ ."\n"
+ .'- CANCELED: Canceled', 'type' => 'string', 'example' => 'SUCCESSED', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Access was denied, message: No such namespace namespaces/mjp-test-default.', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"header\\": {\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'\\",\\n \\"event\\": \\"TIMEOUT_CLOSE_ORDER\\",\\n \\"eventInfo\\": \\"xxx\\",\\n \\"sessionId\\": \\"d5c38cf6-a4bf-4a57-a697-9f449926f0c9\\",\\n \\"taskId\\": \\"6e223291-729b-4e84-9271-c13ada1a776b\\",\\n \\"traceId\\": \\"215045f817272303448235204efdef\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoAnalysisResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0,\\n \\"imageTokens\\": 1\\n },\\n \\"videoShotAnalysisResults\\": [\\n {\\n \\"endTime\\": 10000,\\n \\"startTime\\": 1000,\\n \\"text\\": \\"xxxx\\"\\n }\\n ]\\n },\\n \\"videoCaptionResult\\": {\\n \\"generateFinished\\": true,\\n \\"videoCaptions\\": [\\n {\\n \\"endTime\\": 20000,\\n \\"endTimeFormat\\": \\"00:01\\",\\n \\"startTime\\": 1000,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"text\\": \\"xxxx\\",\\n \\"speaker\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"videoGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max-latest\\",\\n \\"modelReduce\\": true,\\n \\"reasonText\\": \\"xx\\",\\n \\"index\\": 1\\n },\\n \\"videoMindMappingGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"小吃街\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"videoMindMappings\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"name\\": \\"三级节点\\"\\n }\\n ],\\n \\"name\\": \\"二级节点\\"\\n }\\n ],\\n \\"name\\": \\"三级节点\\"\\n }\\n ]\\n },\\n \\"videoTitleGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n },\\n \\"resultJsonFileUrl\\": \\"http://xxx\\",\\n \\"videoGenerateResults\\": [\\n {\\n \\"generateFinished\\": true,\\n \\"modelId\\": \\"xx\\",\\n \\"index\\": 1,\\n \\"text\\": \\"xx\\",\\n \\"reasonText\\": \\"xx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n }\\n ],\\n \\"videoRoleRecognitionResult\\": {\\n \\"videoRoles\\": [\\n {\\n \\"roleName\\": \\"xx\\",\\n \\"roleInfo\\": \\"xx\\",\\n \\"timeIntervals\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 342463553646,\\n \\"timestamp\\": 42553453253,\\n \\"url\\": \\"http://\\"\\n }\\n ],\\n \\"ratio\\": 0.2,\\n \\"isAutoRecognition\\": false\\n }\\n ]\\n },\\n \\"videoCalculatorResult\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"xxx\\",\\n \\"type\\": \\"token\\",\\n \\"inputToken\\": 1,\\n \\"outputToken\\": 1,\\n \\"time\\": 1,\\n \\"inputExpense\\": 1,\\n \\"outputExpense\\": 1,\\n \\"timeExpense\\": 1,\\n \\"totalExpense\\": 0.098\\n }\\n ]\\n },\\n \\"addDatasetDocumentsResult\\": {\\n \\"status\\": 1,\\n \\"title\\": \\"xx\\",\\n \\"docId\\": \\"xxx\\",\\n \\"errorMessage\\": \\"xx\\",\\n \\"docUuid\\": \\"xxx\\"\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n },\\n \\"taskRunInfo\\": {\\n \\"concurrentChargeEnable\\": true,\\n \\"responseTime\\": 1000\\n },\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/mjp-test-default.\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Video Understanding – Retrieve asynchronous job status and result ',
+ 'description' => 'Alibaba Cloud Model Studio light application – video understanding – get the status and result of an asynchronous task. Use this API to check the status and result of a video understanding task submitted via the “Submit asynchronous task” API. Try it in the [Video Understanding console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend).'."\n"
+ ."\n"
+ .'> If the response includes `header -> errorCode = ViolationOfSecurityPolicy`, the request triggered a system security policy restriction. Modify the request content accordingly. In this case, business data such as `videoAnalysisResult` returns empty.',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-11-24T13:17:56.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-01-15T11:40:37.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"header\\": {\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'\\",\\n \\"event\\": \\"TIMEOUT_CLOSE_ORDER\\",\\n \\"eventInfo\\": \\"xxx\\",\\n \\"sessionId\\": \\"d5c38cf6-a4bf-4a57-a697-9f449926f0c9\\",\\n \\"taskId\\": \\"6e223291-729b-4e84-9271-c13ada1a776b\\",\\n \\"traceId\\": \\"215045f817272303448235204efdef\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoAnalysisResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0,\\n \\"imageTokens\\": 0\\n },\\n \\"videoShotAnalysisResults\\": [\\n {\\n \\"endTime\\": 10000,\\n \\"startTime\\": 1000,\\n \\"text\\": \\"xxxx\\"\\n }\\n ]\\n },\\n \\"videoCaptionResult\\": {\\n \\"generateFinished\\": true,\\n \\"videoCaptions\\": [\\n {\\n \\"endTime\\": 20000,\\n \\"endTimeFormat\\": \\"00:01\\",\\n \\"startTime\\": 1000,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"text\\": \\"xxxx\\",\\n \\"speaker\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"videoGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max-latest\\",\\n \\"modelReduce\\": true,\\n \\"reasonText\\": \\"xx\\",\\n \\"index\\": 1\\n },\\n \\"videoMindMappingGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"小吃街\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"videoMindMappings\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"name\\": \\"三级节点\\"\\n }\\n ],\\n \\"name\\": \\"二级节点\\"\\n }\\n ],\\n \\"name\\": \\"三级节点\\"\\n }\\n ]\\n },\\n \\"videoTitleGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"xxxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n },\\n \\"resultJsonFileUrl\\": \\"http://xxx\\",\\n \\"videoGenerateResults\\": [\\n {\\n \\"generateFinished\\": true,\\n \\"modelId\\": \\"xx\\",\\n \\"index\\": 1,\\n \\"text\\": \\"xx\\",\\n \\"reasonText\\": \\"xx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n }\\n ],\\n \\"videoRoleRecognitionResult\\": {\\n \\"videoRoles\\": [\\n {\\n \\"roleName\\": \\"xx\\",\\n \\"roleInfo\\": \\"xx\\",\\n \\"timeIntervals\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 342463553646,\\n \\"timestamp\\": 42553453253,\\n \\"url\\": \\"http://\\"\\n }\\n ],\\n \\"ratio\\": 0.2,\\n \\"isAutoRecognition\\": true\\n }\\n ]\\n },\\n \\"videoCalculatorResult\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"xxx\\",\\n \\"type\\": \\"\\",\\n \\"inputToken\\": 0,\\n \\"outputToken\\": 0,\\n \\"time\\": 0,\\n \\"inputExpense\\": 0,\\n \\"outputExpense\\": 0,\\n \\"timeExpense\\": 0,\\n \\"totalExpense\\": 0.098\\n }\\n ]\\n },\\n \\"addDatasetDocumentsResult\\": {\\n \\"status\\": 0,\\n \\"title\\": \\"\\",\\n \\"docId\\": \\"\\",\\n \\"errorMessage\\": \\"\\",\\n \\"docUuid\\": \\"\\"\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n },\\n \\"taskRunInfo\\": {\\n \\"concurrentChargeEnable\\": true,\\n \\"responseTime\\": 1000\\n },\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"errorMessage\\": \\"Access was denied, message: No such namespace namespaces/mjp-test-default.\\"\\n }\\n}","type":"json"}]',
],
- 'UpdateVideoAnalysisTask' => [
- 'summary' => '视频理解-修改任务状态',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTask',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetVideoDetectShotConfig' => [
+ 'summary' => 'Smart video segmentation: Retrieves configuration',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoDetectShotConfig',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'taskStatus',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
- ],
+ 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace: [Get the workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'xxx'],
+ 'code' => ['title' => 'code', 'description' => 'Status code', 'type' => 'string', 'example' => '200'],
+ 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'msg', 'title' => ''],
+ 'success' => ['title' => 'success', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'title' => '任务信息',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Asynchronous task concurrency',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'taskStatus' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CANCELED',
- ],
- 'taskErrorMessage' => [
- 'title' => '任务失败信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'asyncConcurrency' => ['description' => 'Asynchronous task concurrency', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxx\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"msg\\",\\n \\"success\\": false,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"asyncConcurrency\\": 2\\n }\\n}","type":"json"}]',
+ 'title' => 'Intelligent Clip Extraction - Get Configuration ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"DataNotExists\\",\\n \\"message\\": \\"任务不存在\\",\\n \\"success\\": false,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"taskStatus\\": \\"CANCELED\\",\\n \\"taskErrorMessage\\": \\"主动取消\\"\\n }\\n}","type":"json"}]',
],
- 'UpdateVideoAnalysisTasks' => [
- 'summary' => '视频理解-批量修改任务状态',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTasks',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetVideoDetectShotTask' => [
+ 'summary' => 'Light App — Retrieve the result of an asynchronous video splitting task',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getVideoDetectShotTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '任务id列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '任务id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'Unique identifier of your Model Studio workspace. For more information, see [Get the workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
],
[
- 'name' => 'taskStatus',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
- ],
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Unique identifier of the task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request succeeded. Set to true for success or false for failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'data' => [
- 'title' => '删除结果',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '删除结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'taskStatus' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CANCELED',
+ 'description' => 'Response data',
+ 'type' => 'object',
+ 'properties' => [
+ 'header' => [
+ 'description' => 'Event name',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'', 'title' => ''],
+ 'event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'TIMEOUT_CLOSE_ORDER', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'sessionId' => ['description' => 'Unique session identifier', 'type' => 'string', 'example' => 'd5c38cf6-a4bf-4a57-a697-9f449926f0c9', 'title' => ''],
+ 'taskId' => ['description' => 'Unique task identifier', 'type' => 'string', 'example' => '6e223291-729b-4e84-9271-c13ada1a776b', 'title' => ''],
+ 'traceId' => ['description' => 'Full trace ID', 'type' => 'string', 'example' => '215045f817272303448235204efdef', 'title' => ''],
],
- 'taskErrorMessage' => [
- 'title' => '任务失败信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'payload' => [
+ 'description' => 'Results',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'description' => 'Output result',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoSplitResult' => [
+ 'description' => 'Video splitting result',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'Video splitting result', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'reasonText' => ['description' => 'Deep thinking result', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'videoParts' => [
+ 'title' => '',
+ 'description' => 'Structured video splitting result. If structuring fails, this field is omitted. Parse the result from the text field instead. You can customize this field using a prompt. To modify it, use modelCustomPromptTemplateId (obtain it by calling the /getLightAppGeneralConfig API).',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'xxx', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'videoRecognitionResult' => [
+ 'title' => '',
+ 'description' => 'List of video recognition results. These are generated based on the recognitionOptions input parameter.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'Start time of the current recognition result', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1758108425000'],
+ 'endTime' => ['description' => 'End time of the current recognition result', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1748483740000'],
+ 'asr' => ['description' => 'Speech-to-text result', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'ocr' => ['description' => 'Optical character recognition (OCR) result from the video frame', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'vl' => ['description' => 'Visual language (VL) recognition result from the video frame', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'description' => 'Token count',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'taskErrorCode' => [
- 'title' => '任务失败code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'taskRunInfo' => [
+ 'title' => '',
+ 'description' => 'Task runtime information',
+ 'type' => 'object',
+ 'properties' => [
+ 'concurrentChargeEnable' => ['description' => 'Whether concurrent billing is enabled. If true, billing is based on actual runtime.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'responseTime' => ['description' => 'Runtime (in milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'],
],
+ 'example' => '',
],
+ 'taskStatus' => ['description' => 'Task status', 'type' => 'string', 'example' => 'SUCCESSED', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"success\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"taskId\\": \\"xx\\",\\n \\"taskStatus\\": \\"CANCELED\\",\\n \\"taskErrorMessage\\": \\"xx\\",\\n \\"taskErrorCode\\": \\"xx\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'UpdateVideoAnalysisConfig' => [
- 'summary' => '视频理解-更新配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisConfig',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'asyncConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '视频理解-离线任务并发数,取值范围[2, 10]',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
- ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"successful\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"header\\": {\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'\\",\\n \\"event\\": \\"TIMEOUT_CLOSE_ORDER\\",\\n \\"eventInfo\\": \\"xxx\\",\\n \\"sessionId\\": \\"d5c38cf6-a4bf-4a57-a697-9f449926f0c9\\",\\n \\"taskId\\": \\"6e223291-729b-4e84-9271-c13ada1a776b\\",\\n \\"traceId\\": \\"215045f817272303448235204efdef\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoSplitResult\\": {\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"videoParts\\": [\\n {\\n \\"key\\": \\"xxx\\"\\n }\\n ],\\n \\"videoRecognitionResult\\": [\\n {\\n \\"startTime\\": 1758108425000,\\n \\"endTime\\": 1748483740000,\\n \\"asr\\": \\"xxx\\",\\n \\"ocr\\": \\"xxx\\",\\n \\"vl\\": \\"xxx\\"\\n }\\n ]\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 36,\\n \\"outputTokens\\": 13,\\n \\"totalTokens\\": 49\\n }\\n },\\n \\"taskRunInfo\\": {\\n \\"concurrentChargeEnable\\": true,\\n \\"responseTime\\": 1000\\n },\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"errorMessage\\": \\"Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Intelligent Clip Extraction – Retrieve asynchronous job status and result ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'GetVideoAnalysisConfig' => [
- 'summary' => '视频理解-获取配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisConfig',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'HotNewsRecommend' => [
+ 'summary' => 'Hot News Recommendation ',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/hotNewsRecommend',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Prompt for recommended news ', 'type' => 'string', 'required' => false, 'example' => '今天的财经新闻'],
+ ],
+ [
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '', 'description' => 'Workspace ID ', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
],
'responses' => [
@@ -3469,2746 +2038,953 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '', 'description' => 'The Unique Identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '575D5893-01DB-5C81-A899-74F67616762A'],
+ 'code' => ['title' => '', 'description' => 'Return code of the API: 200 indicates success. Other values indicate error codes. For details about error codes, see error code. ', 'type' => 'string', 'example' => '200'],
+ 'success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded: true: Succeeded. false: Failed to invoke.', 'type' => 'boolean', 'example' => 'True'],
+ 'message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'ok'],
'data' => [
- 'title' => '异步任务并发数',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'News recommendation result ',
'type' => 'object',
'properties' => [
- 'asyncConcurrency' => [
- 'title' => '异步任务并发数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'news' => [
+ 'title' => '',
+ 'description' => 'List of recommended news ',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Recommended news object ',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'xx'],
+ 'content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => 'xx'],
+ 'url' => ['title' => '', 'description' => 'Link', 'type' => 'string', 'example' => 'http://xxx'],
+ 'pubTime' => ['title' => '', 'description' => 'Published At ', 'type' => 'string', 'example' => '2024-09-10 15:32:00'],
+ 'source' => ['title' => '', 'description' => 'News source', 'type' => 'string', 'example' => '新华社'],
+ 'searchSource' => ['title' => '', 'description' => 'Search source ', 'type' => 'string', 'example' => 'QuarkCommonNews:联网检索'],
+ 'imageUrls' => [
+ 'title' => '',
+ 'description' => 'List of news images ',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of image URLs', 'type' => 'string', 'example' => 'http://www.example.com/xxx.png', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"575D5893-01DB-5C81-A899-74F67616762A\\",\\n \\"code\\": \\"200\\",\\n \\"success\\": true,\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"news\\": [\\n {\\n \\"title\\": \\"xx\\",\\n \\"content\\": \\"xx\\",\\n \\"url\\": \\"http://xxx\\",\\n \\"pubTime\\": \\"2024-09-10 15:32:00\\",\\n \\"source\\": \\"新华社\\",\\n \\"searchSource\\": \\"QuarkCommonNews:联网检索\\",\\n \\"imageUrls\\": [\\n \\"http://www.example.com/xxx.png\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'News Hot Spot Recommendations',
+ 'description' => 'Understand user intent and retrieve the hot spot list under the corresponding channel, such as “broadcast sports news.” This is a legacy API. We recommend using the “RunHotTopicChat” API for single hot topic Q&A, which fully overwrites the capabilities of this API. '."\n"
+ ."\n"
+ .'You can try it out in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast). '."\n"
+ ."\n"
+ .'For invoking the API via software development kit (SDK), refer to the Java and Python samples under “API” in the console. ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:HotNewsRecommend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"asyncConcurrency\\": 2\\n }\\n}","type":"json"}]',
],
- 'RunVideoAnalysis' => [
- 'summary' => '轻应用-视频理解',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'ListAnalysisTagDetailByTaskId' => [
+ 'summary' => 'Retrieves a detailed list of data mining analysis results.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/listAnalysisTagDetailByTaskId',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'videoUrl',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxx.mp4',
- ],
- ],
- [
- 'name' => 'videoModelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-vl-max',
- ],
- ],
- [
- 'name' => 'videoModelCustomPromptTemplate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'modelCustomPromptTemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'Mark the current read position. An empty value means start from the beginning.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g=='],
],
[
- 'name' => 'modelCustomPromptTemplate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The maximum number of data records to read in this request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'generateOptions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoGenerate',
- ],
- 'required' => false,
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
],
[
'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- [
- 'name' => 'originalSessionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
- ],
- [
- 'name' => 'videoExtraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量',
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'snapshotInterval',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。',
- 'type' => 'number',
- 'format' => 'double',
- ],
- ],
- [
- 'name' => 'splitInterval',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'language',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)',
- 'type' => 'string',
- 'example' => 'english',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the data mining task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
- [
- 'name' => 'frameSampleMethod',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'methodName' => [
- 'type' => 'string',
- ],
- 'interval' => [
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'pixel' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- [
- 'name' => 'videoRoles',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'type' => 'string',
- ],
- 'roleInfo' => [
- 'type' => 'string',
- ],
- 'urls' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'isAutoRecognition' => [
- 'type' => 'boolean',
- ],
- 'timeIntervals' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'endTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'totalCount' => ['description' => 'TotalCount: The total amount of data under the current request conditions. This parameter is optional and may not be returned by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'nextToken' => ['description' => 'Indicates the current read position returned by the call. An empty value means all data has been read.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx', 'title' => ''],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxxxx'],
+ 'maxResults' => ['description' => 'MaxResults: The maximum number of records returned by this request.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''],
+ 'message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'success' => ['description' => 'Indicates if this request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'Detailed list of tag mining.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Tag mining details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => 'Tag content.', 'type' => 'string', 'title' => '', 'example' => 'xxxx'],
+ 'contentTags' => [
+ 'title' => '',
+ 'description' => 'List of tag mining content.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'Tag name.', 'type' => 'string', 'title' => '', 'example' => '标签名称'],
+ 'tags' => [
+ 'title' => '',
+ 'description' => 'List of tag values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Tag value.', 'type' => 'string', 'title' => '', 'example' => '标签值'],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
+ ],
+ 'originResponse' => ['description' => 'Original mining response.', 'type' => 'string', 'title' => '', 'example' => '原始响应'],
+ 'sourceList' => [
+ 'description' => 'List of traceability source texts. This field is returned when sourceTrace is enabled.',
+ 'title' => 'List of source texts. This field is returned when sourceTrace is enabled. ',
+ 'type' => 'array',
+ 'items' => ['title' => 'Source text. This field is returned when sourceTrace is enabled. ', 'description' => 'Traceability source text. This field is returned when sourceTrace is enabled.', 'type' => 'string', 'example' => ''],
+ 'example' => '',
],
],
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
- [
- 'name' => 'textProcessTasks',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'modelId' => [
- 'type' => 'string',
- ],
- 'modelCustomPromptTemplate' => [
- 'type' => 'string',
- ],
- 'modelCustomPromptTemplateId' => [
- 'type' => 'string',
- ],
- ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 200,\\n \\"nextToken\\": \\"xxxxx\\",\\n \\"requestId\\": \\"xxxxxxx\\",\\n \\"maxResults\\": 100,\\n \\"code\\": \\"DataNotExists\\",\\n \\"message\\": \\"成功\\",\\n \\"success\\": false,\\n \\"data\\": [\\n {\\n \\"content\\": \\"xxxx\\",\\n \\"contentTags\\": [\\n {\\n \\"tagName\\": \\"标签名称\\",\\n \\"tags\\": [\\n \\"标签值\\"\\n ]\\n }\\n ],\\n \\"originResponse\\": \\"原始响应\\",\\n \\"sourceList\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain the detailed list of mining results',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
+ ],
+ ],
+ 'ListHotTopicSummaries' => [
+ 'summary' => 'This API retrieves the complete broadcast list (hot list) for the Alibaba Cloud Model Studio Light Application’s In-car/Content Platform Hot News Interaction. It returns all associated content.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/listHotTopicSummaries',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'faceIdentitySimilarityMinScore',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
+ 'AK' => [],
],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
[
- 'name' => 'videoShotFaceIdentityCount',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier for the Model Studio workspace. Find it in the top-left corner of the Model Studio home page.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
],
[
- 'name' => 'excludeGenerateOptions',
+ 'name' => 'category',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
+ 'schema' => ['description' => 'Categorization', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'videoCaptionInfo',
+ 'name' => 'hotTopic',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '字幕(asr)信息',
- 'type' => 'object',
- 'properties' => [
- 'videoCaptions' => [
- 'title' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
- 'type' => 'array',
- 'items' => [
- 'title' => '字幕(asr)内容',
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '当前句子开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'endTime' => [
- 'title' => '当前句子结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'text' => [
- 'title' => '内容',
- 'type' => 'string',
- 'example' => '你好',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
- ],
- ],
- ],
- 'videoCaptionFileUrl' => [
- 'title' => '视频字幕(ASR)文件',
- 'type' => 'string',
- 'example' => 'oss:// | http://',
- ],
- ],
- ],
+ 'schema' => ['description' => 'Hot topic', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'autoRoleRecognitionVideoUrl',
+ 'name' => 'hotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Hot topic version', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-09-13_12'],
],
[
- 'name' => 'splitType',
+ 'name' => 'nextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'type' => 'string',
- 'example' => 'fixDuration',
- ],
+ 'schema' => ['description' => 'Token for the next page.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g=='],
],
[
- 'name' => 'videoUrls',
+ 'name' => 'maxResults',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '多视频url',
- 'type' => 'array',
- 'items' => [
- 'title' => '视频url',
- 'type' => 'string',
- ],
- ],
- ],
- [
- 'name' => 'addDocumentParam',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '结果自动保存(自动上传妙搜数据集)',
- 'type' => 'object',
- 'properties' => [
- 'datasetId' => [
- 'title' => '数据集id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'datasetName' => [
- 'title' => '数据集名称',
- 'type' => 'string',
- ],
- 'document' => [
- 'title' => '自动保存视频参数',
- 'type' => 'object',
- 'properties' => [
- 'title' => [
- 'title' => '视频名称',
- 'type' => 'string',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'type' => 'string',
- ],
- 'categoryUuid' => [
- 'title' => '类目唯一标识',
- 'type' => 'string',
- ],
- 'tags' => [
- 'title' => '标签',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签',
- 'type' => 'string',
- ],
- ],
- 'extend1' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'extend2' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'extend3' => [
- 'title' => '扩展字段',
- 'type' => 'string',
- ],
- 'metadata' => [
- 'title' => '字典',
- 'type' => 'object',
- 'properties' => [
- 'keyValues' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'type' => 'string',
- ],
- 'value' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'schema' => ['description' => 'Maximum number of results returned per page.'."\n"
+ ."\n"
+ .'> Default is 100. Maximum is 1000.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidParam',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check log.',
- ],
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-progress-start-generating',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'videoAnalysisResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'imageTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'videoShotAnalysisResults' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'endTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'startTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-vl-max',
- ],
- ],
- ],
- 'videoCaptionResult' => [
- 'description' => '',
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'Hot spot information list',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Hot spot information',
+ 'type' => 'object',
+ 'properties' => [
+ 'category' => ['description' => 'Hot topic categorization', 'type' => 'string', 'title' => '', 'example' => '财经'],
+ 'hotTopic' => ['description' => 'Hot topic name', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'hotTopicVersion' => ['description' => 'Hot topic summary version', 'type' => 'string', 'title' => '', 'example' => '2024-09-13_12'],
+ 'hotValue' => ['description' => 'Hotness', 'type' => 'number', 'format' => 'double', 'example' => '1000000', 'title' => ''],
+ 'id' => ['description' => 'Hot topic ID', 'type' => 'string', 'title' => '', 'example' => 'db5dc5b3d8954a30b65ba700c9dda3bb'],
+ 'news' => [
+ 'title' => '',
+ 'description' => 'Article list',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Article',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'videoCaptions' => [
- 'description' => '',
+ 'comments' => [
+ 'title' => '',
+ 'description' => 'Structured summary list',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Structured summary',
'type' => 'object',
'properties' => [
- 'endTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1710432000000',
- ],
- 'endTimeFormat' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'startTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'startTimeFormat' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
+ 'text' => ['description' => 'Content', 'type' => 'string', 'title' => '', 'example' => 'xx'],
],
+ 'example' => '',
],
- ],
- ],
- ],
- 'videoGenerateResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
'example' => '',
],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelReduce' => [
- 'title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest',
- 'type' => 'boolean',
- ],
- 'reasonText' => [
- 'type' => 'string',
- ],
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'content' => ['description' => 'Body text', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'pubTime' => ['description' => 'Publish time', 'type' => 'string', 'title' => '', 'example' => '2024-09-10 15:32:00'],
+ 'title' => ['description' => 'Title', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'url' => ['title' => 'url', 'description' => 'URL', 'type' => 'string', 'example' => 'http://xxx'],
],
+ 'example' => '',
],
- 'videoMindMappingGenerateResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'usage' => [
- 'description' => '',
+ 'example' => '',
+ ],
+ 'summary' => [
+ 'title' => '',
+ 'description' => 'Hot topic structured summary',
+ 'type' => 'object',
+ 'properties' => [
+ 'summaries' => [
+ 'title' => '',
+ 'description' => 'Structured summary list',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Structured summary',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'summary' => ['description' => 'Summary', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'title' => ['description' => 'Title', 'type' => 'string', 'title' => '', 'example' => 'xx'],
],
- ],
- 'videoMindMappings' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'childNodes' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'childNodes' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'modelReduce' => [
- 'title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'videoTitleGenerateResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
'example' => '',
],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelReduce' => [
- 'title' => 'modelReduce',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'videoShotSnapshotResult' => [
- 'type' => 'object',
- 'properties' => [
- 'videoShots' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'endTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'startTimeFormat' => [
- 'type' => 'string',
- ],
- 'endTimeFormat' => [
- 'type' => 'string',
- ],
- 'videoSnapshots' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'url' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'resultJsonFileUrl' => [
- 'title' => '全量结果文件地址:'."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
- .'当前包含的字段:'."\n"
- .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
- .'其他字段获取方式不变,文本方式返回。'."\n"
- .'文件类型:json'."\n"
- .'文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'type' => 'string',
- 'example' => 'http://',
- ],
- 'videoGenerateResults' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'type' => 'boolean',
- ],
- 'modelId' => [
- 'type' => 'string',
- ],
- 'index' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'text' => [
- 'type' => 'string',
- ],
- 'reasonText' => [
- 'type' => 'string',
- ],
- 'usage' => [
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'totalTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoRoleRecognitionResult' => [
- 'title' => '自动识别结果',
- 'type' => 'object',
- 'properties' => [
- 'videoRoles' => [
- 'title' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'type' => 'string',
- ],
- 'roleInfo' => [
- 'type' => 'string',
- ],
- 'timeIntervals' => [
- 'title' => '出场时间段',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'endTime' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timestamp' => [
- 'title' => '角色出现时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'url' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'ratio' => [
- 'title' => '出场率',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'isAutoRecognition' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoCalculatorResult' => [
- 'title' => '费用估算结果',
- 'type' => 'object',
- 'properties' => [
- 'items' => [
- 'title' => '计费项明细',
- 'type' => 'array',
- 'items' => [
- 'title' => '计费项明细',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '计费项名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'type' => [
- 'title' => '计费项类型',
- 'type' => 'string',
- ],
- 'inputToken' => [
- 'title' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputToken' => [
- 'title' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'time' => [
- 'title' => '计费时长',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'inputExpense' => [
- 'title' => '输入token价格',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'outputExpense' => [
- 'title' => '输出token价格',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'timeExpense' => [
- 'title' => '时间计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'totalExpense' => [
- 'title' => '总计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- ],
- ],
- ],
- ],
- ],
- 'addDatasetDocumentsResult' => [
- 'title' => '自动保存执行结果',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'title' => '自动保存任务状态:1 成功,0 失败',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'title' => [
- 'title' => '视频名称',
- 'type' => 'string',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '如果自动保存失败,则输出错误信息',
- 'type' => 'string',
- ],
- 'docUuid' => [
- 'title' => '视频的docUuid',
- 'type' => 'string',
- ],
+ 'example' => '',
],
],
+ 'example' => '',
],
+ 'textSummary' => ['description' => 'Hot topic text summarization', 'type' => 'string', 'title' => '', 'example' => 'xx'],
],
- 'usage' => [
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'totalTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
+ 'example' => '',
],
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
+ 'maxResults' => ['description' => 'Maximum number of returned results', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'],
+ 'message' => ['description' => 'Error description', 'type' => 'string', 'title' => '', 'example' => 'success'],
+ 'nextToken' => ['description' => 'Token for the next page', 'type' => 'string', 'title' => '', 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g=='],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'success' => ['description' => 'Is the request successful: true for success, false for failure', 'type' => 'boolean', 'title' => '', 'example' => 'True'],
+ 'totalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"xx\\",\\n \\"data\\": [\\n {\\n \\"category\\": \\"财经\\",\\n \\"hotTopic\\": \\"xx\\",\\n \\"hotTopicVersion\\": \\"2024-09-13_12\\",\\n \\"hotValue\\": 1000000,\\n \\"id\\": \\"db5dc5b3d8954a30b65ba700c9dda3bb\\",\\n \\"news\\": [\\n {\\n \\"comments\\": [\\n {\\n \\"text\\": \\"xx\\"\\n }\\n ],\\n \\"content\\": \\"xx\\",\\n \\"pubTime\\": \\"2024-09-10 15:32:00\\",\\n \\"title\\": \\"xx\\",\\n \\"url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"summary\\": {\\n \\"summaries\\": [\\n {\\n \\"summary\\": \\"xx\\",\\n \\"title\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"textSummary\\": \\"xx\\"\\n }\\n ],\\n \\"httpStatusCode\\": 200,\\n \\"maxResults\\": 20,\\n \\"message\\": \\"success\\",\\n \\"nextToken\\": \\"JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true,\\n \\"totalCount\\": 200\\n}","type":"json"}]',
+ 'title' => 'Query complete broadcast list (hot list)',
+ 'description' => 'This interface retrieves all content in the complete broadcast list (hot list), including channels, hot spots, hotness metrics, and broadcast summaries. By default, it returns the latest version of the broadcast list. To retrieve content from a specific system or custom version—for example, for a particular time period—specify the version parameter.'."\n"
+ ."\n"
+ .'Use the latest [**GetHotTopicBroadcast**](https://help.aliyun.com/zh/model-studio/user-guide/api-aimiaobi-2023-08-01-gethottopicbroadcast?spm=a2c4g.11186623.help-menu-2400256.d_1_3_3_2_0_3_11_2.773720a2vwX3bA\\&scm=20140722.H_2857057._.OR_help-T_cn~zh-V_1) interface instead. Its input and output parameters are more comprehensive.'."\n"
+ ."\n"
+ .'You can try this operation in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).'."\n"
+ ."\n"
+ .'To call the API using an SDK, refer to the Java and Python examples on the API tab in the console.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListHotTopicSummaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"InvalidParam\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-progress-start-generating\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"sessionId\\": \\"xxx\\",\\n \\"taskId\\": \\"xxx\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoAnalysisResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2,\\n \\"imageTokens\\": 20\\n },\\n \\"videoShotAnalysisResults\\": [\\n {\\n \\"endTime\\": 10000,\\n \\"startTime\\": 1000,\\n \\"text\\": \\"根据xxx\\"\\n }\\n ],\\n \\"modelId\\": \\"qwen-vl-max\\"\\n },\\n \\"videoCaptionResult\\": {\\n \\"generateFinished\\": true,\\n \\"videoCaptions\\": [\\n {\\n \\"endTime\\": 20000,\\n \\"endTimeFormat\\": \\"00:01\\",\\n \\"startTime\\": 1000,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"text\\": \\"xxx\\",\\n \\"speaker\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"videoGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelReduce\\": true,\\n \\"reasonText\\": \\"xxx\\",\\n \\"index\\": 1\\n },\\n \\"videoMindMappingGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"videoMindMappings\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"name\\": \\"三级\\"\\n }\\n ],\\n \\"name\\": \\"二级\\"\\n }\\n ],\\n \\"name\\": \\"一级\\"\\n }\\n ],\\n \\"modelId\\": \\"true\\",\\n \\"modelReduce\\": true\\n },\\n \\"videoTitleGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"标题\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelReduce\\": true\\n },\\n \\"videoShotSnapshotResult\\": {\\n \\"videoShots\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 0,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"endTimeFormat\\": \\"00:02\\",\\n \\"videoSnapshots\\": [\\n {\\n \\"url\\": \\"http://xxx\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"resultJsonFileUrl\\": \\"http://\\",\\n \\"videoGenerateResults\\": [\\n {\\n \\"generateFinished\\": true,\\n \\"modelId\\": \\"qwen-max-latest\\",\\n \\"index\\": 1,\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n }\\n ],\\n \\"videoRoleRecognitionResult\\": {\\n \\"videoRoles\\": [\\n {\\n \\"roleName\\": \\"test-role\\",\\n \\"roleInfo\\": \\"角色身份\\",\\n \\"timeIntervals\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 1735535279000,\\n \\"timestamp\\": 23333333,\\n \\"url\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qtgazV1oZ3djafcFz_!!6000000005238-0-tps-1540-1540.jpg\\"\\n }\\n ],\\n \\"ratio\\": 0.06,\\n \\"isAutoRecognition\\": true\\n }\\n ]\\n },\\n \\"videoCalculatorResult\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"xxx\\",\\n \\"type\\": \\"模型推理\\",\\n \\"inputToken\\": 123,\\n \\"outputToken\\": 13,\\n \\"time\\": 9,\\n \\"inputExpense\\": 0.234,\\n \\"outputExpense\\": 0.124,\\n \\"timeExpense\\": 0.02,\\n \\"totalExpense\\": 0.378\\n }\\n ]\\n },\\n \\"addDatasetDocumentsResult\\": {\\n \\"status\\": 1,\\n \\"title\\": \\"xxx\\",\\n \\"docId\\": \\"xxx\\",\\n \\"errorMessage\\": \\"xxx\\",\\n \\"docUuid\\": \\"uuid\\"\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
],
- 'SubmitVideoDetectShotTask' => [
- 'summary' => '轻应用-提交视频拆条任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitVideoDetectShotTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunEnterpriseVocAnalysis' => [
+ 'summary' => 'Analyzes the voice of the customer (VOC) for an enterprise.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runEnterpriseVocAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [How to obtain a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''],
],
[
- 'name' => 'videoUrl',
+ 'name' => 'taskDescription',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频的地址',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://xxx.mp4',
- ],
+ 'schema' => ['description' => 'The description of the task.', 'type' => 'string', 'required' => false, 'example' => '你是一名经验丰富的数据分析师,擅长从文本评论中提取结构化信息。你需要从用户评论列表中识别和提取出与以下四个维度相关的关键词和短语:'."\n"
+ .' '."\n"
+ .' 索引:输入评论JSON数组中的索引(从零开始)表示针对该条索引抽取的维度。'."\n"
+ .' 购买动机:描述用户购买产品的原因、需求或驱动力的关键词或短语。'."\n"
+ .' 未满足需求点:用户在使用产品过程中提到的未满足需求或问题的关键词或短语。'."\n"
+ .' 使用场景:用户提到的具体使用场景、使用方式或环境的关键词或短语。'."\n"
+ .' 正负面观点:明确表示用户对产品或服务的正面或负面看法的关键词或短语。', 'title' => ''],
],
[
'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm的模型,推荐选择deepseek-r1'."\n"
- .'可选项:'."\n"
- .'- qwen3-235b-a22b'."\n"
- .'- qwen3-235b-a22b-thinking'."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus,deepseek-r1'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-v3'."\n"
- .'- deepseek-v3.1',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-r1',
- ],
+ 'schema' => ['description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-max', 'title' => '', 'required' => false],
],
[
- 'name' => 'options',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户选择使用什么方式进行分镜,可选项:ASR',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'deduplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'llm用户自定义prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- [
- 'name' => 'originalSessionId',
+ 'name' => 'extraInfo',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['description' => 'Additional information, such as supplementary business information.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '额外信息'],
],
[
- 'name' => 'modelCustomPromptTemplateId',
+ 'name' => 'outputFormat',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm生成拆条结果prompt的ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotShowPrompt',
- ],
+ 'schema' => ['description' => 'The output format.', 'type' => 'string', 'example' => '按照如下格式输出:{"text1": "xxxx", "text2": "xxxx"}', 'title' => '', 'required' => false],
],
[
- 'name' => 'modelVlCustomPromptTemplateId',
+ 'name' => 'content',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl识别prompt的ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotVlShowPrompt',
- ],
+ 'schema' => ['description' => 'The content.', 'type' => 'string', 'example' => '这是一段需要分析的文本内容', 'title' => '', 'required' => false],
],
[
- 'name' => 'recognitionOptions',
+ 'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The business tag system.',
'type' => 'array',
'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
+ 'description' => 'A list of tag systems.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '标签名称', 'required' => false, 'title' => ''],
+ 'tagDefinePrompt' => ['description' => 'The prompt that defines the tag.', 'type' => 'string', 'example' => '标签定义提示词', 'required' => false, 'title' => ''],
+ ],
'required' => false,
- 'example' => 'ASR',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'intelliSimpPromptTemplateId',
+ 'name' => 'filterTags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '大语言模型前置简化promptId',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The filter tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '标签名称', 'required' => false, 'title' => ''],
+ 'tagDefinePrompt' => ['description' => 'The prompt that defines the tag.', 'type' => 'string', 'example' => '标签定义提示词', 'required' => false, 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'intelliSimpShowPrompt',
+ 'example' => '',
],
],
[
- 'name' => 'preModelId',
+ 'name' => 'apiKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '执行intelliSimpPrompt的模型,推荐选择deepseek-v3.1'."\n"
- .'可选项:'."\n"
- .'- qwen3-235b-a22b'."\n"
- .'- qwen3-235b-a22b-thinking'."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus,deepseek-r1'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-v3'."\n"
- .'- deepseek-v3.1',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-v3.1',
- ],
+ 'schema' => ['title' => 'Model Studio API key', 'description' => 'The API key for Alibaba Cloud Model Studio.', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxx'],
],
[
- 'name' => 'intelliSimpPrompt',
+ 'name' => 'akProxy',
'in' => 'formData',
- 'schema' => [
- 'title' => '简化输入给llm的数据的prompt(用户自定义)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'none', 'type' => 'string', 'required' => false, 'example' => 'none', 'title' => ''],
],
[
- 'name' => 'vlPrompt',
+ 'name' => 'sourceTrace',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl模型用户自定义prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => 'Whether to enable source tracing (custom output format is not supported when source tracing is enabled)', 'description' => 'Specifies whether to enable traceability. If you enable traceability, you cannot customize the outputFormat.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'language',
+ 'name' => 'positiveFilter',
'in' => 'formData',
- 'schema' => [
- 'title' => '语音识别语言:'."\n"
- ."\n"
- .'chinese:中文(默认)'."\n"
- .'french:法语'."\n"
- .'english:英语'."\n"
- .'japanese:日语'."\n"
- .'chineseEnglishFreely:中英文自由说'."\n"
- .'arabic:阿拉伯语'."\n"
- .'korean:韩语'."\n"
- .'malay:马来语'."\n"
- .'thai:泰语'."\n"
- .'portuguese:葡萄牙语'."\n"
- .'spanish:西班牙语'."\n"
- .'indonesian:印尼语'."\n"
- .'vietnamese:越南语',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chinese',
- ],
+ 'schema' => ['type' => 'boolean', 'title' => '', 'description' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'description' => '',
+ 'header' => [
+ 'title' => '',
+ 'description' => 'The message header.',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '22ec888712de45b39b97983f8d166831',
- ],
+ 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AccessForbidden', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error description.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
+ 'event' => ['description' => 'The event.', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'sessionId' => ['description' => 'The unique ID of the session.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'taskId' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'The unique ID for the entire call chain.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
],
+ 'example' => '',
],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true,\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"22ec888712de45b39b97983f8d166831\\"\\n }\\n}","type":"json"}]',
- ],
- 'GetVideoDetectShotTask' => [
- 'summary' => '轻应用-获取视频拆条异步任务结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getVideoDetectShotTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'data' => [
- 'description' => '',
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'The message body.',
'type' => 'object',
'properties' => [
- 'header' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'',
- ],
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TIMEOUT_CLOSE_ORDER',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd5c38cf6-a4bf-4a57-a697-9f449926f0c9',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6e223291-729b-4e84-9271-c13ada1a776b',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '215045f817272303448235204efdef',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '',
+ 'output' => [
+ 'title' => '',
+ 'description' => 'The output result.',
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '',
+ 'text' => ['description' => 'The output summary text.', 'type' => 'string', 'title' => '', 'example' => '输出摘要文本'."\n"
+ ."\n"],
+ 'filterResult' => [
+ 'title' => '',
+ 'description' => 'The filter result.',
'type' => 'object',
'properties' => [
- 'videoSplitResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '拆条结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'reasonText' => [
- 'title' => '深度思考结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'videoParts' => [
- 'title' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'xxx',
- 'description' => 'xxx',
- ],
- ],
- ],
- 'videoRecognitionResult' => [
- 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '当前识别结果的开始时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1758108425000',
- ],
- 'endTime' => [
- 'title' => '当前识别结果的结束时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1748483740000',
- ],
- 'asr' => [
- 'title' => '音频转文字的结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ocr' => [
- 'title' => '画面中的文字内容识别结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'vl' => [
- 'title' => '画面内容识别结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
+ 'filterResults' => [
+ 'title' => '',
+ 'description' => 'A list of filter results.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'The tag that is hit by the filter.', 'type' => 'string', 'title' => '', 'example' => '过滤标签命中的标签'],
+ 'tagValue' => ['description' => 'The hit value (Yes or No).', 'type' => 'string', 'title' => '', 'example' => '是'],
+ 'hit' => ['description' => 'Indicates whether the tag is hit.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '36',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '49',
- ],
- ],
- ],
+ 'reasonContent' => ['title' => 'Reasoning content returned by the reasoning model', 'description' => 'The inference content returned by the reasoning model.', 'type' => 'string', 'example' => ''],
],
+ 'example' => '',
],
- 'taskRunInfo' => [
- 'title' => '运行信息',
- 'description' => '',
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'The token consumption.',
'type' => 'object',
'properties' => [
- 'concurrentChargeEnable' => [
- 'title' => '是否使用付给并发:true时,按照实际运行时长计量',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'responseTime' => [
- 'title' => '运行时长:rt',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
],
- ],
- 'taskStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.',
+ 'example' => '',
],
],
+ 'example' => '',
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '49483FFC-0CB9-5163-8D3E-234E276E6DA8'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"successful\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"header\\": {\\n \\"errorCode\\": \\"success\\",\\n \\"errorMessage\\": \\"Deduct task already success,Please do not resubmit.token \'369e8f2c-d283-424a-96c4-c83efe08c89e\'\\",\\n \\"event\\": \\"TIMEOUT_CLOSE_ORDER\\",\\n \\"eventInfo\\": \\"xxx\\",\\n \\"sessionId\\": \\"d5c38cf6-a4bf-4a57-a697-9f449926f0c9\\",\\n \\"taskId\\": \\"6e223291-729b-4e84-9271-c13ada1a776b\\",\\n \\"traceId\\": \\"215045f817272303448235204efdef\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoSplitResult\\": {\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"videoParts\\": [\\n {\\n \\"key\\": \\"xxx\\"\\n }\\n ],\\n \\"videoRecognitionResult\\": [\\n {\\n \\"startTime\\": 1758108425000,\\n \\"endTime\\": 1748483740000,\\n \\"asr\\": \\"xxx\\",\\n \\"ocr\\": \\"xxx\\",\\n \\"vl\\": \\"xxx\\"\\n }\\n ]\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 36,\\n \\"outputTokens\\": 13,\\n \\"totalTokens\\": 49\\n }\\n },\\n \\"taskRunInfo\\": {\\n \\"concurrentChargeEnable\\": true,\\n \\"responseTime\\": 1000\\n },\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"errorMessage\\": \\"Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.\\"\\n }\\n}","type":"json"}]',
- ],
- 'UpdateVideoDetectShotTask' => [
- 'summary' => '视频拆条-修改任务状态',
- 'path' => '/{workspaceId}/quanmiao/lightapp/updateVideoDetectShotTask',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'taskStatus',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '575D5893-01DB-5C81-A899-74F67616762A',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '任务信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'taskStatus' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'taskErrorMessage' => [
- 'title' => '任务失败信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"575D5893-01DB-5C81-A899-74F67616762A\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"successful\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskErrorMessage\\": \\"xx\\"\\n }\\n}","type":"json"}]',
- ],
- 'UpdateVideoDetectShotConfig' => [
- 'summary' => '智能拆条-更新配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoDetectShotConfig',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Online Enterprise VOC Analysis',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-04-17T11:51:14.000Z', 'description' => 'Request parameters changed'],
],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'asyncConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '视频理解-离线任务并发数,取值范围[2, 10]',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEnterpriseVocAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"输出摘要文本\\\\n\\\\n\\",\\n \\"filterResult\\": {\\n \\"filterResults\\": [\\n {\\n \\"tagName\\": \\"过滤标签命中的标签\\",\\n \\"tagValue\\": \\"是\\",\\n \\"hit\\": true\\n }\\n ]\\n },\\n \\"reasonContent\\": \\"\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"49483FFC-0CB9-5163-8D3E-234E276E6DA8\\"\\n}","type":"json"}]',
],
- 'GetVideoDetectShotConfig' => [
- 'summary' => '智能拆条-获取配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoDetectShotConfig',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunEssayCorrection' => [
+ 'summary' => 'Assignment Grading',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runEssayCorrection',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => 'The [workspace](~~2782167~~) ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxxxxx', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'code' => [
- 'title' => 'code',
- 'description' => 'code',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'message' => [
- 'title' => '信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'msg',
- ],
- 'success' => [
- 'title' => 'success',
- 'description' => 'success',
- 'type' => 'boolean',
- ],
- 'httpStatusCode' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '异步任务并发数',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'asyncConcurrency' => [
- 'title' => '异步任务并发数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxx\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"msg\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"asyncConcurrency\\": 2\\n }\\n}","type":"json"}]',
- ],
- 'RunVideoDetectShot' => [
- 'summary' => '轻应用-视频拆条',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoDetectShot',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxxxx',
- ],
- ],
- [
- 'name' => 'videoUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '视频的地址',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://xxx.mp4',
- ],
- ],
- [
- 'name' => 'modelId',
+ 'name' => 'grade',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm的模型,推荐选择deepseek-r1'."\n"
- .'可选项:'."\n"
- .'- qwen3-235b-a22b'."\n"
- .'- qwen3-235b-a22b-thinking'."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus,deepseek-r1'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-v3'."\n"
- .'- deepseek-v3.1',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-r1',
- ],
+ 'schema' => ['description' => 'The grade level.', 'type' => 'string', 'example' => '初中一年级', 'title' => '', 'required' => false],
],
[
- 'name' => 'options',
+ 'name' => 'subject',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户选择使用什么方式进行分镜,可选项:ASR',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'The academic subject.', 'type' => 'string', 'example' => '语文', 'title' => '', 'required' => false],
],
[
- 'name' => 'taskId',
+ 'name' => 'totalScore',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => 'The total score for the essay.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false],
],
[
- 'name' => 'originalSessionId',
+ 'name' => 'question',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['description' => 'The question or prompt for the essay. This parameter cannot be empty.', 'type' => 'string', 'example' => 'xx', 'title' => '', 'required' => false],
],
[
- 'name' => 'prompt',
+ 'name' => 'answer',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm用户自定义prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'The student\'s answer or essay.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
],
[
- 'name' => 'modelCustomPromptTemplateId',
+ 'name' => 'otherReviewPoints',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm生成拆条结果prompt的ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotShowPrompt',
- ],
+ 'schema' => ['description' => 'Additional instructions for the review.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
],
[
- 'name' => 'modelVlCustomPromptTemplateId',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl识别prompt的ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotVlShowPrompt',
- ],
- ],
- [
- 'name' => 'recognitionOptions',
+ 'schema' => ['title' => 'Model ID', 'description' => 'The ID of the model to use. If omitted, the system defaults to the Qwen 3 Homework-Enhanced model (`qwen3-32b-offline-202506171456-fb65`). Available models:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "ModelName": "Qwen 3 Homework-Enhanced Model",'."\n"
+ .' "ModelId": "qwen3-32b-offline-202506171456-fb65"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "Qwen Correction Fine-tuned Model",'."\n"
+ .' "ModelId": "qwen-correction-v2"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "Qwen Custom Correction Model",'."\n"
+ .' "ModelId": "qwen-custom-correction-v1"'."\n"
+ .' }'."\n"
+ .']'."\n"
+ .'```', 'type' => 'string', 'example' => 'qwen-correction-v1', 'required' => false],
+ ],
+ [
+ 'name' => 'dimensions',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
- 'description' => '',
'type' => 'array',
'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the custom scoring dimension.', 'type' => 'string', 'example' => '内容完整度', 'title' => '', 'required' => false],
+ 'rubric' => ['description' => 'The detailed scoring criteria for the dimension.', 'type' => 'string', 'example' => '文章内容是否完整,是否涵盖了题目的核心要求', 'title' => '', 'required' => false],
+ 'maxScore' => ['description' => 'The maximum score for the dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => '', 'required' => false],
+ ],
+ 'title' => '',
+ 'description' => 'A custom scoring dimension.',
'required' => false,
- 'example' => 'ASR',
+ 'example' => '',
],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'intelliSimpPromptTemplateId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '大语言模型前置简化promptId',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'intelliSimpShowPrompt',
- ],
- ],
- [
- 'name' => 'preModelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '执行intelliSimpPrompt的模型,推荐选择deepseek-v3.1'."\n"
- .'可选项:'."\n"
- .'- qwen3-235b-a22b'."\n"
- .'- qwen3-235b-a22b-thinking'."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus,deepseek-r1'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-v3'."\n"
- .'- deepseek-v3.1',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-v3.1',
- ],
- ],
- [
- 'name' => 'intelliSimpPrompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '简化输入给llm的数据的prompt(用户自定义)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'vlPrompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户自定义的vl识别prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'language',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '语音识别语言:'."\n"
- ."\n"
- .'chinese:中文(默认)'."\n"
- .'french:法语'."\n"
- .'english:英语'."\n"
- .'japanese:日语'."\n"
- .'chineseEnglishFreely:中英文自由说'."\n"
- .'arabic:阿拉伯语'."\n"
- .'korean:韩语'."\n"
- .'malay:马来语'."\n"
- .'thai:泰语'."\n"
- .'portuguese:葡萄牙语'."\n"
- .'spanish:西班牙语'."\n"
- .'indonesian:印尼语'."\n"
- .'vietnamese:越南语',
- 'description' => '',
- 'type' => 'string',
+ 'example' => '[{"name": "内容完整度", "rubric": "文章内容是否完整,是否涵盖了题目的核心要求", "maxScore": 30}]',
+ 'title' => '',
+ 'description' => 'A list of custom scoring dimensions. This is only supported by the `qwen-custom-correction-v1` model.',
'required' => false,
- 'example' => 'chinese',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
'header' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response header.',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidParam',
- ],
- 'errorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Pop sign mismatch, please check log.',
- ],
- 'event' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'eventInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '14d15c78c4c34d428212f4d923d4ede1',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3b5287b317477940746851672dca0c',
- ],
+ 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AccessForbidden', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
+ 'event' => ['description' => 'The event.', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'The trace ID for the request.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
],
+ 'example' => '',
],
'payload' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response payload.',
'type' => 'object',
'properties' => [
'output' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The output of the request.',
'type' => 'object',
'properties' => [
- 'videoSplitResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '拆条结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'reasonText' => [
- 'title' => '深度思考结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'videoParts' => [
- 'title' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'xxx',
- 'example' => 'xxx',
- ],
- ],
- ],
- 'videoRecognitionResult' => [
- 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '当前识别结果的开始时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1756433675000',
- ],
- 'endTime' => [
- 'title' => '当前识别结果的结束时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1755742611000',
- ],
- 'asr' => [
- 'title' => '音频转文字的结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ocr' => [
- 'title' => '画面中的文字内容识别结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'vl' => [
- 'title' => '画面内容识别结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
+ 'text' => ['description' => 'The text content of the review.', 'type' => 'string', 'example' => '审阅结果'."\n"
+ ."\n", 'title' => ''],
+ 'reasoningContent' => ['description' => 'The model\'s reasoning process.', 'type' => 'string', 'example' => '首先分析文章结构,发现开头、正文、结尾完整...', 'title' => ''],
+ 'score' => ['description' => 'The overall score for the essay review.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'dimensionResults' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the dimension.', 'type' => 'string', 'example' => '内容完整度', 'title' => ''],
+ 'analysis' => ['description' => 'An analysis of the strengths and weaknesses in this dimension.', 'type' => 'string', 'example' => '文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。', 'title' => ''],
+ 'score' => ['description' => 'The score for this dimension.', 'type' => 'number', 'format' => 'double', 'example' => '25.5', 'title' => ''],
+ 'maxScore' => ['description' => 'The maximum possible score for this dimension.', 'type' => 'number', 'format' => 'double', 'example' => '30', 'title' => ''],
],
+ 'description' => 'The scoring details for a single dimension.',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => 'The scores for each dimension. This field is returned only in custom dimension mode.',
+ 'title' => '',
+ 'example' => '',
],
+ 'overallComment' => ['description' => 'An overall comment on the essay.', 'type' => 'string', 'example' => '整体表现良好,建议在论述深度上进一步加强。', 'title' => ''],
],
+ 'example' => '',
],
'usage' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The token usage for the request.',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4546',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '820',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5366',
- ],
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '58868FD6-53D7-5ACD-80F7-854C8EA256EF',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"审阅结果\\\\n\\\\n\\",\\n \\"reasoningContent\\": \\"首先分析文章结构,发现开头、正文、结尾完整...\\",\\n \\"score\\": 50,\\n \\"dimensionResults\\": [\\n {\\n \\"name\\": \\"内容完整度\\",\\n \\"analysis\\": \\"文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。\\",\\n \\"score\\": 25.5,\\n \\"maxScore\\": 30\\n }\\n ],\\n \\"overallComment\\": \\"整体表现良好,建议在论述深度上进一步加强。\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
+ 'title' => 'Essay Grading',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-02T05:52:12.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEssayCorrection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"InvalidParam\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-finished\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"sessionId\\": \\"14d15c78c4c34d428212f4d923d4ede1\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"3b5287b317477940746851672dca0c\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoSplitResult\\": {\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"videoParts\\": [\\n {\\n \\"key\\": \\"xxx\\"\\n }\\n ],\\n \\"videoRecognitionResult\\": [\\n {\\n \\"startTime\\": 1756433675000,\\n \\"endTime\\": 1755742611000,\\n \\"asr\\": \\"xxx\\",\\n \\"ocr\\": \\"xxx\\",\\n \\"vl\\": \\"xxx\\"\\n }\\n ]\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 4546,\\n \\"outputTokens\\": 820,\\n \\"totalTokens\\": 5366\\n }\\n },\\n \\"requestId\\": \\"58868FD6-53D7-5ACD-80F7-854C8EA256EF\\"\\n}","type":"json"}]',
],
'RunHotTopicChat' => [
- 'summary' => '轻应用-热点播报-问答',
+ 'summary' => 'Alibaba Cloud Model Studio lightweight application — Enables in-vehicle systems and content platforms to interact with news hot topics — Broadcast list (hot topics) Q&A: Ask questions about broadcast lists, news, and open-domain content.',
'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicChat',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace: [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''],
],
[
'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['description' => 'Data model ID. Default: qwen-max-latest', 'type' => 'string', 'required' => false, 'example' => 'qwen-max-latest', 'title' => ''],
],
[
'name' => 'modelCustomPromptTemplate',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => 'Prompt template', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
],
[
'name' => 'generateOptions',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '生成模式列表:默认textChatGenerate',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of generation modes. Default: textChatGenerate',
'type' => 'array',
- 'items' => [
- 'title' => '生成模式:'."\n"
- .'- categoryRecommend:频道热点推荐'."\n"
- .'- textChatGenerate:问答(默认)'."\n"
- .'- internetSearch:互联网搜索'."\n"
- .'- queryRecommend:query推荐',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'textChatGenerate',
- ],
+ 'items' => ['description' => 'Generation mode: summaryChatGenerate, newsChatGenerate, or options from step three in the console. Use them directly. For other use cases, combine as needed:'."\n"
+ ."\n"
+ .'- Predefined capability combinations: Atomic capabilities + search sources'."\n"
+ ."\n"
+ .' - summaryChatGenerate — Answers only from information already in the aggregated news broadcast list. Includes categoryRecommend, hotTopicSummarySearch, and textChatGenerate.'."\n"
+ ."\n"
+ .' - newsChatGenerate — Answers after searching original news material and the open Internet. Includes hotTopicNewsSearch, internetSearch, and textChatGenerate.'."\n"
+ ."\n"
+ .'- Atomic capabilities:'."\n"
+ ."\n"
+ .' - categoryRecommend — Recommend hot topics by channel. Example: “Recommend sports news.”'."\n"
+ ."\n"
+ .' - textChatGenerate — Answer questions. When used alone, you must specify a source: internetSearch, hotTopicSummarySearch, or hotTopicNewsSearch. Example: “When did the XXX event happen?”'."\n"
+ ."\n"
+ .' - queryRecommend — Enable query recommendations. Returns results separately.'."\n"
+ ."\n"
+ .'- Search sources:'."\n"
+ ."\n"
+ .' - hotTopicSummarySearch — Search source for hot topic summaries'."\n"
+ ."\n"
+ .' - hotTopicNewsSearch — Search source for hot topic news details'."\n"
+ ."\n"
+ .' - internetSearch — Search source for general Internet content', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'newsChatGenerate'],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '对话任务唯一标识:多轮时,这个值保持不变',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => 'Unique identifier for the conversation task. Keep this value unchanged across multiple turns.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
'name' => 'originalSessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '原始会话唯一标识:重试场景',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['description' => 'Unique identifier for the original session. Used for retries.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax'],
],
[
'name' => 'prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户问题',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'User question', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '帮我播报体育热点'],
],
[
'name' => 'hotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-09-13_12',
- ],
+ 'schema' => ['description' => 'Hot topic version', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-09-13_12'],
],
[
'name' => 'category',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜中平道',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Hot topic channel', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '体育'],
],
[
'name' => 'hotTopics',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '热点名称列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of hot topic names',
'type' => 'array',
- 'items' => [
- 'title' => '热点标题名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'items' => ['description' => 'Hot topic title', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'imageCount',
'in' => 'formData',
- 'schema' => [
- 'title' => '配图张数:不一定都有图',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Number of images. Not all responses include images. Valid values: 1–3.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'stepForBroadcastContentConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '新闻播报内容配置:仅Saas用,Paas调用建议走hotTopicVersion',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'News broadcast content configuration. For SaaS only. PaaS users should use hotTopicVersion instead.',
'type' => 'object',
'properties' => [
'categories' => [
- 'title' => '选择的频道列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of selected channels',
'type' => 'array',
- 'items' => [
- 'title' => '频道',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'items' => ['description' => 'Channel', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '体育'],
'required' => false,
+ 'example' => '',
],
'customHotValueWeights' => [
- 'title' => '热度计算维度',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Dimensions for calculating hotness. If omitted, default weights apply.',
'type' => 'array',
'items' => [
- 'title' => '热度计算维度列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of hotness calculation dimensions',
'type' => 'object',
'properties' => [
- 'dimension' => [
- 'title' => '权重维度唯一标识:'."\n"
- .'- views("阅读量")'."\n"
- .'- comments("评论量")'."\n"
- .'- ups("点赞数")'."\n"
- .'- downs("点踩数")'."\n"
- .'- publishTime("发布时间")',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'comments',
- ],
- 'weight' => [
- 'title' => '权重,0-10之间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'dimension' => ['description' => 'Unique identifier for the weight dimension:'."\n"
+ ."\n"
+ .'- views (page views)'."\n"
+ ."\n"
+ .'- comments (number of comments)'."\n"
+ ."\n"
+ .'- ups (likes)'."\n"
+ ."\n"
+ .'- downs (dislikes)'."\n"
+ ."\n"
+ .'- publishTime (publish time)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'comments'],
+ 'weight' => ['description' => 'Weight value. Range: 0–10.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
],
'required' => false,
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
- 'topicCount' => [
- 'title' => '话题数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'topicCount' => ['description' => 'Number of topics', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'],
],
'required' => false,
+ 'example' => '',
],
],
[
@@ -6216,29 +2992,23 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '上下文',
+ 'description' => 'Context',
+ 'title' => 'Context',
'type' => 'array',
'items' => [
- 'title' => '角色:user、assistant、system',
+ 'description' => 'Role: user, assistant, or system',
+ 'title' => 'Role: user, assistant, system',
'type' => 'object',
'properties' => [
- 'role' => [
- 'title' => '内容',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'content' => [
- 'title' => '发生时间',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'createTime' => [
- 'title' => '时间',
- 'type' => 'string',
- 'example' => '2024-12-10 18:51:29',
- ],
+ 'role' => ['title' => 'Content', 'description' => 'Content', 'type' => 'string', 'example' => 'user', 'required' => false],
+ 'content' => ['title' => 'Occurrence time', 'description' => 'Timestamp', 'type' => 'string', 'example' => 'xxx', 'required' => false],
+ 'createTime' => ['title' => 'Time', 'description' => 'Time', 'type' => 'string', 'example' => '2024-12-10 18:51:29', 'required' => false],
],
+ 'required' => false,
+ 'example' => '',
],
+ 'required' => false,
+ 'example' => '',
],
],
],
@@ -6246,396 +3016,274 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message header',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidParam',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'event' => [
- 'title' => '时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'eventInfo' => [
- 'title' => '时间信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => 'InvalidParam'],
+ 'errorMessage' => ['description' => 'A description of the error.', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'event' => ['description' => 'Event', 'type' => 'string', 'title' => '', 'example' => 'task-finished'],
+ 'eventInfo' => ['description' => 'Event description', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'sessionId' => ['description' => 'Unique identifier for the session', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'taskId' => ['description' => 'Unique identifier for the task', 'type' => 'string', 'title' => '', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['description' => 'Unique identifier for the full trace', 'type' => 'string', 'title' => '', 'example' => '2150451a17191950923411783e2927'],
],
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message body',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Output result',
'type' => 'object',
'properties' => [
'articles' => [
- 'title' => '参照内容列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of reference content',
'type' => 'array',
'items' => [
- 'title' => '内容列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Content list',
'type' => 'object',
'properties' => [
- 'content' => [
- 'title' => '正文',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'pubTime' => [
- 'title' => '发布时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-22 16:45:06',
- ],
- 'score' => [
- 'title' => '相关度',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'searchSourceName' => [
- 'title' => '文章来源名称',
- 'type' => 'string',
- ],
- 'select' => [
- 'title' => '是否参照',
- 'type' => 'boolean',
- ],
- 'summary' => [
- 'title' => '摘要',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'title' => [
- 'title' => '标题',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'url' => [
- 'title' => '链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
+ 'content' => ['description' => 'Main content', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'pubTime' => ['description' => 'Publish time', 'type' => 'string', 'title' => '', 'example' => '2024-09-22 16:45:06'],
+ 'score' => ['title' => 'Relevance degree', 'description' => 'Relevance score', 'type' => 'number', 'format' => 'double', 'example' => '0.8'],
+ 'searchSourceName' => ['title' => '[responses_200_schema_properties_payload_properties_output_properties_hotTopicSummaries_items_properties_news_description]News List ', 'description' => 'Source name', 'type' => 'string', 'example' => '互联网'],
+ 'select' => ['title' => 'Is referenced', 'description' => 'Whether referenced', 'type' => 'boolean', 'example' => 'true'],
+ 'summary' => ['description' => 'Summary', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'title' => ['description' => 'Title', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'url' => ['description' => 'URL', 'type' => 'string', 'title' => '', 'example' => 'http://xxx'],
],
+ 'example' => '',
],
+ 'example' => '',
],
'hotTopicSummaries' => [
- 'title' => '热点列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of hot topics',
'type' => 'array',
'items' => [
- 'title' => '热点',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Hot topic',
'type' => 'object',
'properties' => [
- 'customHotValue' => [
- 'title' => '自定义热度值',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100000',
- ],
- 'hotTopic' => [
- 'title' => '热点话题名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'hotTopicVersion' => [
- 'title' => '热点话题摘要版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-13_08',
- ],
- 'hotValue' => [
- 'title' => '热度值',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100000',
- ],
- 'textSummary' => [
- 'title' => '热点话题文本摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'customTextSummary' => [
- 'title' => '自定义热点话题文本摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'customHotValue' => ['description' => 'Custom hotness value', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100000'],
+ 'hotTopic' => ['description' => 'Hot topic name', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'hotTopicVersion' => ['description' => 'Hot topic summary version', 'type' => 'string', 'title' => '', 'example' => '2024-09-13_08'],
+ 'hotValue' => ['description' => 'Hotness value', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100000'],
+ 'textSummary' => ['title' => 'Hot topic summarization', 'description' => 'Text summary of the hot topic', 'type' => 'string', 'example' => 'xxx'],
+ 'customTextSummary' => ['title' => 'Custom hot topic text summarization ', 'description' => 'Custom text summary of the hot topic', 'type' => 'string', 'example' => 'xxx'],
'news' => [
- 'title' => '新闻列表',
+ 'description' => 'News list',
+ 'title' => 'News List ',
'type' => 'array',
'items' => [
- 'title' => '新闻',
+ 'description' => 'News item',
+ 'title' => 'News ',
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '标题',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'url' => [
- 'title' => 'url',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
+ 'title' => ['title' => 'Title ', 'description' => 'Title', 'type' => 'string', 'example' => 'xxx'],
+ 'url' => ['title' => 'URL', 'description' => 'URL', 'type' => 'string', 'example' => 'http://xxx'],
],
+ 'example' => '',
],
+ 'example' => '',
],
'images' => [
- 'title' => '图片列表',
+ 'description' => 'Image list',
+ 'title' => 'Image list',
'type' => 'array',
'items' => [
- 'title' => '图片',
+ 'description' => 'Image',
+ 'title' => 'Image',
'type' => 'object',
'properties' => [
- 'url' => [
- 'title' => '图片',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
+ 'url' => ['title' => 'Image', 'description' => 'Image', 'type' => 'string', 'example' => 'http://www.example.com/xxx.png'],
],
+ 'example' => '',
],
+ 'example' => '',
],
- 'url' => [
- 'title' => '热点话题的URL',
- 'type' => 'string',
- ],
- 'pubTime' => [
- 'title' => '热点话题发布时间',
- 'type' => 'string',
- ],
+ 'url' => ['title' => 'URL of the hot topic', 'description' => 'Hot topic URL', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'],
+ 'pubTime' => ['title' => 'Hot topic published at ', 'description' => 'Hot topic publish time', 'type' => 'string', 'example' => '2025-05-20 12:00:00'],
],
+ 'example' => '',
],
+ 'example' => '',
],
'multimodalMedias' => [
- 'title' => '配图',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Supplementary images',
'type' => 'array',
'items' => [
- 'title' => '配图',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Supplementary image',
'type' => 'object',
'properties' => [
- 'fileUrl' => [
- 'title' => '链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://xxxx',
- ],
- 'mediaType' => [
- 'title' => '类型:'."\n"
- .'- image:图片',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'sortScore' => [
- 'title' => '相关度',
- 'type' => 'number',
- 'format' => 'double',
- ],
+ 'fileUrl' => ['description' => 'URL', 'type' => 'string', 'title' => '', 'example' => 'http://xxxx'],
+ 'mediaType' => ['description' => 'Type:'."\n"
+ ."\n"
+ .'- image — Image', 'type' => 'string', 'title' => '', 'example' => 'image'],
+ 'sortScore' => ['title' => 'Relevance degree', 'description' => 'Relevance score', 'type' => 'number', 'format' => 'double', 'example' => '0.8'],
],
+ 'example' => '',
],
+ 'example' => '',
],
'recommendQueries' => [
- 'title' => '推荐query列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of recommended queries',
'type' => 'array',
- 'items' => [
- 'title' => '推荐query',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- 'searchQuery' => [
- 'title' => '改写后query',
- 'type' => 'string',
- ],
- 'text' => [
- 'title' => '生成正文:答案等',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'category' => [
- 'title' => '新闻播报场景的领域识别(时政、社会、国际等频道识别)',
- 'type' => 'string',
- ],
- 'keyword' => [
- 'title' => '新闻播报场景的关键字识别',
- 'type' => 'string',
- ],
- 'location' => [
- 'title' => '新闻播报场景的地点名识别',
- 'type' => 'string',
+ 'items' => ['description' => 'Recommended query', 'type' => 'string', 'title' => '', 'example' => '关于xx你有什么看法?'],
+ 'example' => '',
],
+ 'searchQuery' => ['title' => 'Rewritten query ', 'description' => 'Rewritten query', 'type' => 'string', 'example' => 'xxx'],
+ 'text' => ['description' => 'Generated content, such as answers', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'category' => ['title' => 'Domain detection for news broadcasting scenarios (such as politics, society, international channels)', 'description' => 'Domain identification for news broadcasts (e.g., politics, society, international)', 'type' => 'string', 'example' => '国际'],
+ 'keyword' => ['title' => 'Keyword detection for news broadcasting scenarios', 'description' => 'Keyword identification for news broadcasts', 'type' => 'string', 'example' => 'AI'],
+ 'location' => ['title' => 'Location name detection in news broadcasting scenarios', 'description' => 'Location identification for news broadcasts', 'type' => 'string', 'example' => '杭州'],
],
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Token usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'Input tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'Output tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'Total tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"InvalidParam\\",\\n \\"errorMessage\\": \\"xx\\",\\n \\"event\\": \\"task-finished\\",\\n \\"eventInfo\\": \\"xx\\",\\n \\"sessionId\\": \\"xxx\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"articles\\": [\\n {\\n \\"content\\": \\"xxx\\",\\n \\"pubTime\\": \\"2024-09-22 16:45:06\\",\\n \\"score\\": 0.8,\\n \\"searchSourceName\\": \\"互联网\\",\\n \\"select\\": true,\\n \\"summary\\": \\"xx\\",\\n \\"title\\": \\"test\\",\\n \\"url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"hotTopicSummaries\\": [\\n {\\n \\"customHotValue\\": 100000,\\n \\"hotTopic\\": \\"xx\\",\\n \\"hotTopicVersion\\": \\"2024-09-13_08\\",\\n \\"hotValue\\": 100000,\\n \\"textSummary\\": \\"xxx\\",\\n \\"customTextSummary\\": \\"xxx\\",\\n \\"news\\": [\\n {\\n \\"title\\": \\"xxx\\",\\n \\"url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"images\\": [\\n {\\n \\"url\\": \\"http://www.example.com/xxx.png\\"\\n }\\n ],\\n \\"url\\": \\"http://www.example.com/xxx.html\\",\\n \\"pubTime\\": \\"2025-05-20 12:00:00\\"\\n }\\n ],\\n \\"multimodalMedias\\": [\\n {\\n \\"fileUrl\\": \\"http://xxxx\\",\\n \\"mediaType\\": \\"image\\",\\n \\"sortScore\\": 0.8\\n }\\n ],\\n \\"recommendQueries\\": [\\n \\"关于xx你有什么看法?\\"\\n ],\\n \\"searchQuery\\": \\"xxx\\",\\n \\"text\\": \\"xx\\",\\n \\"category\\": \\"国际\\",\\n \\"keyword\\": \\"AI\\",\\n \\"location\\": \\"杭州\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8\\"\\n}","type":"json"}]',
+ 'title' => 'Q&A pair for broadcast item (hot topic)',
+ 'description' => '## About the RunHotTopicChat API'."\n"
+ ."\n"
+ .'Use this API to ask questions about broadcast lists (hot topics), hot topic news, and open-domain content. It supports channel recommendations, hot topic recommendations, and hot topic content Q\\&A.'."\n"
+ ."\n"
+ .'Try it in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).'."\n"
+ ."\n"
+ .'**To call this API using an SDK, see the Java and Python examples on the API tab in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).**'."\n"
+ ."\n"
+ .'**To call this API with an SDK, see the Java and Python examples on the API tab in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).**'."\n"
+ ."\n"
+ .'**To call this API using an SDK, see the Java and Python examples on the API tab in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast).**'."\n"
+ ."\n"
+ .'## Full API reference for news hot topic interaction'."\n"
+ ."\n"
+ .'### API list'."\n"
+ ."\n"
+ .'#### In the AI Miaobi SDK: alibabacloud-aimiaobi20230801'."\n"
+ ."\n"
+ .'- [**GetHotTopicBroadcast**](https://help.aliyun.com/zh/model-studio/user-guide/api-aimiaobi-2023-08-01-gethottopicbroadcast?spm=a2c4g.11186623.help-menu-search-2400256.d_0) — **Retrieve a full broadcast list (hot topics)** — Commonly used'."\n"
+ ."\n"
+ .'- [SubmitCustomHotTopicBroadcastJob](https://help.aliyun.com/zh/model-studio/user-guide/api-aimiaobi-2023-08-01-submitcustomhottopicbroadcastjob?spm=a2c4g.11186623.help-menu-2400256.d_1_3_3_2_0_3_11_1.6e8226ccRBFaYz) — Submit a custom broadcast list job'."\n"
+ ."\n"
+ .'- [GetCustomHotTopicBroadcastJob](https://help.aliyun.com/zh/model-studio/user-guide/api-aimiaobi-2023-08-01-getcustomhottopicbroadcastjob?spm=a2c4g.11186623.help-menu-2400256.d_1_3_3_2_0_3_11_0.fd006c4cdnYwwj) — Retrieve the result of a custom broadcast list job'."\n"
+ ."\n"
+ .'#### In the Alibaba Cloud Model Studio Quanmiao Lightweight Application SDK: alibabacloud-quanmiaolightapp20240801'."\n"
+ ."\n"
+ .'- **RunHotTopicChat** — **Q\\&A for broadcast lists (hot topics)** — Commonly used'."\n"
+ ."\n"
+ .'- [RunHotTopicSummary](https://help.aliyun.com/zh/model-studio/user-guide/api-quanmiaolightapp-2024-08-01-runhottopicsummary?spm=a2c4g.11186623.help-menu-2400256.d_1_3_4_3_1_3_4_1.420a7c48CBWA8o) — Generate a custom summary for a broadcast list hot topic'."\n"
+ ."\n"
+ .'### Use cases'."\n"
+ ."\n"
+ .'#### Use case 1: Retrieve all or selected channel hot topics from a full broadcast list (hot topics)'."\n"
+ ."\n"
+ .'- GetHotTopicBroadcast — Retrieve a broadcast list'."\n"
+ ."\n"
+ .'#### Use case 2: Ask questions about a broadcast list or general topics'."\n"
+ ."\n"
+ .'- RunHotTopicChat — Ask questions'."\n"
+ ."\n"
+ .'#### Use case 3: Customize a broadcast list (channels, custom summaries, etc.) when the built-in broadcast list (hot topics) does not meet your needs'."\n"
+ ."\n"
+ .'- SubmitCustomHotTopicBroadcastJob — Submit a custom broadcast list job'."\n"
+ ."\n"
+ .'- GetCustomHotTopicBroadcastJob — Poll the status of a custom broadcast list job'."\n"
+ ."\n"
+ .'- GetHotTopicBroadcast — Retrieve details of a custom broadcast list',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T11:27:41.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-11T12:52:13.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-12-03T13:08:10.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-03T03:26:38.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'RunHotTopicSummary' => [
- 'summary' => '轻应用-热点播报-热点摘要生成',
+ 'summary' => 'Alibaba Cloud Model Studio lightweight application – In-vehicle/content platform news hot spot interaction – Generate a custom summary for a single hot spot announcement: Stream-generate a hot spot summary in a custom style. ',
'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicSummary',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => 'Path parameter, workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
],
[
'name' => 'hotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点播报单版本号',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2024-10-16_8',
- ],
+ 'schema' => ['title' => '', 'description' => 'Hot spot broadcast list version number', 'type' => 'string', 'required' => true, 'example' => '2024-10-16_8'],
],
[
'name' => 'topicIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '要进行摘要热点话题ID列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of hot spot topic IDs to summarize',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'items' => ['description' => 'Hot spot ID', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''],
'required' => true,
'example' => 'xxxxx',
],
@@ -6645,1096 +3293,883 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '自定义输出风格配置',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Custom output style configuration',
'type' => 'object',
'properties' => [
- 'summaryImageCount' => [
- 'title' => '摘要图片数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'summaryPrompt' => [
- 'title' => '自定义摘要Prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'summaryImageCount' => ['title' => '', 'description' => 'Number of images in the summary', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'summaryPrompt' => ['title' => '', 'description' => 'Custom summary prompt', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
'required' => true,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Response ',
'type' => 'object',
'properties' => [
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message header',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'errorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'AccessForbidden'],
+ 'errorMessage' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => '错误信息'],
+ 'event' => ['title' => '', 'description' => 'Management event', 'type' => 'string', 'example' => 'task-finished'],
+ 'sessionId' => ['title' => '', 'description' => 'Session UUID', 'type' => 'string', 'example' => 'xxxx'],
+ 'taskId' => ['title' => '', 'description' => 'Job UUID', 'type' => 'string', 'example' => 'xxxx'],
+ 'traceId' => ['title' => '', 'description' => 'End-to-end UUID', 'type' => 'string', 'example' => 'xxxxx'],
],
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message body ',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Outputs ',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'topicId' => [
- 'title' => '热点ID',
- 'type' => 'string',
- ],
+ 'text' => ['title' => '', 'description' => 'Output summary text ', 'type' => 'string', 'example' => '这是测试输出'],
+ 'topicId' => ['description' => 'Hot spot ID ', 'title' => 'Hot spot ID ', 'type' => 'string', 'example' => 'xxx'],
],
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Token consumption ',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['title' => '', 'description' => 'Input tokens ', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '', 'description' => 'Output tokens ', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '', 'description' => 'Total tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Generate custom summary for hot spot broadcast list',
+ 'description' => 'This API enables stream-generation of a hot spot summary in a custom style for a single hot spot announcement. '."\n"
+ ."\n"
+ .'You can try it out in the [console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast). '."\n"
+ ."\n"
+ .'For invoking the API via the software development kit (SDK), refer to the Sample under “API” in the console. ',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-13T13:25:04.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\",\\n \\"topicId\\": \\"xxx\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\"\\n}","type":"json"}]',
+ 'translator' => 'machine',
],
- 'RunEnterpriseVocAnalysis' => [
- 'summary' => '企业VOC分析',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runEnterpriseVocAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunMarketingInformationExtract' => [
+ 'summary' => 'Extract e-commerce retail content entities.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationExtract',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Path parameter. [Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'w-08a4a3ba7104917c', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Large Language Model (LLM) ID.', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'."\n"
+ .'qwen-plus', 'title' => ''],
+ ],
+ [
+ 'name' => 'extractType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Extraction type.', 'type' => 'string', 'required' => false, 'example' => 'point-商品卖点'."\n"
+ .'introduce-商品介绍中的要素'."\n"
+ .'article-营销文案中的要素'."\n"
+ .'comment-对商品看法中的要素'."\n"
+ .'feature-feature', 'title' => ''],
+ ],
+ [
+ 'name' => 'customPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Custom extraction instruction.', 'type' => 'string', 'required' => false, 'example' => '你是一位商品广告设计师,根据下面的产品介绍,生成一句话来描述该产品的卖点。', 'title' => ''],
+ ],
+ [
+ 'name' => 'sourceMaterials',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The content to extract.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The content of the article from which to extract information.', 'type' => 'string', 'required' => false, 'example' => 'ps5是sony新一代的游戏机,他创新性的...', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema.',
+ 'type' => 'object',
+ 'properties' => [
+ 'end' => ['description' => 'Indicates whether the operation has ended.', 'type' => 'boolean', 'example' => '{\'TimeZone\': \'Asia/Shanghai\', \'DateTime\': \'2024-03-07T17:00:09+08:00\'}', 'title' => ''],
+ 'header' => [
+ 'description' => 'Response header.',
+ 'type' => 'object',
+ 'properties' => [
+ 'event' => ['description' => 'Event name.', 'type' => 'string', 'example' => 'result-generated', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '可空', 'title' => ''],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F08C71C0-9399-548C-838B-1DA01DE211B0', 'title' => ''],
+ 'sessionId' => ['description' => 'Session ID. Use it to track conversations.', 'type' => 'string', 'example' => '121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '12826092918145', 'title' => ''],
+ 'traceId' => ['description' => 'Log trace ID.', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'payload' => [
+ 'description' => 'Payload of the response. This is a JSON object. The structure varies by event type.',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'description' => 'Information displayed on the page.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'Extracted content.', 'type' => 'string', 'example' => 'playstation 5新一代的...', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'description' => 'Token usage details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
],
- 'produces' => [
- 'application/octet-stream',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"requestId\\": \\"F08C71C0-9399-548C-838B-1DA01DE211B0\\",\\n \\"sessionId\\": \\"121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2\\",\\n \\"taskId\\": \\"12826092918145\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"playstation 5新一代的...\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'E-commerce Retail Content Entity Extraction ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationExtract',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'operationType' => 'write',
+ ],
+ 'RunMarketingInformationWriting' => [
+ 'summary' => 'Writes promotional copy for e-commerce and retail.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'],
],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => 'The path parameter. For more information, see [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d71e6e', 'title' => ''],
],
[
- 'name' => 'taskDescription',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你是一名经验丰富的数据分析师,擅长从文本评论中提取结构化信息。你需要从用户评论列表中识别和提取出与以下四个维度相关的关键词和短语:'."\n"
- .' '."\n"
- .' 索引:输入评论JSON数组中的索引(从零开始)表示针对该条索引抽取的维度。'."\n"
- .' 购买动机:描述用户购买产品的原因、需求或驱动力的关键词或短语。'."\n"
- .' 未满足需求点:用户在使用产品过程中提到的未满足需求或问题的关键词或短语。'."\n"
- .' 使用场景:用户提到的具体使用场景、使用方式或环境的关键词或短语。'."\n"
- .' 正负面观点:明确表示用户对产品或服务的正面或负面看法的关键词或短语。',
- ],
+ 'schema' => ['description' => 'The ID of the Large Language Model (LLM).', 'type' => 'string', 'example' => 'qwen-max'."\n"
+ .'qwen-plus', 'required' => false, 'title' => ''],
],
[
- 'name' => 'modelId',
+ 'name' => 'writingType',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['description' => 'The writing type:'."\n"
+ .'generateProductTitle: Generates a product title.'."\n"
+ .'productTitleTranslation: Translates a product title.'."\n"
+ .'generateProductSummary: Generates a product summary.'."\n"
+ .'productRedBook: Generates a Xiaohongshu (Little Red Book) post about a product.'."\n"
+ .'productEvaluating: Generates a product assessment copy.'."\n"
+ .'circleOfFriends: Generates promotional marketing copy suitable for WeChat Moments.'."\n"
+ .'marketingActivities: Generates promotional copy for marketing campaigns.'."\n"
+ .'productAdvertisement: Generates an advertising slogan for a company or product.'."\n"
+ .'travel: Generates a marketing promotion article for travel.'."\n"
+ .'other: Other types of marketing copy.', 'type' => 'string', 'example' => 'productRedBook', 'required' => false, 'title' => ''],
],
[
- 'name' => 'extraInfo',
+ 'name' => 'customPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息(业务补充信息)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Custom writing requirements.', 'type' => 'string', 'example' => '语言要精美。', 'required' => false, 'title' => ''],
],
[
- 'name' => 'outputFormat',
+ 'name' => 'sourceMaterial',
'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '指定返回结果的格式,支持json或text',
- 'type' => 'string',
- 'required' => false,
- 'example' => '按照如下格式输出:{"text1": "xxxx", "text2": "xxxx"}',
- ],
+ 'schema' => ['description' => 'Reference content for writing.', 'type' => 'string', 'example' => 'ps5是sony新一代的游戏机,他创新性的...', 'required' => false, 'title' => ''],
],
[
- 'name' => 'content',
+ 'name' => 'customLimitation',
'in' => 'formData',
- 'schema' => [
- 'title' => '内容',
- 'description' => '需要进行VOC分析的文本内容(content、contents、url、fileKey 四选一。优先级从小到大)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一段需要分析的文本内容',
- ],
+ 'schema' => ['description' => 'Custom writing limitations.', 'type' => 'string', 'example' => '不要有错别字', 'required' => false, 'title' => ''],
],
[
- 'name' => 'tags',
+ 'name' => 'inputExample',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '业务标签体系',
- 'description' => '业务标签体系,用于对文本内容进行分类和分析。',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签名称',
- ],
- 'tagDefinePrompt' => [
- 'description' => '标签定义提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签定义提示词',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'A sample of custom input material for writing.', 'type' => 'string', 'example' => '产品名字:xxx'."\n"
+ .'产品特点:xxx', 'required' => false, 'title' => ''],
],
[
- 'name' => 'filterTags',
+ 'name' => 'outputExample',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '过滤标签',
- 'description' => '过滤标签,用于筛选符合条件的内容。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签名称',
- ],
- 'tagDefinePrompt' => [
- 'description' => '标签定义提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签定义提示词',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'A sample of the custom output format for writing.', 'type' => 'string', 'example' => '写作输出内容样例', 'required' => false, 'title' => ''],
],
[
- 'name' => 'apiKey',
+ 'name' => 'language',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'Target language (used for Product title translation) ', 'description' => 'The target language. This parameter is used for product title translation.', 'type' => 'string', 'example' => 'en', 'required' => false],
],
[
- 'name' => 'akProxy',
+ 'name' => 'keywords',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'Keywords (used to generate product titles and product summaries)', 'description' => 'Keywords. This parameter is used to generate product titles and summaries.', 'type' => 'string', 'example' => '运动鞋 透气 减震 跑步', 'required' => false],
],
[
- 'name' => 'sourceTrace',
+ 'name' => 'generateCount',
'in' => 'formData',
+ 'schema' => ['title' => 'Generate Quantity (used for generating Product titles and Product summaries; value range: 1–15) ', 'description' => 'The number of items to generate. This parameter is used to generate product titles and summaries. Valid values: 1 to 15.', 'type' => 'string', 'example' => '5', 'required' => false],
+ ],
+ [
+ 'name' => 'wordCountRange',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Word count range (used for product title translation, format: minimum word count-maximum word count)', 'description' => 'The word count range. This parameter is used for product title translation. Format: Minimum word count-Maximum word count.', 'type' => 'string', 'example' => '10-20', 'required' => false],
+ ],
+ [
+ 'name' => 'otherRequirements',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Other requirements (for three new writing types: generateProductTitle, generateProductSummary, productTitleTranslation)', 'description' => 'Other requirements. This parameter is used for the following three writing types: generateProductTitle, generateProductSummary, and productTitleTranslation.', 'type' => 'string', 'example' => '要求标题简洁有力,突出产品特点', 'required' => false],
+ ],
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Custom prompt (for controllable generation models; applicable to writing types: generateProductTitle, generateProductSummary, productTitleTranslation)', 'description' => 'A custom prompt. This parameter is used for controllable generation models and applies to the following writing types: generateProductTitle, generateProductSummary, and productTitleTranslation.', 'type' => 'string', 'example' => '请根据关键词生成吸引人的商品标题', 'required' => false],
+ ],
+ [
+ 'name' => 'extParameters',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'type' => 'boolean',
+ 'description' => 'Extension parameters. This is a map structure where all parameter values are of the string type:'."\n"
+ ."\n"
+ .'- enableThinking: Specifies whether to enable the thinking mode. Valid values: "true" or "false".'."\n"
+ ."\n"
+ .'- thinkingBudget: The budget for the thinking mode. This is an integer in the string format.'."\n"
+ ."\n"
+ .'- resultFormat: The result format. This is used to set the output format.'."\n"
+ ."\n"
+ .'- incrementalOutput: Specifies whether to enable incremental output. Valid values: "true" or "false".',
+ 'additionalProperties' => ['title' => 'Parameter KEY ', 'description' => 'The parameter KEY.', 'type' => 'string', 'example' => '大模型参数KEY'],
+ 'title' => 'Extension parameters (Map structure containing parameters such as minWordLength, maxWordLength, enableThinking, and thinkingBudget; all parameter values are of String type) ',
+ 'type' => 'object',
+ 'required' => false,
+ 'example' => '{'."\n"
+ .' "minWordLength": "10",'."\n"
+ .' "maxWordLength": "50",'."\n"
+ .' "enableThinking": "true",'."\n"
+ .' "thinkingBudget": "2000"'."\n"
+ .' }',
],
],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The API key for integration access. For more information, see [Get an API key](https://help.aliyun.com/zh/model-studio/get-api-key?spm=a2c4g.11186623.help-menu-2400256.d_2_0_0.1cbdb0a8lsT1n3).', 'type' => 'string', 'required' => false, 'example' => 'sk-8de1d655ee27496c88b320fbcbc15d73', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
+ 'end' => ['description' => 'Indicates whether the process is complete.', 'type' => 'boolean', 'example' => '2024-06-21T10:29:52+08:00', 'title' => ''],
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'description' => 'The HTTP request header. The format is key1:value1, with each pair separated by a line break.',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'event' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'result-generated', 'title' => ''],
+ 'eventInfo' => ['description' => 'The event description.', 'type' => 'string', 'example' => '可空', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '436BC5AE-0573-59D8-9803-6B5FDCD3BBA1', 'title' => ''],
+ 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd', 'title' => ''],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '13312125943232', 'title' => ''],
+ 'traceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '213e20e517049392478441155e8b2a', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误消息', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'description' => 'The payload of the response. This is a JSON structure that varies based on the event.',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'description' => 'The output.',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'filterResult' => [
- 'title' => '过滤结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'filterResults' => [
- 'title' => '过滤结果列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'tagValue' => [
- 'title' => '标签值',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'hit' => [
- 'title' => '是否命中',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- 'reasonContent' => [
- 'title' => '推理模型返回的推理内容',
- 'type' => 'string',
- ],
+ 'text' => ['description' => 'The returned written content.', 'type' => 'string', 'example' => 'playstation5新时代的...', 'title' => ''],
+ 'reasonContent' => ['description' => 'The model inference content.', 'type' => 'string', 'example' => '推理内容', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'description' => 'The token details.',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '49483FFC-0CB9-5163-8D3E-234E276E6DA8',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"requestId\\": \\"436BC5AE-0573-59D8-9803-6B5FDCD3BBA1\\",\\n \\"sessionId\\": \\"uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd\\",\\n \\"taskId\\": \\"13312125943232\\",\\n \\"traceId\\": \\"213e20e517049392478441155e8b2a\\",\\n \\"errorMessage\\": \\"错误消息\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"playstation5新时代的...\\",\\n \\"reasonContent\\": \\"推理内容\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'E-commerce Retail Promotional Copywriting ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-30T06:32:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-04-17T11:50:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-11-06T11:56:39.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"输出摘要文本\\\\n\\\\n\\",\\n \\"filterResult\\": {\\n \\"filterResults\\": [\\n {\\n \\"tagName\\": \\"过滤标签命中的标签\\",\\n \\"tagValue\\": \\"是\\",\\n \\"hit\\": true\\n }\\n ]\\n },\\n \\"reasonContent\\": \\"\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"49483FFC-0CB9-5163-8D3E-234E276E6DA8\\"\\n}","type":"json"}]',
],
- 'SubmitEnterpriseVocAnalysisTask' => [
- 'summary' => '提交企业VOC异步任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitEnterpriseVocAnalysisTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunNetworkContentAudit' => [
+ 'summary' => 'A lightweight application for network content moderation.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runNetworkContentAudit',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a workspaceId](~~2587495~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''],
],
[
- 'name' => 'taskDescription',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-max', 'title' => '', 'required' => false],
],
[
- 'name' => 'extraInfo',
+ 'name' => 'businessType',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务补充信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'clueMining', 'title' => '', 'required' => false],
],
[
- 'name' => 'outputFormat',
+ 'name' => 'taskDescription',
'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式描述提示词(不传的话默认会根据任务描述生成json格式)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The task description.', 'type' => 'string', 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。', 'title' => '', 'required' => false],
],
[
- 'name' => 'modelId',
+ 'name' => 'content',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['description' => 'The text to be analyzed.', 'type' => 'string', 'required' => true, 'example' => '待分析文本', 'title' => ''],
],
[
'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '内容标签',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of tag systems.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'tagDefinePrompt' => [
- 'title' => '给到大模型的标签定义Prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'tagDefinePrompt' => ['description' => 'The prompt that defines the tag.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'filterTags',
+ 'name' => 'extraInfo',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '过滤标签',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'tagDefinePrompt' => [
- 'title' => '给到大模型的 筛选的标签定义Prompt',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Additional information.', 'type' => 'string', 'example' => '额外信息', 'title' => '', 'required' => false],
],
[
- 'name' => 'contents',
+ 'name' => 'outputFormat',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => 'The output format.', 'type' => 'string', 'example' => '请返回如下JSON格式,{"key1":"","key2":""}', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The API key for integration. For more information, see [Obtain an API key](https://help.aliyun.com/zh/model-studio/get-api-key?spm=a2c4g.11186623.help-menu-2400256.d_2_0_0.1cbdb0a8lsT1n3).', 'type' => 'string', 'required' => false, 'example' => 'sk-60fd85c1a28f4873abb952e954b0ed27', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '待挖掘的素材内容列表(url、fileKey、contents 三选一)(此数组不超过200个,更多请走fileKey或contents文件形式)',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '素材对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '素材内容(字符数不能超过1w个)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'header' => [
+ 'title' => '',
+ 'description' => 'The message header.',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AccessForbidden', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error description.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
+ 'event' => ['description' => 'The event.', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'sessionId' => ['description' => 'The unique identifier of the session.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'taskId' => ['description' => 'The unique identifier of the task.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'The unique identifier for the entire call chain.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
],
- 'id' => [
- 'title' => '素材ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id-xxxxx',
+ 'example' => '',
+ ],
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'The message body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '',
+ 'description' => 'The output.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'The output summary text.', 'type' => 'string', 'title' => '', 'example' => 'xxxx'],
+ ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'The token usage.',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ ],
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
- 'required' => false,
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
],
- 'required' => false,
+ 'example' => '',
],
],
- [
- 'name' => 'url',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待挖掘的素材内容文件URL(url、fileKey、contents 三选一)(整体文件大小不能超过100M,素材个数不能超过6w条)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xxxx\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\"\\n}","type":"json"}]',
+ 'title' => 'Network Content Moderation Review ',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-17T11:50:20.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunNetworkContentAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'RunOcrParse' => [
+ 'summary' => 'Parses essay images using OCR',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runOcrParse',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
[
- 'name' => 'fileKey',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'url',
'in' => 'formData',
- 'schema' => [
- 'title' => '待挖掘的素材内容文件FileKey(url、fileKey、contents 三选一)(fileKey 是从全妙SASS页面上传所获取到的唯一key)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt',
- ],
+ 'schema' => ['description' => 'Image URL (specify either url or fileKey)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt'],
],
[
- 'name' => 'apiKey',
+ 'name' => 'fileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Image URL (specify either url or fileKey)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt', 'title' => ''],
],
[
- 'name' => 'sourceTrace',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'type' => 'boolean',
- ],
+ 'schema' => ['title' => 'Model ID', 'description' => 'Model ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-vl-ocr-latest'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoPermission',
+ 'header' => [
+ 'title' => '',
+ 'description' => 'Message header',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'AccessForbidden', 'title' => ''],
+ 'errorMessage' => ['description' => 'A description of the fault.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
+ 'event' => ['description' => 'Event', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'Trace ID', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'data' => [
- 'title' => '业务对象',
- 'description' => '',
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'Message body',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a0cc71ec-fe07-47e5-bf12-6e1c46081c98',
+ 'output' => [
+ 'title' => '',
+ 'description' => 'Output',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'OCR text output', 'type' => 'string', 'title' => '', 'example' => 'OCR文本输出'."\n"
+ ."\n"],
+ ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'Token usage',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Input tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'Output tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'Total tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ ],
+ 'example' => '',
],
],
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '',
- 'type' => 'string',
'example' => '',
],
- 'success' => [
- 'title' => '接口请求是否成功:true 成功,false 失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"OCR文本输出\\\\n\\\\n\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
+ 'title' => 'Image OCR parse',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunOcrParse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"data\\": {\\n \\"taskId\\": \\"a0cc71ec-fe07-47e5-bf12-6e1c46081c98\\"\\n },\\n \\"httpStatusCode\\": 403,\\n \\"message\\": \\"无权限访问接口\\",\\n \\"success\\": false\\n}","type":"json"}]',
],
- 'GetEnterpriseVocAnalysisTask' => [
- 'summary' => '获取企业VOC分析任务结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getEnterpriseVocAnalysisTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunScriptChat' => [
+ 'summary' => 'Create long-form scripts.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptChat',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-rz8db8d00rcn2p0xc'],
+ ],
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Script instruction from the user.', 'type' => 'string', 'required' => true, 'maxLength' => 9000, 'title' => '', 'example' => '创建角色:林晓晓'],
],
[
'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier for the task.'."\n"
+ ."\n"
+ .'> - Leave this field empty to let the system generate a taskId automatically. If you use the same taskId in later requests, those tasks belong to the same conversation.'."\n"
+ .'>'."\n"
+ .'> - Set a custom taskId to link related requests and maintain context.', 'type' => 'string', 'maxLength' => 1000, 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
- 'httpStatusCode' => [
- 'title' => 'Http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'message' => [
- 'title' => '响应失败时的消息',
- 'description' => '',
- 'type' => 'string',
+ 'end' => ['description' => 'Indicates whether streaming output is complete. Set to true when complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'header' => [
+ 'description' => 'Header for streaming output. Contains general response information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'Error code for abnormal conditions.', 'type' => 'string', 'title' => '', 'example' => '403'],
+ 'errorMessage' => ['description' => 'Error message for abnormal conditions.', 'type' => 'string', 'title' => '', 'example' => 'Pop sign mismatch, please check log.'],
+ 'event' => ['description' => 'Event type.', 'type' => 'string', 'title' => '', 'example' => 'result-generated'],
+ 'eventInfo' => ['description' => 'Event description.', 'type' => 'string', 'title' => '', 'example' => '模型生成事件描述'],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3'],
+ 'sessionId' => ['description' => 'Session ID.', 'type' => 'string', 'title' => '', 'example' => '147648697127_914847410985_1730600302167'],
+ 'taskId' => ['description' => 'Task ID.', 'type' => 'string', 'title' => '', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['description' => 'Trace ID.', 'type' => 'string', 'title' => '', 'example' => '2150432017236011824686132ecdbc'],
+ ],
+ 'title' => '',
'example' => '',
],
- 'success' => [
- 'title' => 'true:此次接口响应成功,false:响应失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'data' => [
- 'title' => '结果对象',
- 'description' => '',
+ 'payload' => [
+ 'description' => 'Payload of the response. Returns as JSON.',
'type' => 'object',
'properties' => [
- 'status' => [
- 'title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PENDING',
- ],
- 'errorMessage' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'usage' => [
- 'title' => '消耗量统计',
- 'description' => '',
+ 'output' => [
+ 'title' => '',
+ 'description' => 'Output content object.',
'type' => 'object',
'properties' => [
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'text' => ['description' => 'Output text.', 'type' => 'string', 'title' => '', 'example' => '以下是角色信息'],
],
+ 'example' => '',
],
- 'statisticsOverview' => [
- 'title' => '统计概览',
- 'description' => '',
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'Large Language Model (LLM) token usage.',
'type' => 'object',
'properties' => [
- 'count' => [
- 'title' => '总分析数据条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '17',
- ],
- 'tagDimensionStatistics' => [
- 'title' => '内容标签统计',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagValueCountStatistic' => [
- 'title' => '标签值数量统计',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签值数量统计',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'valueCount' => [
- 'title' => '标签值数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10'."\n",
- ],
- ],
- ],
- ],
- ],
- ],
- 'filterDimensionStatistics' => [
- 'title' => '筛选标签统计',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagValueCountStatistic' => [
- 'title' => '标签值数量统计',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签值数量统计',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'valueCount' => [
- 'title' => '标签值数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
],
- ],
- 'modelId' => [
- 'title' => '此次使用的模型ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelName' => [
- 'title' => '此次使用的模型名称',
- 'description' => '',
- 'type' => 'string',
'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件描述\\",\\n \\"requestId\\": \\"F8A35034-EDCF-5C50-95A5-1044316F36E3\\",\\n \\"sessionId\\": \\"147648697127_914847410985_1730600302167\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"以下是角色信息\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Interactive Playbook Creation for Film, TV, and Entertainment',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-18T12:33:20.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"httpStatusCode\\": 403,\\n \\"message\\": \\"无权限访问接口\\",\\n \\"success\\": false,\\n \\"data\\": {\\n \\"status\\": \\"PENDING\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\",\\n \\"usage\\": {\\n \\"outputTokens\\": 2,\\n \\"inputTokens\\": 1\\n },\\n \\"statisticsOverview\\": {\\n \\"count\\": 17,\\n \\"tagDimensionStatistics\\": {\\n \\"tagValueCountStatistic\\": [\\n {\\n \\"tagName\\": \\"标签名称\\",\\n \\"valueCount\\": 10\\n }\\n ]\\n },\\n \\"filterDimensionStatistics\\": {\\n \\"tagValueCountStatistic\\": [\\n {\\n \\"tagName\\": \\"标签名称\\\\n\\",\\n \\"valueCount\\": 10\\n }\\n ]\\n }\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelName\\": \\"通义千问-MAX\\"\\n }\\n}","type":"json"}]',
],
- 'ExportAnalysisTagDetailByTaskId' => [
- 'summary' => '导出挖掘任务明细',
- 'path' => '/{workspaceId}/quanmiao/lightapp/exportAnalysisTagDetailByTaskId',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunScriptContinue' => [
+ 'summary' => 'Generates script continuations for film, television, and interactive entertainment.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptContinue',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxxxxxx',
- ],
+ 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-e9zzbkg0aj2mlXX', 'title' => ''],
],
[
- 'name' => 'taskId',
+ 'name' => 'scriptTypeKeyword',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => 'Script type keywords. Provide qualitative descriptions for the script type, such as historical fantasy, sci-fi, romance, or Xuanhuan.', 'type' => 'string', 'example' => '悬疑,都市,惊悚', 'maxLength' => 5000, 'title' => '', 'required' => false],
],
[
- 'name' => 'category',
+ 'name' => 'scriptSummary',
'in' => 'formData',
- 'schema' => [
- 'title' => '分类筛选',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Script summary. Provide a brief story description for the script.', 'type' => 'string', 'required' => false, 'example' => '一队全副武装的执法人员和消防员闯入了一间明显已被遗弃多日、门窗紧闭并用胶带封死的公寓,面对着屋内令人作呕的恶臭和门厅里的混乱场面,他们似乎在寻找某种隐藏的真相或危险源,而一封日期为16号的信件成为了揭开谜团的关键线索,随着便衣探员深入探索,一系列封闭的房间暗示着这里曾发生过不为人知的秘密事件。', 'maxLength' => 5000, 'title' => ''],
],
[
- 'name' => 'categories',
+ 'name' => 'userProvidedContent',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '多分类筛选',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签分类',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Preceding text description. Continue a section of novel content. Provide the preceding text.', 'type' => 'string', 'required' => true, 'example' => '门厅一片狼藉。朝向天井的窗户开着。公寓门突然被撞开了。\\n一名便衣探员、两名穿制服的警察和几位消防员———也身着工作服———进来,四下张望。他们都戴着手套以及盖住口鼻的面罩。在他们身后,门房和他妻子也挤进门厅。他们都捂着鼻子。门房的另一只手里拿着一叠信件和促销广告单。他们身后,跟着一位女邻居。\\n便衣探员(对门房和邻居):请在外面等候。\\n他向一名警察示意,警察正忙着把好奇的旁观者请出门外。\\n警察(对门房,指着那一叠信件):最近的一封是哪天的?\\n门房(查对信件):最近的一封似乎是16号的......等一下......\\n便衣探员想打开左侧的门,却是徒劳。门用胶带封上了。\\n便衣探员(对消防员):你来试一下好吗?\\n消防员摆弄门的时候,便衣探员进了卧室隔壁的餐厅。他迅速打开窗,转身,想经过对开门进左侧的房间。这两扇门也锁着,门缝被贴上了胶带。他右转进入起居室,也打开了窗户', 'maxLength' => 5000, 'title' => ''],
],
],
'responses' => [
@@ -7744,130 +4179,137 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'title' => '错误消息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'httpStatusCode' => [
- 'title' => 'http响应码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'end' => ['description' => 'Indicates whether the output is complete. A value of true indicates that the output is complete.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'header' => [
+ 'title' => '',
+ 'description' => 'The streaming output header, which contains general response information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '403', 'title' => ''],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.', 'title' => ''],
+ 'event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'result-generated', 'title' => ''],
+ 'eventInfo' => ['description' => 'The event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF', 'title' => ''],
+ 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035', 'title' => ''],
+ 'taskId' => ['description' => 'The generation task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99', 'title' => ''],
+ 'traceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'data' => [
- 'title' => 'URL(临时公网可下载的URL,1小时失效)',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxxx.xlsx',
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'The response payload, in JSON format.',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '',
+ 'description' => 'The output content object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'The output content.', 'type' => 'string', 'example' => '这是测试输出', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'Large Language Model (LLM) token usage information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": \\"http://www.example.com/xxxx.xlsx\\"\\n}","type":"json"}]',
- ],
- 'ListAnalysisTagDetailByTaskId' => [
- 'summary' => '获取挖掘分析结果明细列表',
- 'path' => '/{workspaceId}/quanmiao/lightapp/listAnalysisTagDetailByTaskId',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": false,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Script Continuation for Film, TV, and Entertainment',
+ 'description' => 'This feature generates the next part of a script based on the preceding text. This helps expand the creative ideas of editors.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptContinue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunScriptPlanning' => [
+ 'summary' => 'Scriptwriting for film, television, and interactive entertainment, including script development.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptPlanning',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'nextToken',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '标记当前开始读取的位置,置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==',
- ],
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier for Alibaba Cloud Model Studio workspace. Get the [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-e9zzbkg0aj2mlXX', 'title' => ''],
],
[
- 'name' => 'maxResults',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '本次读取的最大数据记录数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'scriptName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Natural language input for the script name.', 'type' => 'string', 'example' => '都市战神', 'maxLength' => 5000, 'title' => '', 'required' => false],
],
[
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'name' => 'scriptTypeKeyword',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Script type keywords. Users provide qualitative descriptions for the script type, such as alternate history, sci-fi, romance, or fantasy.', 'type' => 'string', 'example' => '现代,都市,爱情,玄幻', 'maxLength' => 5000, 'title' => '', 'required' => false],
],
[
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '挖掘的任务ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'name' => 'scriptSummary',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Script synopsis. Users provide a brief story description for the script.', 'type' => 'string', 'required' => true, 'example' => '在一个宁静的小镇上,每个家庭都在同一天收到一个神秘的、没有标记的包裹。', 'maxLength' => 5000, 'title' => ''],
+ ],
+ [
+ 'name' => 'scriptShotCount',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Number of script shots. Users can define the number of shot descriptions to generate within a single script, with a value range of 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '10', 'minimum' => '1', 'example' => '3', 'default' => '3', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'dialogueInScene',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether specific shot dialogues are needed. Default is false.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'plotConflict',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Users can check whether to add plot conflicts and inversion elements to the planning content. If checked, these are automatically generated in the plot.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'additionalNote',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Additional notes. Users can make open-ended adjustments by describing them in natural language within the text input box, such as adding descriptions of tense and exciting moments, to adjust the effect.', 'type' => 'string', 'example' => '故事尽可能狗血', 'maxLength' => 5000, 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -7877,242 +4319,111 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'totalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'nextToken' => [
- 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx',
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxxxxx',
- ],
- 'maxResults' => [
- 'title' => 'MaxResults本次请求所返回的最大记录条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'code' => [
- 'title' => '响应Code码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'message' => [
- 'title' => '响应消息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'success' => [
- 'title' => '此次请求是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'end' => ['description' => 'Whether the output is complete. True indicates completion.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'header' => [
+ 'title' => '',
+ 'description' => 'Streaming output header, containing general return information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'Abnormal error code.', 'type' => 'string', 'example' => '403', 'title' => ''],
+ 'errorMessage' => ['description' => 'Abnormal error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.', 'title' => ''],
+ 'event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF', 'title' => ''],
+ 'sessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035', 'title' => ''],
+ 'taskId' => ['description' => 'Generation task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99', 'title' => ''],
+ 'traceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'data' => [
- 'title' => '标签挖掘明细列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签挖掘明细',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '标签素材内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'contentTags' => [
- 'title' => '标签挖掘内容列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'tags' => [
- 'title' => '标签值列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签值',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- 'originResponse' => [
- 'title' => '原始挖掘响应',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'payload' => [
+ 'title' => '',
+ 'description' => 'Payload of the returned result, JSON structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '',
+ 'description' => 'Output content object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'Output content.', 'type' => 'string', 'example' => '这是测试输出', 'title' => ''],
],
- 'sourceList' => [
- 'title' => '溯源原文列表,启用sourceTrace时会返回该字段',
- 'type' => 'array',
- 'items' => [
- 'title' => '溯源原文,启用sourceTrace时会返回该字段',
- 'type' => 'string',
- ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'Large Language Model (LLM) token usage information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 200,\\n \\"nextToken\\": \\"xxxxx\\",\\n \\"requestId\\": \\"xxxxxxx\\",\\n \\"maxResults\\": 100,\\n \\"code\\": \\"DataNotExists\\",\\n \\"message\\": \\"成功\\",\\n \\"success\\": false,\\n \\"data\\": [\\n {\\n \\"content\\": \\"xxxx\\",\\n \\"contentTags\\": [\\n {\\n \\"tagName\\": \\"标签名称\\",\\n \\"tags\\": [\\n \\"标签值\\"\\n ]\\n }\\n ],\\n \\"originResponse\\": \\"原始响应\\",\\n \\"sourceList\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'GenerateOutputFormat' => [
- 'summary' => '轻应用-标签挖掘-获取示例输出格式',
- 'path' => '/{workspaceId}/quanmiao/lightapp/generateOutputFormat',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": false,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Film and Entertainment Playbook Creation – Playbook Planning',
+ 'description' => 'You can input basic script requirements to generate a script synopsis and brief shot descriptions. This feature helps editors quickly create a script outline.',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptPlanning',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunScriptRefine' => [
+ 'summary' => 'Refines the content of a playbook conversation.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptRefine',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxxxx',
- ],
- ],
- [
- 'name' => 'businessType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
+ 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-zna577pdximvztk5'],
],
[
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待分析文本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '待分析文本',
- ],
- ],
- [
- 'name' => 'tags',
+ 'name' => 'taskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '标签体系列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'tagDefinePrompt' => [
- 'title' => '标签定义提示词',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
+ 'schema' => ['description' => 'The unique identifier of the task.'."\n"
+ ."\n"
+ .'> - Specifying taskId is optional. The system generates one automatically. Tasks with the same taskId are grouped into the same conversation.'."\n"
+ .'>'."\n"
+ .'> - Manually assign a taskId to associate context between tasks.', 'type' => 'string', 'maxLength' => 1000, 'title' => '', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
],
'responses' => [
@@ -8122,2233 +4433,3875 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
+ 'end' => ['description' => 'Indicates whether the output is complete. A value of true indicates that the output is complete.', 'type' => 'boolean', 'title' => '', 'example' => ''],
+ 'header' => [
+ 'description' => 'The header of the streaming output. It contains common response information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '403'],
+ 'errorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Pop sign mismatch, please check log.'],
+ 'event' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => 'result-generated'],
+ 'eventInfo' => ['description' => 'The event description.', 'type' => 'string', 'title' => '', 'example' => '模型生成事件'],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3'],
+ 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'title' => '', 'example' => '17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824'],
+ 'taskId' => ['description' => 'The ID of the generation task.', 'type' => 'string', 'title' => '', 'example' => '14356391-6c6c-40d5-b80a-8ecd03b69d72'],
+ 'traceId' => ['description' => 'The trace ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2150432017236011824686132ecdbc'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'data' => [
- 'title' => '示例格式对象',
- 'description' => '',
+ 'payload' => [
+ 'description' => 'The payload of the response. It is in JSON format. The structure varies based on the event.',
'type' => 'object',
'properties' => [
- 'outputFormat' => [
- 'title' => '输出格式',
- 'description' => '',
- 'type' => 'string',
+ 'output' => [
+ 'title' => '',
+ 'description' => 'The output content object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'The output content.', 'type' => 'string', 'title' => '', 'example' => 'xx'],
+ 'role' => ['description' => 'The role identity.', 'type' => 'string', 'example' => '用户角色信息', 'title' => ''],
+ 'scene' => ['description' => 'The story scene. This is a reserved field.', 'type' => 'string', 'example' => '保留字段,暂无赋值', 'title' => ''],
+ 'summary' => ['description' => 'The story summary.', 'type' => 'string', 'example' => '在充满机遇与挑战的大都市,平凡女孩林苏怀揣梦想却处处碰壁。一次偶然的机会', 'title' => ''],
+ 'outline' => ['description' => 'The script outline.', 'type' => 'string', 'example' => '在繁华都市的夜晚,林苏因面试失败心情低落时意外撞上了沈逸', 'title' => ''],
+ 'content' => [
+ 'description' => 'The main text.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The main text.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The main text. The content of the act.', 'type' => 'string', 'example' => '{"第一幕":" 幕次: 第一幕\\n\\n 场面描述"}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'usage' => [
+ 'title' => '',
+ 'description' => 'The token usage of the Large Language Model (LLM).',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
+ ],
'example' => '',
],
],
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": false,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"result-generated\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"F8A35034-EDCF-5C50-95A5-1044316F36E3\\",\\n \\"sessionId\\": \\"17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824\\",\\n \\"taskId\\": \\"14356391-6c6c-40d5-b80a-8ecd03b69d72\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xx\\",\\n \\"role\\": \\"用户角色信息\\",\\n \\"scene\\": \\"保留字段,暂无赋值\\",\\n \\"summary\\": \\"在充满机遇与挑战的大都市,平凡女孩林苏怀揣梦想却处处碰壁。一次偶然的机会\\",\\n \\"outline\\": \\"在繁华都市的夜晚,林苏因面试失败心情低落时意外撞上了沈逸\\",\\n \\"content\\": [\\n {\\n \\"key\\": \\"{\\\\\\"第一幕\\\\\\":\\\\\\" 幕次: 第一幕\\\\\\\\n\\\\\\\\n 场面描述\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Script Compilation for Film, TV, and Entertainment ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"successful\\",\\n \\"data\\": {\\n \\"outputFormat\\": \\"请直接以如下JSON格式输出,不要输出其他内容:\\\\n{\\\\n \\\\\\"是否近期买房\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"购房付款方式\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"家庭人口数量\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"房间数量需求\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"买房投资诉求\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户买房类型\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户买房预算\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"客户居住地\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"用户核心需求\\\\\\": [\\\\n \\\\\\"\\\\\\"\\\\n ],\\\\n \\\\\\"年龄\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"性别\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"职业\\\\\\":\\\\\\"\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true\\n}","type":"json"}]',
],
- 'RunTagMiningAnalysis' => [
- 'summary' => '轻应用-标签挖掘',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runTagMiningAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunStyleWriting' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runStyleWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'w-08a4a3ba7104917c',
- ],
+ 'schema' => ['description' => '[The ID of the workspace.](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-2setzb9xb8mx'],
],
[
- 'name' => 'modelId',
+ 'name' => 'learningSamples',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'A collection of articles to use as learning samples.',
+ 'type' => 'array',
+ 'items' => ['description' => 'An article to use as a learning sample.', 'type' => 'string', 'required' => false, 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。', 'title' => ''],
'required' => false,
- 'example' => 'qwen-max',
+ 'example' => '["在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
+ .'"]',
+ 'maxItems' => 10,
+ 'minItems' => 1,
],
],
[
- 'name' => 'businessType',
+ 'name' => 'writingTheme',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
+ 'schema' => ['description' => 'The theme for the generated content. Providing a custom theme helps fine-tune the output.', 'type' => 'string', 'required' => false, 'maxLength' => 2000, 'title' => '', 'example' => '帮我写一篇关于妙笔产品等文案'],
],
[
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'content',
+ 'name' => 'styleFeature',
'in' => 'formData',
- 'schema' => [
- 'title' => '待分析文本',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '待分析文本',
- ],
+ 'schema' => ['description' => 'The style feature identifier. When specified, the API generates content based on this feature.', 'type' => 'string', 'maxLength' => 2000, 'title' => '', 'required' => false, 'example' => '文章特点1:标题采用话题标签形式,增强社交媒体传播性。\\n文章特点2:开篇通过引言简述背景,快速关联当下热点话题。\\n文章特点3:使用记者调查作为支撑,列举具体行业实例,增强论述的现实基础。\\n文章特点4:引入法律观点平衡论述,提供政策依据,并倡导正面价值观。\\n\\n示例文章特点总结:该文以社会热点为导向,运用具有传播力的标题设计,通过现象观察引入话题,结合实地调查数据展现广泛的社会现象,同时援引法律规定进行评析,确保论述客观性,并在结尾处倡导积极健康的职场文化,整体结构紧凑,信息丰富且具有引导性。'],
],
[
- 'name' => 'tags',
+ 'name' => 'referenceMaterials',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '标签体系列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'A collection of reference materials for the large model\'s content generation.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'tagDefinePrompt' => [
- 'title' => '标签定义提示词',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => false,
- ],
+ 'items' => ['description' => 'A reference material for the large model\'s content generation.', 'type' => 'string', 'required' => false, 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。', 'title' => ''],
'required' => false,
+ 'example' => '是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
+ .'"]',
],
],
[
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- [
- 'name' => 'outputFormat',
+ 'name' => 'processStage',
'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
- ],
+ 'schema' => ['title' => '* Represents the processing stage'."\n"
+ .' * "full": Generate both Analysis and Content'."\n"
+ .' * "analysisStage": Generate only Analysis'."\n"
+ .' * "creationStage": Generate only Content', 'description' => '- Specifies the processing stage.'."\n"
+ ."\n"
+ .' - "full": Generates both a style feature analysis and the final content.'."\n"
+ ."\n"
+ .' - "analysisStage": Generates only the style feature analysis.'."\n"
+ ."\n"
+ .' - "creationStage": Generates only the final content.', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
- 'name' => 'apiKey',
+ 'name' => 'useSearch',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['title' => 'Whether to automatically retrieve supplementary materials from the Internet ', 'description' => 'Specifies whether to automatically search the internet for additional reference materials.', 'type' => 'boolean', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
+ 'end' => ['description' => 'Indicates whether the output is complete. A value of `true` marks the end of the response stream.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'description' => 'The header of the streaming output, containing common response metadata.',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'errorCode' => ['description' => 'A unique code that identifies the error.', 'type' => 'string', 'title' => '', 'example' => '403'],
+ 'errorMessage' => ['description' => 'A human-readable message that describes the error.', 'type' => 'string', 'title' => '', 'example' => 'Pop sign mismatch, please check log.'],
+ 'event' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => 'task-progress-start-generating'],
+ 'eventInfo' => ['description' => 'The event description.', 'type' => 'string', 'title' => '', 'example' => '模型生成事件'],
+ 'requestId' => ['description' => 'The unique ID for the request, useful for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF'],
+ 'sessionId' => ['description' => 'The session ID for this conversation.', 'type' => 'string', 'title' => '', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'taskId' => ['description' => 'The task ID for this generation job.', 'type' => 'string', 'title' => '', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['description' => 'The trace ID for distributed tracing.', 'type' => 'string', 'title' => '', 'example' => '2150451a17191950923411783e2927'],
],
+ 'example' => '{"event":"task-progress-start-generating","sessionId":"3cd10828-0e42-471c-8f1a-931cde20b035","taskId":"d3be9981-ca2d-4e17-bf31-1c0a628e9f99","traceId":"66bef4a7f5d61ff3c43f3b710574e175"}',
+ 'title' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'description' => 'The response payload. Its schema depends on the `event` type.',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Contains the generated content.',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'text' => ['description' => 'The generated text content.', 'type' => 'string', 'title' => '', 'example' => '这是测试输出'],
],
+ 'example' => '{'."\n"
+ .' "text": "这是测试输出"'."\n"
+ .' }',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Token usage statistics for the model call.',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'The number of tokens in the prompt.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'The number of tokens in the generated output.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'The total number of tokens used in the request (input + output).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
],
+ 'example' => '{'."\n"
+ .' "inputTokens": 1816,'."\n"
+ .' "outputTokens": 96,'."\n"
+ .' "totalTokens": 1912'."\n"
+ .' }',
],
],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
+ 'example' => '{'."\n"
+ .' "output": {'."\n"
+ .' "text": "这是测试输出"'."\n"
+ .' },'."\n"
+ .' "usage": {'."\n"
+ .' "inputTokens": 1816,'."\n"
+ .' "outputTokens": 96,'."\n"
+ .' "totalTokens": 1912'."\n"
+ .' }'."\n"
+ .'}',
+ 'title' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"大模型输出文本\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\"\\n}","type":"json"}]',
- ],
- 'RunNetworkContentAudit' => [
- 'summary' => '轻应用-网络内容审核',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runNetworkContentAudit',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Media/Retail Article Style and Format Learning',
+ 'summary' => 'Learn the styles and formats for media and retail content.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-23T11:06:56.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunStyleWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"end\\": true,\\n \\"header\\": {\\n \\"errorCode\\": \\"403\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-progress-start-generating\\",\\n \\"eventInfo\\": \\"模型生成事件\\",\\n \\"requestId\\": \\"0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF\\",\\n \\"sessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"taskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"traceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"这是测试输出\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunTagMiningAnalysis' => [
+ 'summary' => 'Light application — tag mining.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runTagMiningAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'w-08a4a3ba7104917c', 'title' => ''],
],
[
'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['description' => 'Model ID', 'type' => 'string', 'example' => 'qwen-max', 'title' => '', 'required' => false],
],
[
'name' => 'businessType',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
+ 'schema' => ['description' => 'Business type', 'type' => 'string', 'example' => 'clueMining', 'title' => '', 'required' => false],
],
[
'name' => 'taskDescription',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
+ 'schema' => ['description' => 'Task description', 'type' => 'string', 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。', 'title' => '', 'required' => false],
],
[
'name' => 'content',
'in' => 'formData',
- 'schema' => [
- 'title' => '待分析文本',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '待分析文本',
- ],
+ 'schema' => ['description' => 'Text to analyze', 'type' => 'string', 'required' => true, 'example' => '待分析文本', 'title' => ''],
],
[
'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '标签体系列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Tag system list',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Tag object',
'type' => 'object',
'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'tagDefinePrompt' => [
- 'title' => '标签定义提示词',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'tagName' => ['description' => 'Tag name', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'tagDefinePrompt' => ['description' => 'Tag definition prompt', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'extraInfo',
'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
+ 'schema' => ['description' => 'Additional information', 'type' => 'string', 'example' => '额外信息', 'title' => '', 'required' => false],
],
[
'name' => 'outputFormat',
'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
- ],
+ 'schema' => ['description' => 'Output format', 'type' => 'string', 'example' => '请返回如下JSON格式,{"key1":"","key2":""}', 'title' => '', 'required' => false],
],
[
'name' => 'apiKey',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'API key for integration. Get your [API key](https://help.aliyun.com/zh/model-studio/get-api-key?spm=a2c4g.11186623.help-menu-2400256.d_2_0_0.1cbdb0a8lsT1n3).', 'type' => 'string', 'required' => false, 'example' => '8de1d655ee27496c88b320fbcbc15d73', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message header',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'AccessForbidden', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error description.', 'type' => 'string', 'example' => '错误信息', 'title' => ''],
+ 'event' => ['description' => 'Event', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'Trace ID', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
],
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Message body',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Output result',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'text' => ['description' => 'Output summary text', 'type' => 'string', 'title' => '', 'example' => '大模型输出文本'],
],
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Token usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'Input tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'outputTokens' => ['description' => 'Output tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalTokens' => ['description' => 'Total tokens', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"大模型输出文本\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\"\\n}","type":"json"}]',
+ 'title' => 'Label Analysis ',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-10T11:40:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunTagMiningAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xxxx\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\"\\n}","type":"json"}]',
],
- 'RunEssayCorrection' => [
- 'summary' => '作业批改',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runEssayCorrection',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunVideoAnalysis' => [
+ 'summary' => 'Alibaba Cloud Model Studio Light App – Video Understanding for Film and Media.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier for your Alibaba Cloud Model Studio workspace: Get your [Workspace ID](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Video URL'."\n"
+ ."\n"
+ .'> - The videoUrl field is required unless you provide originalSessionId.'."\n"
+ .'>'."\n"
+ .'> - Local video uploads are not supported. Provide a publicly downloadable URL.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx.mp4', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier for the video VL task model. Supported models:'."\n"
+ ."\n"
+ .'- quanmiao-vl-turbo'."\n"
+ ."\n"
+ .'- quanmiao-vl-plus'."\n"
+ ."\n"
+ .'- quanmiao-vl-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-vl-max'."\n"
+ ."\n"
+ .'- Qwen-VL-Post', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-vl-turbo', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoModelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Video VL task prompt template: Must include the {videoAsrText} variable, which contains the video’s ASR text. Defaults to the template shown in the console.', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一名视频分析师,擅长对各种视频片段进行理解。'."\n"
+ ."\n"
+ .'# 任务描述'."\n"
+ .'给你一个视频片段的多张关键帧图片,请你完成以下任务。'."\n"
+ .'- 输出每张图片的画面信息,包括人物、物体、动作、文字、字幕、镜头语言等。'."\n"
+ .'- 把每张图片的信息串联起来,生成视频的详细概述,还原该片段的剧情。'."\n"
+ ."\n"
+ .'# 限制'."\n"
+ .'- 分析范围严格限定于提供的视频子片段,不涉及视频之外的任何推测或背景信息。'."\n"
+ .'- 总结时需严格依据视频内容,不可添加个人臆测或创意性内容。'."\n"
+ .'- 保持对所有视频元素(尤其是文字和字幕)的高保真还原,避免信息遗漏或误解。'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 视频片段ASR信息 (如果输入为空则忽略ASR信息)'."\n"
+ .'{videoAsrText}'."\n"
+ ."\n"
+ .'# 输出格式'."\n"
+ .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier for the LLM used in video summarization. Supported models:'."\n"
+ .'If you want to run multiple text-processing tasks, use the textProcessTasks field instead. If textProcessTasks is provided, this field and its associated prompt template are ignored.'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ ."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-llm-plus'."\n"
+ ."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier for the LLM prompt template used in video summarization:'."\n"
+ ."\n"
+ .'- PlotDetail: Detailed plot analysis (default)'."\n"
+ ."\n"
+ .'- Summary: Content overview'."\n"
+ ."\n"
+ .'- ExtractVideoTag: Tag extraction'."\n"
+ ."\n"
+ .'- ExplosivePointAnalysis: Highlight analysis'."\n"
+ ."\n"
+ .'- MultiTask: Multiple task types'."\n"
+ ."\n"
+ .'If modelCustomPromptTemplate is not provided, the system uses the default prompt for this template ID. modelCustomPromptTemplate takes precedence over modelCustomPromptTemplateId.', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'LLM prompt template for video summarization: Must include both {videoAsrText} and {videoAnalysisText} variables. {videoAsrText} is the ASR transcript. {videoAnalysisText} contains visual-language analysis results for each sub-shot.', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一个专业的视频标注专员,擅长结合视频镜头信息来分析处理各种视频任务。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你结合输入数据串联、还原出整个视频的详细剧情。'."\n"
+ ."\n"
+ .'# 限制'."\n"
+ .'1.如出现语法上错误,或逻辑不通,请直接修改'."\n"
+ .'2.在视频分镜中,如果包含台词,可能会出现说话者与其所说内容不匹配的情况。因此,必须根据剧情的进展,准确判断每段台词的真实说话者'."\n"
+ .'3.如果视频分镜中无台词,请根据视频音频文字为其匹配台词'."\n"
+ .'4.修改后的故事请适当保留视频分镜中对人物、场景的描写'."\n"
+ .'5.帮忙润色一下故事,使其更具逻辑性'."\n"
+ .'6.结合视频分镜中的人物外观特点,如果有外观相近的人物是同一个角色。因此,需要将不同分镜中的人物角色统一。'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 资料一:视频分镜信息(视频各镜头的视觉描述信息)'."\n"
+ .'{videoAnalysisText}'."\n"
+ ."\n"
+ .'## 资料二:视频ASR转录信息(未标注出说话者,可能有错误和遗漏,如果没有输入ASR,则忽略此信息)'."\n"
+ .'{videoAsrText}'."\n"
+ ."\n"
+ .'# 输出格式'."\n"
+ .'直接输出视频剧情,不要输出其他信息。', 'title' => ''],
+ ],
+ [
+ 'name' => 'generateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxxxxx',
+ 'description' => 'Video understanding generation task options.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Video understanding generation task options. Selected tasks run automatically in sequence.'."\n"
+ ."\n"
+ .'- videoAnalysis: Video language analysis (VL). If this is the only value, processing stops after VL analysis.'."\n"
+ ."\n"
+ .'- **videoGenerate: Text processing – video summary (default)**, includes videoAnalysis.'."\n"
+ ."\n"
+ .'- videoTitleGenerate: Video title generation, includes videoAnalysis and videoGenerate.'."\n"
+ ."\n"
+ .'- videoMindMappingGenerate: Video mind map generation, includes videoAnalysis and videoGenerate. videoRoleRecognition: Automatic character recognition.', 'type' => 'string', 'required' => false, 'example' => 'videoGenerate', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'grade',
+ 'name' => 'taskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique task identifier. If not provided, one is generated automatically.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'title' => ''],
+ ],
+ [
+ 'name' => 'originalSessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Source task identifier. To rerun a specific subtask (defined in generateOptions) based on a previous task, provide the original taskId and originalSessionId. The system loads previously generated data to skip earlier steps and improve efficiency. If the stored data is older than 7 days, the system reruns all dependent steps.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoExtraInfo',
'in' => 'formData',
+ 'schema' => ['title' => 'Custom extension text Material: To apply it during generation, manually adjust the prompt template by adding the {videoExtraInfo} variable ', 'description' => 'Supplementary text related to the video. You can extend the input material and reference it in generation by adding the {videoExtraInfo} variable to your custom prompt template. Examples include video summaries, descriptions, or ASR transcripts.', 'type' => 'string', 'required' => false, 'example' => '视频描述了:xx'],
+ ],
+ [
+ 'name' => 'snapshotInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Snapshot interval: one frame every X seconds. Valid values are in the range [1, 10]. A larger interval results in less information extracted by the model, longer duration, and higher cost. The default value already follows Best Practices and generally does not require modification. If you need to modify it, determine the value based on the video duration. We recommend a value in the range [1, 3].', 'description' => 'Frame sampling interval: One frame every X seconds. Range: \\[1, 10]. Larger intervals reduce extracted information, increase processing time, and raise costs. Default settings follow best practices and usually require no changes. If adjusting, consider video length and use \\[1–3]. Note: This parameter takes precedence over frameSampleMethod.interval. For most scenarios, use frameSampleMethod in “userdefined” mode, where interval must stay within the valid range for the video’s duration.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'splitInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Minimum segment Recency: [1, 150]; the smaller value between the current configuration and the System-recommended value based on duration is used.', 'description' => 'Minimum shot segmentation interval in seconds. Range: \\[1, 150]. Default values are recommended based on video length.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
+ ],
+ [
+ 'name' => 'language',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Language. Valid parameter values include chinese, french, english, japanese, chineseEnglishFreely (Chinese and English mixed speech).', 'description' => 'Speech recognition language:'."\n"
+ ."\n"
+ .'- chinese: Chinese (default)'."\n"
+ ."\n"
+ .'- french: French'."\n"
+ ."\n"
+ .'- english: English'."\n"
+ ."\n"
+ .'- japanese: Japanese'."\n"
+ ."\n"
+ .'- chineseEnglishFreely: Chinese and English mixed'."\n"
+ ."\n"
+ .'- arabic: Arabic'."\n"
+ ."\n"
+ .'- korean: Korean'."\n"
+ ."\n"
+ .'- malay: Malay'."\n"
+ ."\n"
+ .'- thai: Thai'."\n"
+ ."\n"
+ .'- portuguese: Portuguese'."\n"
+ ."\n"
+ .'- spanish: Spanish'."\n"
+ ."\n"
+ .'- indonesian: Indonesian'."\n"
+ ."\n"
+ .'- vietnamese: Vietnamese', 'type' => 'string', 'example' => 'english', 'required' => false],
+ ],
+ [
+ 'name' => 'frameSampleMethod',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '年级',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Frame sampling method selection',
+ 'type' => 'object',
+ 'properties' => [
+ 'methodName' => ['description' => 'Frame sampling method options:'."\n"
+ ."\n"
+ .'- standard (Standard) – default'."\n"
+ ."\n"
+ .'- fast (Fast/Lower Cost)'."\n"
+ ."\n"
+ .'- userdefined (Custom)', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''],
+ 'interval' => ['description' => 'Frame sampling interval in seconds. Valid only in userdefined mode.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '4', 'title' => ''],
+ 'pixel' => ['description' => 'Frame resolution: Maximum edge length in pixels. Valid only in userdefined mode. Range: 300 to 768.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400', 'title' => ''],
+ ],
'required' => false,
- 'example' => '',
+ 'example' => 'english',
+ 'title' => '',
],
],
[
- 'name' => 'subject',
+ 'name' => 'videoRoles',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '学科',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Characters',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Characters',
+ 'type' => 'object',
+ 'properties' => [
+ 'roleName' => ['description' => 'Character name', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
+ 'roleInfo' => ['description' => 'Character information', 'type' => 'string', 'required' => false, 'example' => '是个xx', 'title' => ''],
+ 'urls' => [
+ 'description' => 'Character profile pictures',
+ 'type' => 'array',
+ 'items' => ['description' => 'Character profile picture', 'type' => 'string', 'required' => false, 'example' => 'http://xxx', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'isAutoRecognition' => ['description' => 'Indicates whether automatic recognition uses a separate video URL. If true, profile pictures cannot be matched to video frames by timestamp because they may come from a different video.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'timeIntervals' => [
+ 'description' => 'List of character appearance time segments',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'Start time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ 'endTime' => ['description' => 'End time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748491200000', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
+ 'title' => '',
'example' => '',
],
],
[
- 'name' => 'totalScore',
+ 'name' => 'textProcessTasks',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '总分',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'List of video summarization (text processing) tasks. Maximum: 3 tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Video summarization (text processing) task',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['description' => 'Unique identifier for the LLM used in video summarization. Supported models:'."\n"
+ ."\n"
+ .'- qwen-max-latest'."\n"
+ ."\n"
+ .'- qwen-max'."\n"
+ ."\n"
+ .'- qwen-plus-latest'."\n"
+ ."\n"
+ .'- qwen-plus'."\n"
+ ."\n"
+ .'- qwen2.5-7b-instruct-1m'."\n"
+ ."\n"
+ .'- deepseek-r1', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', 'title' => ''],
+ 'modelCustomPromptTemplate' => ['description' => 'LLM prompt template for video summarization: Must include both {videoAsrText} and {videoAnalysisText} variables. {videoAsrText} is the ASR transcript. {videoAnalysisText} contains visual-language analysis results for each sub-shot.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
+ 'modelCustomPromptTemplateId' => ['description' => 'Unique identifier for the LLM prompt template used in video summarization:'."\n"
+ ."\n"
+ .'- PlotDetail: Detailed plot analysis (default)'."\n"
+ ."\n"
+ .'- Summary: Content overview'."\n"
+ ."\n"
+ .'- ExtractVideoTag: Tag extraction'."\n"
+ ."\n"
+ .'- ExplosivePointAnalysis: Highlight analysis'."\n"
+ ."\n"
+ .'- MultiTask: Multiple task types'."\n"
+ ."\n"
+ .'If modelCustomPromptTemplate is not provided, the system uses the default prompt for this template ID. modelCustomPromptTemplate takes precedence over modelCustomPromptTemplateId.', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '60',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'question',
+ 'name' => 'faceIdentitySimilarityMinScore',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Character recognition similarity threshold: Range (0–1)', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoShotFaceIdentityCount',
'in' => 'formData',
+ 'schema' => ['description' => 'Number of sampled frames (images) per shot (segment) used for character matching: Range \\[1–5]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
+ ],
+ [
+ 'name' => 'excludeGenerateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '题目不能为空',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Excluded generation steps:'."\n"
+ ."\n"
+ .'- videoCaption: Video speech recognition',
+ 'title' => 'Excluded generation steps: '."\n"
+ ."\n"
+ .'- videoCaption: Video speech recognition',
+ 'type' => 'array',
+ 'items' => ['description' => 'Excluded generation steps:'."\n"
+ ."\n"
+ .'- videoCaption: Video speech recognition', 'type' => 'string', 'required' => false, 'example' => '[\\"videoCaption\\"]', 'title' => ''],
'required' => false,
- 'example' => 'xx',
+ 'example' => '',
],
],
[
- 'name' => 'answer',
+ 'name' => 'videoCaptionInfo',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '作答内容',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Caption (ASR) information',
+ 'title' => 'Caption (ASR) information',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoCaptions' => [
+ 'description' => 'Caption (ASR) content. Use either this field or videoCaptionsFileUrl.',
+ 'title' => 'Caption (ASR) content; choose either this field or videoCaptionsFileUrl',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Caption (ASR) content',
+ 'title' => 'Caption (ASR) Content ',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['title' => 'Start time of the current sentence: milliseconds ', 'description' => 'Sentence start time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'required' => false],
+ 'endTime' => ['title' => 'End time of the current sentence: milliseconds ', 'description' => 'Sentence end time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'required' => false],
+ 'text' => ['title' => 'Content ', 'description' => 'Content', 'type' => 'string', 'example' => '你好', 'required' => false],
+ 'speaker' => ['title' => 'Role ', 'description' => 'Character', 'type' => 'string', 'example' => '张三', 'required' => false],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => 'xxx',
+ 'example' => '',
],
],
[
- 'name' => 'otherReviewPoints',
+ 'name' => 'autoRoleRecognitionVideoUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Separate video URL for automatic recognition', 'type' => 'string', 'required' => false, 'example' => 'http://', 'title' => ''],
+ ],
+ [
+ 'name' => 'splitType',
'in' => 'formData',
+ 'schema' => ['title' => 'Shot segmentation pattern: minDuration (enforces a minimum shot duration), fixDuration (segments shots at fixed intervals). The default pattern is minDuration.', 'description' => 'Shot segmentation type: minDuration (enforces minimum shot length), fixDuration (segments by fixed duration). Default: minDuration.', 'type' => 'string', 'example' => 'fixDuration', 'required' => false],
+ ],
+ [
+ 'name' => 'videoUrls',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '其他评审要点',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Multiple video URLs',
+ 'title' => 'Multiple video URLs ',
+ 'type' => 'array',
+ 'items' => ['title' => 'Video URL ', 'description' => 'Video URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxx'],
'required' => false,
- 'example' => 'xxx',
+ 'example' => '',
],
],
[
- 'name' => 'modelId',
+ 'name' => 'addDocumentParam',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '模型ID',
- 'type' => 'string',
+ 'description' => 'When a dataset is specified, video understanding results are uploaded to Miaosou along with the video as metadata.',
+ 'title' => 'Results are automatically saved (automatically uploaded to the Miaosou dataset)',
+ 'type' => 'object',
+ 'properties' => [
+ 'datasetId' => ['title' => 'Dataset ID', 'description' => 'Dataset ID: Required if uploading to Miaosou.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '890'],
+ 'datasetName' => ['title' => 'Dataset Name', 'description' => 'Dataset name', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'document' => [
+ 'description' => 'Miaosou upload parameters. If omitted, values are auto-generated.',
+ 'title' => 'Video auto-save parameters',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => 'Video Name', 'description' => 'Video title', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'docId' => ['title' => 'Video docId', 'description' => 'Unique document business ID. Duplicates are rejected within the same dataset.', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'categoryUuid' => ['title' => 'UUID of the category ', 'description' => 'Unique category identifier', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'tags' => [
+ 'description' => 'Tags',
+ 'title' => 'Label',
+ 'type' => 'array',
+ 'items' => ['title' => 'Label ', 'description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'extend1' => ['title' => 'Extension field', 'description' => 'Extension field 1', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend2' => ['title' => 'Extension field', 'description' => 'Extension field 2', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend3' => ['title' => 'Extension field', 'description' => 'Extension field 3', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'metadata' => [
+ 'description' => 'Metadata',
+ 'title' => 'Dictionary ',
+ 'type' => 'object',
+ 'properties' => [
+ 'keyValues' => [
+ 'description' => 'Key-value structured metadata',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Key-value structured metadata',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'Field name', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
+ 'value' => ['description' => 'Field value', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'description' => 'Streaming output header containing general response information',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'InvalidParam', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Pop sign mismatch, please check log.', 'title' => ''],
+ 'event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'task-progress-start-generating', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => '可空', 'title' => ''],
+ 'sessionId' => ['description' => 'Unique identifier for the generation session', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'taskId' => ['description' => 'Unique task identifier', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'traceId' => ['description' => 'Trace ID for request tracking', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'description' => 'Generated result data',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'description' => 'Output content object',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
+ 'videoAnalysisResult' => [
+ 'description' => 'Video language (VL) generation result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Generated content', 'type' => 'string', 'example' => '根据xxx', 'title' => ''],
+ 'usage' => [
+ 'description' => 'Token count',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'imageTokens' => ['description' => 'Number of tokens used for image recognition', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoShotAnalysisResults' => [
+ 'description' => 'Language analysis results for each video shot. Due to large size, retrieve from resultJsonFileUrl.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Language analysis result for each video shot',
+ 'type' => 'object',
+ 'properties' => [
+ 'endTime' => ['description' => 'End time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'startTime' => ['description' => 'Start time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'text' => ['description' => 'Generated content for the shot', 'type' => 'string', 'example' => '根据xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'modelId' => ['title' => 'UUID of the model actually used ', 'description' => 'Actual model identifier used', 'type' => 'string', 'example' => 'qwen-vl-max'],
+ ],
+ 'title' => '',
'example' => '',
],
- 'score' => [
- 'title' => '作文审阅得分',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
+ 'videoCaptionResult' => [
+ 'description' => 'Video caption result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'videoCaptions' => [
+ 'description' => 'List of video captions',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Video caption',
+ 'type' => 'object',
+ 'properties' => [
+ 'endTime' => ['description' => 'End time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''],
+ 'endTimeFormat' => ['description' => 'Formatted end time, e.g., 00:01', 'type' => 'string', 'example' => '00:01', 'title' => ''],
+ 'startTime' => ['description' => 'Start time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'startTimeFormat' => ['description' => 'Formatted start time, e.g., 00:01', 'type' => 'string', 'example' => '00:01', 'title' => ''],
+ 'text' => ['description' => 'Caption content', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'speaker' => ['title' => 'role ', 'description' => 'Character', 'type' => 'string', 'example' => '张三'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoGenerateResult' => [
+ 'description' => 'Video summary result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Video summary content', 'type' => 'string', 'example' => '根据xxx', 'title' => ''],
+ 'usage' => [
+ 'description' => 'Token count',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'modelId' => ['title' => 'UUID of the model actually used', 'description' => 'Actual model identifier used', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelReduce' => ['title' => 'Whether model downgrade occurred: If the max model is used and the system determines that the prompt input exceeds the upper limit, it attempts to downgrade to qwen-plus-latest. ', 'description' => 'Indicates whether the model was downgraded. If the model is qwen-max or qwen-max-latest and exceeds the prompt input limit, the system attempts to downgrade to qwen-plus-latest to preserve information integrity.', 'type' => 'boolean', 'example' => 'qwen-plus-latest'],
+ 'reasonText' => ['description' => 'Model reasoning process', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'index' => ['description' => 'Multi-task index, starting from 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoMindMappingGenerateResult' => [
+ 'description' => 'Video mind map result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Raw generated content', 'type' => 'string', 'example' => '根据xxx', 'title' => ''],
+ 'usage' => [
+ 'description' => 'Token count',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoMindMappings' => [
+ 'description' => 'Mind map',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Mind map',
+ 'type' => 'object',
+ 'properties' => [
+ 'childNodes' => [
+ 'description' => 'Child nodes',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Child nodes',
+ 'type' => 'object',
+ 'properties' => [
+ 'childNodes' => [
+ 'description' => 'Child nodes',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Child nodes',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '三级', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '二级', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'name' => ['description' => 'Node description', 'type' => 'string', 'example' => '一级', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'modelId' => ['title' => 'UUID of the actual model used', 'description' => 'Actual model identifier used', 'type' => 'string', 'example' => 'true'],
+ 'modelReduce' => ['title' => 'Whether model downgrade occurred: If the max model is used and the system determines that the prompt input exceeds the upper limit, it attempts to downgrade to qwen-plus-latest. ', 'description' => 'Indicates whether the model was downgraded. If the model is qwen-max or qwen-max-latest and exceeds the prompt input limit, the system attempts to downgrade to qwen-plus-latest to preserve information integrity.', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoTitleGenerateResult' => [
+ 'description' => 'Video title result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'text' => ['description' => 'Generated content', 'type' => 'string', 'example' => '标题', 'title' => ''],
+ 'usage' => [
+ 'description' => 'Token count',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'modelId' => ['title' => 'UUID of the model actually used', 'description' => 'Actual model identifier used', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelReduce' => ['title' => 'modelReduce ', 'description' => 'Indicates whether the model was downgraded. If the model is qwen-max or qwen-max-latest and exceeds the prompt input limit, the system attempts to downgrade to qwen-plus-latest to preserve information integrity.', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoShotSnapshotResult' => [
+ 'description' => 'Shot frame sampling result. Due to large size, retrieve from resultJsonFileUrl.',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoShots' => [
+ 'description' => 'List of segments',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Segment',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'Start time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'endTime' => ['description' => 'End time in milliseconds (relative time)', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'startTimeFormat' => ['description' => 'Formatted start time, e.g., 00:01', 'type' => 'string', 'example' => '00:01', 'title' => ''],
+ 'endTimeFormat' => ['description' => 'Formatted end time, e.g., 00:01', 'type' => 'string', 'example' => '00:02', 'title' => ''],
+ 'videoSnapshots' => [
+ 'description' => 'List of frames',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Frame',
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['description' => 'Frame URL: Publicly accessible URL with expiration. Download before it expires.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'resultJsonFileUrl' => ['title' => 'URL of the full result file: '."\n"
+ ."\n"
+ .'Because the response result is too large, partial data retrieval is provided via a file. You can download the file using the URL in this field and parse it for use. '."\n"
+ ."\n"
+ .'Currently included fields: '."\n"
+ .'- videoShotSnapshotResult (frame extraction information per shard); for data structure definition, see the RunVideoAnalysis API '."\n"
+ ."\n"
+ .'Other fields remain unchanged and are returned in text format. '."\n"
+ .'File type: JSON '."\n"
+ .'File content: Full message, including the data returned in text format '."\n"
+ .'Returned event: task-finished '."\n", 'description' => 'Result JSON file URL:'."\n"
+ ."\n"
+ .'Due to large response size, some data is provided via file download. Use this URL to download and parse the file:'."\n"
+ ."\n"
+ .'- Fields included (see RunVideoAnalysis API for structure):'."\n"
+ ."\n"
+ .' - videoShotSnapshotResult: Frame info per segment, including frame URLs'."\n"
+ ."\n"
+ .' - videoShotAnalysisResults: Detailed language analysis per segment'."\n"
+ ."\n"
+ .'- Other fields are returned directly in the response.'."\n"
+ ."\n"
+ .'- File type: JSON'."\n"
+ ."\n"
+ .'- File content: Full response payload, including fields returned via streaming. Look for event: task-finished.', 'type' => 'string', 'example' => 'http://'],
+ 'videoGenerateResults' => [
+ 'description' => 'When multiple tasks are specified (textProcessTasks is provided), results appear here. Locate results by array index or the index field (starting from 1).',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Text analysis result',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => 'Indicates whether the current task has finished generating', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'example' => 'qwen-max-latest', 'title' => ''],
+ 'index' => ['description' => 'Index, starting from 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'text' => ['description' => 'Video summary content', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'reasonText' => ['description' => 'Model reasoning process', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'usage' => [
+ 'description' => 'Usage',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'videoRoleRecognitionResult' => [
+ 'description' => 'Automatic recognition result',
+ 'title' => 'Auto detection result ',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoRoles' => [
+ 'description' => 'List of characters',
+ 'title' => 'Role list ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'roleName' => ['description' => 'Character name', 'type' => 'string', 'example' => 'test-role', 'title' => ''],
+ 'roleInfo' => ['description' => 'Character description', 'type' => 'string', 'example' => '角色身份', 'title' => ''],
+ 'timeIntervals' => [
+ 'description' => 'Appearance time segments',
+ 'title' => 'Time segments when the character appears',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'Start time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'endTime' => ['description' => 'End time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1735535279000', 'title' => ''],
+ 'timestamp' => ['title' => 'Time when the role appears ', 'description' => 'Character appearance time', 'type' => 'integer', 'format' => 'int64', 'example' => '23333333'],
+ 'url' => ['description' => 'Image URL', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qtgazV1oZ3djafcFz_!!6000000005238-0-tps-1540-1540.jpg', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'ratio' => ['title' => 'Appearance ratio', 'description' => 'Appearance rate', 'type' => 'number', 'format' => 'float', 'example' => '0.06'],
+ 'isAutoRecognition' => ['description' => 'Indicates whether automatic recognition uses a separate video URL. If true, profile pictures cannot be matched to video frames by timestamp because they may come from a different video.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'videoCalculatorResult' => [
+ 'description' => 'Cost estimation result',
+ 'title' => 'Fee estimation result',
+ 'type' => 'object',
+ 'properties' => [
+ 'items' => [
+ 'description' => 'Billing item details',
+ 'title' => 'Billing item details',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Billing item details',
+ 'title' => 'Billing Item Details ',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => 'Billing item name', 'description' => 'Billing item name', 'type' => 'string', 'example' => 'xxx'],
+ 'type' => ['title' => 'Billing item type', 'description' => 'Billing item type', 'type' => 'string', 'example' => '模型推理'],
+ 'inputToken' => ['title' => 'Input tokens ', 'description' => 'Input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'outputToken' => ['title' => 'Output tokens ', 'description' => 'Output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'time' => ['title' => 'Billing duration', 'description' => 'Billed duration', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ 'inputExpense' => ['title' => 'Input token price ', 'description' => 'Input token cost', 'type' => 'number', 'format' => 'double', 'example' => '0.234'],
+ 'outputExpense' => ['title' => 'Output token price', 'description' => 'Output token cost', 'type' => 'number', 'format' => 'double', 'example' => '0.124'],
+ 'timeExpense' => ['title' => 'Time-based billing', 'description' => 'Time-based cost', 'type' => 'number', 'format' => 'double', 'example' => '0.02'],
+ 'totalExpense' => ['title' => 'Total billing', 'description' => 'Total cost', 'type' => 'number', 'format' => 'double', 'example' => '0.378'],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'addDatasetDocumentsResult' => [
+ 'description' => 'Auto-save execution result',
+ 'title' => 'Automatically save execution result',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['title' => 'Auto-save job status: 1 Succeeded, 0 failed ', 'description' => 'Auto-save task status: 1 = success, 0 = failure', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'title' => ['title' => 'Video Name ', 'description' => 'Video title', 'type' => 'string', 'example' => 'xxx'],
+ 'docId' => ['title' => 'Video docId', 'description' => 'Video docId', 'type' => 'string', 'example' => 'xxx'],
+ 'errorMessage' => ['title' => 'If automatic saving failed, output the error message', 'description' => 'If auto-save fails, this field contains the error message.', 'type' => 'string', 'example' => 'xxx'],
+ 'docUuid' => ['title' => 'Video docUuid', 'description' => 'Video docUuid', 'type' => 'string', 'example' => 'uuid'],
+ ],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'description' => 'Token count',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"审阅结果\\\\n\\\\n\\",\\n \\"score\\": 50\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
- ],
- 'RunOcrParse' => [
- 'summary' => '作业批改',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runOcrParse',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"InvalidParam\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-progress-start-generating\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"sessionId\\": \\"xxx\\",\\n \\"taskId\\": \\"xxx\\",\\n \\"traceId\\": \\"2150432017236011824686132ecdbc\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoAnalysisResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2,\\n \\"imageTokens\\": 20\\n },\\n \\"videoShotAnalysisResults\\": [\\n {\\n \\"endTime\\": 10000,\\n \\"startTime\\": 1000,\\n \\"text\\": \\"根据xxx\\"\\n }\\n ],\\n \\"modelId\\": \\"qwen-vl-max\\"\\n },\\n \\"videoCaptionResult\\": {\\n \\"generateFinished\\": true,\\n \\"videoCaptions\\": [\\n {\\n \\"endTime\\": 20000,\\n \\"endTimeFormat\\": \\"00:01\\",\\n \\"startTime\\": 1000,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"text\\": \\"xxx\\",\\n \\"speaker\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"videoGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelReduce\\": true,\\n \\"reasonText\\": \\"xxx\\",\\n \\"index\\": 1\\n },\\n \\"videoMindMappingGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"根据xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"videoMindMappings\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"childNodes\\": [\\n {\\n \\"name\\": \\"三级\\"\\n }\\n ],\\n \\"name\\": \\"二级\\"\\n }\\n ],\\n \\"name\\": \\"一级\\"\\n }\\n ],\\n \\"modelId\\": \\"true\\",\\n \\"modelReduce\\": true\\n },\\n \\"videoTitleGenerateResult\\": {\\n \\"generateFinished\\": true,\\n \\"text\\": \\"标题\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n },\\n \\"modelId\\": \\"qwen-max\\",\\n \\"modelReduce\\": true\\n },\\n \\"videoShotSnapshotResult\\": {\\n \\"videoShots\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 0,\\n \\"startTimeFormat\\": \\"00:01\\",\\n \\"endTimeFormat\\": \\"00:02\\",\\n \\"videoSnapshots\\": [\\n {\\n \\"url\\": \\"http://xxx\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"resultJsonFileUrl\\": \\"http://\\",\\n \\"videoGenerateResults\\": [\\n {\\n \\"generateFinished\\": true,\\n \\"modelId\\": \\"qwen-max-latest\\",\\n \\"index\\": 1,\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n }\\n ],\\n \\"videoRoleRecognitionResult\\": {\\n \\"videoRoles\\": [\\n {\\n \\"roleName\\": \\"test-role\\",\\n \\"roleInfo\\": \\"角色身份\\",\\n \\"timeIntervals\\": [\\n {\\n \\"startTime\\": 0,\\n \\"endTime\\": 1735535279000,\\n \\"timestamp\\": 23333333,\\n \\"url\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qtgazV1oZ3djafcFz_!!6000000005238-0-tps-1540-1540.jpg\\"\\n }\\n ],\\n \\"ratio\\": 0.06,\\n \\"isAutoRecognition\\": true\\n }\\n ]\\n },\\n \\"videoCalculatorResult\\": {\\n \\"items\\": [\\n {\\n \\"name\\": \\"xxx\\",\\n \\"type\\": \\"模型推理\\",\\n \\"inputToken\\": 123,\\n \\"outputToken\\": 13,\\n \\"time\\": 9,\\n \\"inputExpense\\": 0.234,\\n \\"outputExpense\\": 0.124,\\n \\"timeExpense\\": 0.02,\\n \\"totalExpense\\": 0.378\\n }\\n ]\\n },\\n \\"addDatasetDocumentsResult\\": {\\n \\"status\\": 1,\\n \\"title\\": \\"xxx\\",\\n \\"docId\\": \\"xxx\\",\\n \\"errorMessage\\": \\"xxx\\",\\n \\"docUuid\\": \\"uuid\\"\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 1,\\n \\"totalTokens\\": 2\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
+ 'title' => 'Video Understanding - Online Job ',
+ 'description' => 'Alibaba Cloud Model Studio Light App – Video Understanding: This API accepts a video input and performs tasks such as caption extraction, video content analysis, video summarization, title generation, and mind map creation. You can also use a custom prompt to generate differentiated video content.'."\n"
+ ."\n"
+ .'- Try it directly at [Light App – Video Understanding for Film and Media](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend).'."\n"
+ ."\n"
+ .'- To call the API using an SDK, refer to the examples under the “API” tab in the Video Understanding console.'."\n"
+ .' ><notice>When calling this API via SDK, note that the **Debug** section of the OpenAPI portal has limited support for the SSE protocol. We recommend following the **call examples**. For details, go to [**Light App – Video Understanding for Film and Media**](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend) and switch to the **API tab**.></notice>'."\n"
+ ."\n"
+ .'## API and SDK usage'."\n"
+ ."\n"
+ .'### API overview'."\n"
+ ."\n"
+ .'There are **2** ways to call the Video Understanding API, corresponding to two endpoints:'."\n"
+ ."\n"
+ .'- Call the [asynchronous offline API](https://help.aliyun.com/zh/model-studio/user-guide/api-quanmiaolightapp-2024-08-01-submitvideoanalysistask?spm=a2c4g.11186623.help-menu-2400256.d_1_2_4_3_1_3_3_1.3b2e46c2wjL7dc\\&scm=20140722.H_2867156._.OR_help-T_cn~zh-V_1) (**recommended**): Supports 2 concurrent requests by default. You can increase concurrency up to 10 through configuration. For higher workloads, contact customer support (or operations) to request additional concurrency. This method does not require waiting for execution to complete, uses asynchronous scheduling, and the concurrency limit equals the number of tasks running simultaneously in the backend. Tasks exceeding the concurrency limit are queued. The SDK supports most programming languages, and you can debug or use the API directly in the OpenAPI portal. You can also view demo code in the [**Light App – Video Understanding for Film and Media**](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend) console under the “API” tab.'."\n"
+ ."\n"
+ .'- Call the [synchronous online API](https://help.aliyun.com/zh/model-studio/user-guide/api-quanmiaolightapp-2024-08-01-runvideoanalysis?spm=a2c4g.11186623.help-menu-2400256.d_1_2_4_3_1_3_3_0.396c36b9Pjqtm9\\&scm=20140722.H_2846254._.OR_help-T_cn~zh-V_1) (**not recommended**): This document describes this endpoint. It supports only **1** global concurrent request. You must keep the connection open while waiting for results. The SDK supports only Java and Python. The OpenAPI portal does not support debugging or calling this endpoint via SSE (copied code cannot be used directly). Use this method only for light testing. View demo code in the [**Light App – Video Understanding for Film and Media**](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend) console under the “API” tab.'."\n"
+ ."\n"
+ .'### Synchronous online API usage'."\n"
+ ."\n"
+ .'We recommend using the SDK for Java (asynchronous SDK) or **Python**. The Java (asynchronous SDK) dependency is as follows:'."\n"
+ ."\n"
+ .'```JSON'."\n"
+ .'<dependency>'."\n"
+ .' <groupId>com.aliyun</groupId>'."\n"
+ .' <artifactId>alibabacloud-quanmiaolightapp20240801</artifactId>'."\n"
+ .' <version>Use the latest version</version>'."\n"
+ .' </dependency>'."\n"
+ .'```'."\n"
+ ."\n"
+ .'- Obtain the [latest Java (asynchronous) dependency](https://api.aliyun.com/api-tools/sdk/QuanMiaoLightApp?version=2024-08-01\\&language=java-async-tea\\&tab=primer-doc).'."\n"
+ ."\n"
+ .'- Obtain your [AccessKey ID and AccessKey secret](~~2587494~~).'."\n"
+ ."\n"
+ .'- Obtain your [Workspace ID](~~2782167~~).'."\n"
+ ."\n"
+ .'## Permissions'."\n"
+ ."\n"
+ .'### Prerequisites'."\n"
+ ."\n"
+ .'- Log on to the Alibaba Cloud Model Studio console and confirm that the service is active and available.'."\n"
+ ."\n"
+ .'- Alibaba Cloud account calls: Full API access permissions are granted by default.'."\n"
+ ."\n"
+ .'- RAM user calls: RAM users have no permissions (AccessForbid) to call this API by default. You must grant permissions in both the **RAM console** and the **Alibaba Cloud Model Studio console**.'."\n"
+ ."\n"
+ .'### RAM console authorization'."\n"
+ ."\n"
+ .'Go to the [RAM console](https://ram.console.aliyun.com/users) to grant permissions. For detailed steps, see the [RAM documentation](https://help.aliyun.com/zh/ram/user-guide/create-a-custom-policy):'."\n"
+ ."\n"
+ .'#### Option 1 (recommended): Grant a built-in policy'."\n"
+ ."\n"
+ .'Grant the RAM user the [AliyunQuanMiaoLightAppFullAccess](https://ram.console.aliyun.com/policies/AliyunQuanMiaoLightAppFullAccess/System/content) permission.'."\n"
+ ."\n"
+ .'To also allow console access, grant the [AliyunAiMiaoBiFullAccess](https://ram.console.aliyun.com/policies/AliyunAiMiaoBiFullAccess/System/content) permission.'."\n"
+ ."\n"
+ .'#### Option 2: Create and assign a custom policy'."\n"
+ ."\n"
+ .'Use this option for fine-grained control over API-level access.'."\n"
+ ."\n"
+ .'- **Create a custom authorization policy**: Under the **Permission Management > Policies** menu, create a policy using the script editor. Use one of the following JSON examples to authorize specific APIs, such as RunVideoAnalysis for video understanding.'."\n"
+ ."\n"
+ .'```JSON'."\n"
+ .'{'."\n"
+ .' "Version": "1",'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Action": "quanmiaolightapp:RunVideoAnalysis",'."\n"
+ .' "Resource": "*"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'To also allow console access, grant the following API permission:'."\n"
+ ."\n"
+ .'```JSON'."\n"
+ .'{'."\n"
+ .' "Version": "1",'."\n"
+ .' "Statement": ['."\n"
+ .' {'."\n"
+ .' "Effect": "Allow",'."\n"
+ .' "Action": "aimiaobi:GetVideoAnalysisConfig",'."\n"
+ .' "Resource": "*"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'- **Assign the policy to a RAM user**: Under the **Identity Management > Users** menu, find the target user, add a new authorization, switch to custom policies, and attach the policy you created above.'."\n"
+ ."\n"
+ .'### Alibaba Cloud Model Studio console authorization'."\n"
+ ."\n"
+ .'Use your Alibaba Cloud account or a RAM user with administrative permissions for Model Studio to log on to the console. Add the RAM user on the [Permission Management > User Management](https://bailian.console.aliyun.com/?tab=app#/authority) page.'."\n"
+ ."\n"
+ .'## Input parameter value guidelines'."\n"
+ ."\n"
+ .'### Frame sampling configuration (frameSampleMethod)'."\n"
+ ."\n"
+ .'These parameters control frame sampling, including interval and resolution. The default sampling method is Standard. Three methods are available: Standard, Fast/Lower Cost, and Custom.'."\n"
+ ."\n"
+ .'- When using the “Standard” method, the system applies built-in parameters. You do not need to define the interval or pixel values. The rules for these values are:'."\n"
+ ."\n"
+ .' - Based on video duration, the system selects a preset tier. See the “?” tooltip next to “Recommended range 1.0–6.0” and “Recommended range 650–750” under Advanced Features > Frame Sampling Method > Custom in the [Video Understanding console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend), under the “Effect Debugging” tab.'."\n"
+ ."\n"
+ .' - Map video duration to the nearest tier. If equidistant, choose the tier with the longer duration.'."\n"
+ ."\n"
+ .'- When using the “Fast/Lower Cost” method, the system applies internally calculated parameters. You do not need to define interval or pixel values.'."\n"
+ ."\n"
+ .'- When using the “Custom” method, you must provide both interval and pixel values. Valid ranges depend on video duration and are calculated as follows:'."\n"
+ ."\n"
+ .' - Minimum interval = max(Standard interval − 0.2, 1)'."\n"
+ ."\n"
+ .' - Maximum interval = Standard interval + 5'."\n"
+ ."\n"
+ .' - Minimum pixel = max(Standard pixel − 50, 300)'."\n"
+ ."\n"
+ .' - Maximum pixel = Standard pixel + 50'."\n"
+ ."\n"
+ .'## Agent integration'."\n"
+ ."\n"
+ .'Agents can use video understanding capabilities directly through a Skill:'."\n"
+ ."\n"
+ .'- **Skill name**: `alibabacloud-bailian-videoanalysis`'."\n"
+ ."\n"
+ .'- **Skill URL**: <https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis>',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-11-24T13:17:56.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-10-17T01:54:58.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-03-27T09:29:33.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-18T05:48:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-01-15T11:40:37.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-01-14T12:12:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-12-05T11:47:13.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-09-26T10:46:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-09-05T05:01:32.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunVideoDetectShot' => [
+ 'summary' => 'Lightweight Application - Video Splitting\\'."\n"
+ .'\\'."\n"
+ .'To use video splitting, you must first activate the Media and Entertainment Video Understanding service, which is free. You can activate it at: https://bailian.console.aliyun.com/?tab=app#/app/app-market/quanmiao/video-comprehend\\'."\n"
+ .'\\'."\n"
+ .'Currently, video splitting supports video processing in the following three scenarios:\\'."\n"
+ .'1\\. TV programs\\'."\n"
+ .'2\\. News\\'."\n"
+ .'3\\. Other\\'."\n"
+ .'\\'."\n"
+ .'For detailed usage recommendations and sample prompts, see the Additional Information section below.\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoDetectShot',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'URL of the video file', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.mp4', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Valid values:'."\n"
+ ."\n"
+ .'- deepseek-r1'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ ."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-llm-plus'."\n"
+ ."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'deepseek-r1', 'title' => ''],
+ ],
+ [
+ 'name' => 'options',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Method used for scene detection. Valid value: ASR',
+ 'type' => 'array',
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR', 'title' => ''],
'required' => true,
- 'example' => 'llm-xxx',
+ 'example' => '',
],
],
[
- 'name' => 'url',
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '图片URL(url与fileKey二选一)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
- ],
+ 'schema' => ['description' => 'Unique identifier of the task', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'title' => ''],
],
[
- 'name' => 'fileKey',
+ 'name' => 'originalSessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier of the original task. To rerun a subtask based on a previous task, pass in the previous task ID and originalSessionId. The system loads previously generated data and skips earlier steps to improve efficiency. If the stored data is older than seven days, the system reruns all dependent subtasks.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax', 'title' => ''],
+ ],
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Custom prompt for the large language model', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplateId',
'in' => 'formData',
+ 'schema' => ['description' => 'ID of the prompt template used by the large language model to generate video-splitting results', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'videoDetectShotShowPrompt'],
+ ],
+ [
+ 'name' => 'modelVlCustomPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the prompt template used for visual-language recognition', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'videoDetectShotVlShowPrompt'],
+ ],
+ [
+ 'name' => 'recognitionOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt',
+ 'description' => 'Methods used to recognize content in each scene. Valid values: ASR, OCR, VL. You can select multiple options.',
+ 'type' => 'array',
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR', 'title' => ''],
+ 'required' => true,
+ 'example' => '',
],
],
[
- 'name' => 'modelId',
+ 'name' => 'intelliSimpPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'ID of the prompt template used to simplify input for the large language model', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'intelliSimpShowPrompt'],
+ ],
+ [
+ 'name' => 'preModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Valid values:'."\n"
+ ."\n"
+ .'- deepseek-r1'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ ."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-llm-plus'."\n"
+ ."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'example' => 'quanmiao-llm-max', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'intelliSimpPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Custom prompt used to simplify input for the large language model', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'vlPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Custom prompt for visual-language recognition', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'language',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Speech recognition language:'."\n"
+ ."\n"
+ .'chinese: Chinese (default)'."\n"
+ .'french: French'."\n"
+ .'english: English'."\n"
+ .'japanese: Japanese'."\n"
+ .'chineseEnglishFreely: Chinese and English mixed'."\n"
+ .'arabic: Arabic'."\n"
+ .'korean: Korean'."\n"
+ .'malay: Malay'."\n"
+ .'thai: Thai'."\n"
+ .'portuguese: Portuguese'."\n"
+ .'spanish: Spanish'."\n"
+ .'indonesian: Indonesian'."\n"
+ .'vietnamese: Vietnamese', 'type' => 'string', 'example' => 'chinese', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
'header' => [
- 'title' => '消息头',
- 'description' => '',
+ 'description' => 'Streaming response header. Contains general response information.',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AccessForbidden',
- ],
- 'errorMessage' => [
- 'title' => '错误描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'sessionId' => [
- 'title' => '会话唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'traceId' => [
- 'title' => '全链路唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
+ 'errorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'InvalidParam', 'title' => ''],
+ 'errorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Pop sign mismatch, please check log.', 'title' => ''],
+ 'event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'task-finished', 'title' => ''],
+ 'eventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => '可空', 'title' => ''],
+ 'sessionId' => ['description' => 'Unique identifier of the session', 'type' => 'string', 'example' => '14d15c78c4c34d428212f4d923d4ede1', 'title' => ''],
+ 'taskId' => ['description' => 'Unique identifier of the task', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'traceId' => ['description' => 'Unique identifier for the full request trace', 'type' => 'string', 'example' => '3b5287b317477940746851672dca0c', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'payload' => [
- 'title' => '消息体',
- 'description' => '',
+ 'description' => 'Generated result data',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出结果',
- 'description' => '',
+ 'description' => 'Output object',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '',
- 'type' => 'string',
+ 'videoSplitResult' => [
+ 'description' => 'Result',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'Video-splitting result', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'reasonText' => ['description' => 'Deep thinking result', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'videoParts' => [
+ 'title' => '',
+ 'description' => 'Structured video-splitting result. If structuring fails, this field is omitted. Parse the result from the text field instead. Customize this structure using a prompt. For details, see modelCustomPromptTemplateId (retrieve with the /getLightAppGeneralConfig API).',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'xxx', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'videoRecognitionResult' => [
+ 'title' => '',
+ 'description' => 'List of video recognition results. Results depend on the recognitionOptions you specify.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'Start time of this recognition result', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1756433675000'],
+ 'endTime' => ['description' => 'End time of this recognition result', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1755742611000'],
+ 'asr' => ['description' => 'Speech-to-text result', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'ocr' => ['description' => 'OCR result — text detected in the video frame', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'vl' => ['description' => 'Visual-language recognition result — description of the video frame content', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'usage' => [
- 'title' => 'token消耗',
- 'description' => '',
+ 'description' => 'Token usage',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '4546', 'title' => ''],
+ 'outputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '820', 'title' => ''],
+ 'totalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '5366', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '58868FD6-53D7-5ACD-80F7-854C8EA256EF'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"InvalidParam\\",\\n \\"errorMessage\\": \\"Pop sign mismatch, please check log.\\",\\n \\"event\\": \\"task-finished\\",\\n \\"eventInfo\\": \\"可空\\",\\n \\"sessionId\\": \\"14d15c78c4c34d428212f4d923d4ede1\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"3b5287b317477940746851672dca0c\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"videoSplitResult\\": {\\n \\"text\\": \\"xxx\\",\\n \\"reasonText\\": \\"xxx\\",\\n \\"videoParts\\": [\\n {\\n \\"key\\": \\"xxx\\"\\n }\\n ],\\n \\"videoRecognitionResult\\": [\\n {\\n \\"startTime\\": 1756433675000,\\n \\"endTime\\": 1755742611000,\\n \\"asr\\": \\"xxx\\",\\n \\"ocr\\": \\"xxx\\",\\n \\"vl\\": \\"xxx\\"\\n }\\n ]\\n }\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 4546,\\n \\"outputTokens\\": 820,\\n \\"totalTokens\\": 5366\\n }\\n },\\n \\"requestId\\": \\"58868FD6-53D7-5ACD-80F7-854C8EA256EF\\"\\n}","type":"json"}]',
+ 'title' => 'Intelligent Clip Extraction - Online Job ',
+ 'extraInfo' => 'Currently, clip splitting supports processing videos in three scenarios: '."\n"
+ .'1. Program scenario '."\n"
+ .'2. News scenario '."\n"
+ .'3. Other scenarios '."\n"
+ ."\n"
+ .'For videos in the program scenario: '."\n"
+ .'- It is recommended to use ASR-based shot segmentation and select ASR+VL for video recognition. '."\n"
+ .'- For `modelVlCustomPromptTemplateId`, it is recommended to choose the program VL template (`videoDetectShotVlShowPrompt`) or customize the prompt via the `vlPrompt` field. '."\n"
+ .'- For `modelCustomPromptTemplateId`, it is recommended to choose the program template (`videoDetectShotShowPrompt`) or customize the prompt via the `prompt` field. '."\n"
+ .'- It is recommended to enable the simplified LLM input parameter text feature (using `intelliSimpPromptTemplateId` or `intelliSimpPrompt`). '."\n"
+ .'- When `intelliSimpPromptTemplateId` is set to `intelliSimpShowPrompt`, it is recommended to use `videoDetectShotShowPrompt` for `modelCustomPromptTemplateId`. '."\n"
+ .'- When `intelliSimpPromptTemplateId` is set to `intelliSimpSecondShowPrompt`, it is recommended to use `videoDetectShotSecondShowPrompt` for `modelCustomPromptTemplateId`. '."\n"
+ .'- It is recommended to use `deepseek-v3.1` for `preModelId` and `deepseek-r1` for `modelId`. '."\n"
+ ."\n"
+ .'For videos in the news scenario: '."\n"
+ .'- Since audio in news videos is typically clear and standardized, it is recommended to use ASR-only for video content recognition and perform shot segmentation using ASR. '."\n"
+ .'- If VL is enabled (not recommended), it is recommended to choose the news VL template (`videoDetectShotVlNewsPrompt`) for `modelVlCustomPromptTemplateId` or customize the prompt via the `vlPrompt` field. '."\n"
+ .'- For `modelCustomPromptTemplateId`, it is recommended to choose the news template (`videoDetectShotNewsPrompt`) or customize the prompt via the `prompt` field. '."\n"
+ .'- It is recommended to use `deepseek-v3.1` for `preModelId` and `deepseek-r1` for `modelId`. '."\n"
+ ."\n"
+ .'For videos in other scenarios: '."\n"
+ .'- If the audio is clear and covers the main information of the video, it is recommended to first try ASR-based shot segmentation and select ASR for video recognition. '."\n"
+ .'- If the video itself contains limited information or yields minimal results during the video recognition step, it is recommended to avoid using `intelliSimpPromptTemplateId` and `intelliSimpPrompt`. '."\n"
+ ."\n"
+ .'If you wish to customize prompts, refer to the following example templates: '."\n"
+ ."\n"
+ .' - name: videoDetectShotNewsPrompt'."\n"
+ .' # Role'."\n"
+ .' You are a professional news merging assistant. Please process the merging task for the given ordered news segments according to the following requirements.'."\n"
+ .' Core capabilities: Precise merging based on news subject + strict adherence to time annotations + intelligent title generation'."\n"
+ .' You must strictly follow the specified output format.'."\n"
+ ."\n"
+ .' # Input data format:'."\n"
+ .' Time range: [Start Time]-[End Time], Content: [X], Speaker ID: [Y]'."\n"
+ .' (Speaker ID refers to the ID of the current speaker)'."\n"
+ ."\n"
+ .' # Task execution steps:'."\n"
+ .' 0. Pre-processing:'."\n"
+ .' Read through the entire input, understand the meaning and subject of each news segment in context.'."\n"
+ ."\n"
+ .' 1. Compare two news segments:'."\n"
+ .' Compare the first and second news segments to determine if they can be merged into one segment.'."\n"
+ .' If mergeable, proceed to step 2; otherwise, proceed to step 3.'."\n"
+ ."\n"
+ .' 2. If mergeable:'."\n"
+ .' Merge the two segments into a new segment.'."\n"
+ .' The start time of the new segment is the start time of the first segment.'."\n"
+ .' The end time of the new segment is the end time of the second segment.'."\n"
+ .' Then, compare this newly merged segment with the next segment and repeat step 1.'."\n"
+ ."\n"
+ .' 3. If not mergeable:'."\n"
+ .' Treat the first segment as an independent news segment.'."\n"
+ .' Its start time remains unchanged.'."\n"
+ .' Its end time is set to one second before the start time of the second segment.'."\n"
+ .' Then, compare the second segment with the next segment and repeat step 1.'."\n"
+ ."\n"
+ .' # Merging criteria (merge if at least one condition is met):'."\n"
+ .' - Both segments belong to the same news subject.'."\n"
+ .' - It is unclear whether both segments belong to the same subject, but merging them does not introduce conflicts based on the provided information.'."\n"
+ ."\n"
+ .' # Sorting logic:'."\n"
+ .' Maintain the original time order.'."\n"
+ ."\n"
+ .' # Input example:'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let\'s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: xxxx, Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, Speaker ID: 1'."\n"
+ ."\n"
+ .' # Output format requirements:'."\n"
+ .' ## Output example:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime":"00:00:04",'."\n"
+ .' "endTime":"00:00:26",'."\n"
+ .' "title":"Weather Forecast",'."\n"
+ .' "summary":"Beijing\'s weather forecast for the day"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime":"00:00:27",'."\n"
+ .' "endTime":"00:00:45",'."\n"
+ .' "title":"International News",'."\n"
+ .' "summary":"Content of international news"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ .' ## Output data requirements:'."\n"
+ .' startTime: Start time in HH:mm:ss format '."\n"
+ .' endTime: End time in HH:mm:ss format '."\n"
+ .' title: Entry title, concisely summarizing the main event of the entry '."\n"
+ .' summary: Entry summary, concisely summarizing the core content of the entry'."\n"
+ ."\n"
+ .' # Please process the following input data:'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotShowPrompt'."\n"
+ .' ### **Ideal output result**'."\n"
+ .' Each program is isolated in its own time interval, and hosting content between programs is also isolated in its own interval.'."\n"
+ .' ### **Task requirements**'."\n"
+ .' You are a live program director. Based on the input time intervals:'."\n"
+ .' 1. **Merge consecutive intervals belonging to the same program** (same content/subject)'."\n"
+ .' 2. **Identify transition segments and handle them separately**'."\n"
+ .' 3. Generate a title and summary for each final interval'."\n"
+ .' 4. Merge consecutive transitions, advertisements, or other non-program content of the same subject into one time interval'."\n"
+ ."\n"
+ .' **Core rules**:'."\n"
+ .' 1. Title rules:'."\n"
+ .' - Program content: Reflect the core subject (e.g., "Sports News")'."\n"
+ .' - Transition content: Uniformly named "transition"'."\n"
+ .' - Do not fabricate program names not mentioned in the input'."\n"
+ .' 2. Merging rules:'."\n"
+ .' - Hosting segments, advertisements, and other transition content between programs must be merged into one interval if they appear consecutively. Any two of these three types appearing consecutively must be merged.'."\n"
+ .' - Consecutive intervals belonging to the same program must be merged into one interval.'."\n"
+ .' - Do not merge intervals from different programs.'."\n"
+ .' - Transitions must not be merged with program content.'."\n"
+ .' - Intervals without specific content must be merged with the previous interval, except for transitions, which must remain in their own interval (e.g., transition hosting).'."\n"
+ .' 3. Content summarization rules:'."\n"
+ .' - Summarize core content in one concise sentence (≤20 characters)'."\n"
+ .' - For multi-element content, focus on the most central subject'."\n"
+ .' - Avoid redundant descriptions of similar content'."\n"
+ .' - Ensure content independence without reliance on other intervals'."\n"
+ .' 4. Transition identification: Host linking segments and transitions without specific content are considered transitions'."\n"
+ ."\n"
+ .' **Output format**:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss",'."\n"
+ .' "endTime": "HH:mm:ss",'."\n"
+ .' "title": "Title",'."\n"
+ .' "summary": "Summary"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Processing flow:'."\n"
+ ."\n"
+ .' Scan time intervals sequentially'."\n"
+ .' Merge eligible intervals according to the above rules'."\n"
+ .' For each final interval:'."\n"
+ .' Identify if it is a transition → If yes: title = "transition"'."\n"
+ .' If not a transition → Extract core subject as title'."\n"
+ .' Summarize core content in one sentence'."\n"
+ ."\n"
+ .' ### **Sorting rule**'."\n"
+ .' - Maintain original time order.'."\n"
+ ."\n"
+ .' ### **Input example**'."\n"
+ .' ```'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let\'s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: Next is international news, today\'s major events include..., Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, latest match results are as follows..., Speaker ID: 1'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output format**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss", // Start Time'."\n"
+ .' "endTime": "HH:mm:ss", // End Time'."\n"
+ .' "title": "Entry Title", // Concise summary of the entry\'s subject'."\n"
+ .' "summary": "Entry Summary" // Summary of core content'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output example**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:04",'."\n"
+ .' "endTime": "00:00:26",'."\n"
+ .' "title": "Weather Forecast",'."\n"
+ .' "summary": "Introduce Beijing\'s weather conditions for the day."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:28",'."\n"
+ .' "endTime": "00:00:45",'."\n"
+ .' "title": "International News",'."\n"
+ .' "summary": "Report today\'s major international events."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:46",'."\n"
+ .' "endTime": "00:00:55",'."\n"
+ .' "title": "Sports News",'."\n"
+ .' "summary": "Update latest sporting event results."'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ .' ### **Please process the following input data**'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotSecondShowPrompt'."\n"
+ .' ### **Ideal output result**'."\n"
+ .' Each program is isolated in its own interval, and other content between programs is also isolated in its own interval.'."\n"
+ .' ### **Task requirements**'."\n"
+ .' You are a live program director. Based on the input time intervals:'."\n"
+ .' 1. Identify the type of program and classify non-program content (e.g., advertisements, announcements)'."\n"
+ .' 2. Merge consecutive intervals of the same program (same content/subject) and merge consecutive intervals of the same non-program content (same content/subject)'."\n"
+ .' 3. For program intervals, extract and summarize content; for non-program intervals (e.g., advertisements, announcements), extract and condense content into concise summaries. Short intervals of the same non-program type may be appropriately merged.'."\n"
+ .' 4. If the video contains multiple program intervals, segment and summarize each program separately; if the video contains only one program, segment and summarize based on different content/subjects within the program.'."\n"
+ .' 5. Identify the start and end times (accurate to the second) for each interval and generate a title, summary, start time, and end time for each final interval.'."\n"
+ ."\n"
+ .' **Core rules**:'."\n"
+ .' 1. Title rules:'."\n"
+ .' - Program content: Reflect the core subject (e.g., "Sports News")'."\n"
+ .' - Other content: Name based on summarized content, e.g., "transition", "advertisement"'."\n"
+ .' - Do not fabricate program names not mentioned in the input'."\n"
+ .' 2. Merging rules:'."\n"
+ .' - Must merge consecutive intervals of the same program'."\n"
+ .' - Do not merge intervals from different programs'."\n"
+ .' - Other content must not be merged with program content'."\n"
+ .' - Host introductions to programs must not be merged with the program interval'."\n"
+ .' - Intervals without specific content must be merged with the previous interval, except for transitions, which must remain in their own interval (e.g., transition hosting)'."\n"
+ .' 3. Content summarization rules:'."\n"
+ .' - Summarize core content in one concise sentence (≤20 characters)'."\n"
+ .' - For multi-element content, focus on the most central subject'."\n"
+ .' - Avoid redundant descriptions of similar content'."\n"
+ .' - Ensure content independence without reliance on other intervals'."\n"
+ .' 4. Transition identification: Host linking segments and transitions without specific content are considered transitions'."\n"
+ .' 5. Interval identification: Start and end times must be accurate to the second'."\n"
+ .' 6. The core task is to identify program content; non-program content must be summarized and categorized'."\n"
+ ."\n"
+ .' **Output format**:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss",'."\n"
+ .' "endTime": "HH:mm:ss",'."\n"
+ .' "title": "Title",'."\n"
+ .' "summary": "Summary"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Processing flow:'."\n"
+ ."\n"
+ .' Scan time intervals sequentially'."\n"
+ .' Merge consecutive intervals of the same content'."\n"
+ .' For each final interval:'."\n"
+ .' Identify if it is a program → If yes: title = extracted program content'."\n"
+ .' If not a program → title = summarized content type, e.g., "transition", "advertisement"'."\n"
+ .' Summarize core content in one sentence'."\n"
+ ."\n"
+ .' ### **Sorting rule**'."\n"
+ .' - Maintain original time order.'."\n"
+ ."\n"
+ .' ### **Input example**'."\n"
+ .' ```'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let\'s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: Next is international news, today\'s major events include..., Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, latest match results are as follows..., Speaker ID: 1'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output format**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss", // Start Time'."\n"
+ .' "endTime": "HH:mm:ss", // End Time'."\n"
+ .' "title": "Entry Title", // Concise summary of the entry\'s subject'."\n"
+ .' "summary": "Entry Summary" // Summary of core content'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output example**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:04",'."\n"
+ .' "endTime": "00:00:26",'."\n"
+ .' "title": "Weather Forecast",'."\n"
+ .' "summary": "Introduce Beijing\'s weather conditions for the day."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:28",'."\n"
+ .' "endTime": "00:00:45",'."\n"
+ .' "title": "International News",'."\n"
+ .' "summary": "Report today\'s major international events."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:46",'."\n"
+ .' "endTime": "00:00:55",'."\n"
+ .' "title": "Sports News",'."\n"
+ .' "summary": "Update latest sporting event results."'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ .' ### **Please process the following input data**'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotVlNewsPrompt'."\n"
+ .' # Task objective'."\n"
+ .' Please identify visual information from a set of images.'."\n"
+ .' # Output rules:'."\n"
+ .' - If no information is detected, output "none". Do not fabricate visual information. Language should be concise, clear, and natural.'."\n"
+ .' - Strictly follow the given output example format. Do not omit escape characters.'."\n"
+ .' - Output length must not exceed 100 characters. Emphasize the coherent narrative of the image sequence.'."\n"
+ .' # Output example:'."\n"
+ .' '."\n"
+ .'xxx'."\n"
+ ."\n\n"
+ .' - name: videoDetectShotVlShowPrompt'."\n"
+ .' # Task objective'."\n"
+ .' This is a set of sampled frames from a program. Please identify text and coherent plot elements from these images. (If a program name is present, incorporate it into the plot description. If no program name is present, do not include one. If host transitions between programs are detected, explicitly mark them in the output.)'."\n"
+ .' # Output rules:'."\n"
+ .' - If no information is detected, output "none". Do not fabricate visual information. Language should be concise, clear, and natural.'."\n"
+ .' - Strictly follow the given output example format. Do not omit escape characters.'."\n"
+ .' - Output length must not exceed 100 characters. Emphasize the coherent narrative of the image sequence.'."\n"
+ .' - **Must fully and non-redundantly output all detected spoken subtitles**, excluding watermarks, channel names (e.g., "XX TV"), etc.'."\n"
+ .' - Program names refer specifically to segments or performances within the program. Do not treat names like "XX Gala" or "XX Show" as program names. **Do not fabricate or invent program names.**'."\n"
+ .' - Output must reflect the core plot of the image sequence without reversing primary and secondary elements.'."\n"
+ .' # Output example with program name:'."\n"
+ .' Program name:《Do Androids Dream of Electric Sheep?》'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ .' # Output example without program name:'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ .' # Host transition output example:'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot[transition]: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ ."\n"
+ .' - name: intelliSimpShowPrompt'."\n"
+ .' {text}'."\n"
+ .' Role: You are a television program editor-director'."\n"
+ .' Task objective: This is a textual summary of a program. Simplify the text by highlighting key content while preserving structure and time interval order.'."\n"
+ .' The ideal output isolates each program in its own interval and isolates hosting content between programs in its own interval. Hosting content must not be merged with program content.'."\n"
+ ."\n"
+ .' Execution steps:'."\n"
+ .' 1. Read through the entire text and understand the subject of each time interval in context. If both dialogue and subtitle content exist in an interval (explicitly marked as "Subtitle:" in the input, and the content is not "none", "no content", etc.), replace the dialogue with the subtitle content.'."\n"
+ .' 2. If adjacent time intervals are coherent and share the same subject, merge them into one interval, using the earliest start time and latest end time.'."\n"
+ .' 3. Simplify the content within each time interval while preserving the current structure.'."\n"
+ .' 4. Validate the final output against the given rules. If validation fails, regenerate (do not output the validation process; only output the final result).'."\n"
+ ."\n"
+ .' Specific rules:'."\n"
+ ."\n"
+ .' 1. The earliest interval in the output must start at 00:00:00, and the last interval must end at the same time as the last interval in the original input.'."\n"
+ .' 2. The output format must exactly match the original input format. Do not add any extra explanations or comments.'."\n"
+ .' 3. Do not process only part of the intervals. All intervals must be processed, and the complete final result must be output.'."\n"
+ .' 4. Where splitting intervals meets all other conditions, merge as many intervals as possible.'."\n"
+ .' 5. Different programs, transition hosting, advertisements, etc., must not be merged into one interval.'."\n"
+ .' 6. Time accuracy must be guaranteed.'."\n"
+ ."\n"
+ .' Please strictly follow the above rules. Do not output only a simplification example; output the complete simplified result.'."\n"
+ ."\n"
+ .' - intelliSimpSecondShowPrompt'."\n"
+ .' {text}'."\n"
+ .' Role: You are a television program editor-director'."\n"
+ .' Task objective: This is a textual summary of a program. Simplify the text by highlighting key content while preserving structure and time interval order.'."\n"
+ .' The ideal output isolates each program in its own interval if multiple programs exist. If only one program exists, different content/subjects within the program are isolated in separate intervals. Other content between programs must not be merged with program content.'."\n"
+ ."\n"
+ .' Execution steps:'."\n"
+ .' 1. Read through the entire text and understand the subject of each time interval in context.'."\n"
+ .' 2. If adjacent time intervals are coherent and share the same subject (apply a moderately relaxed standard for this judgment), merge them into one interval, using the earliest start time and latest end time.'."\n"
+ .' 3. Simplify the content within each time interval while preserving the current structure.'."\n"
+ .' 4. Validate the final output against the given rules. If validation fails, regenerate (do not output the validation process; only output the final result).'."\n"
+ ."\n"
+ .' Specific rules:'."\n"
+ ."\n"
+ .' 1. The earliest interval in the output must start at 00:00:00, and the last interval must end at the same time as the last interval in the original input.'."\n"
+ .' 2. The output format must exactly match the original input format. Do not add any extra explanations or comments.'."\n"
+ .' 3. Do not process only part of the intervals. All intervals must be processed, and the complete final result must be output.'."\n"
+ .' 4. Where splitting intervals meets all other conditions, merge as many intervals as possible.'."\n"
+ .' 5. Different programs, transition hosting, advertisements, etc., must not be merged into one interval.'."\n"
+ .' 6. Time accuracy must be guaranteed.'."\n"
+ ."\n"
+ .' Please strictly follow the above rules when processing the text.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoDetectShot',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"header\\": {\\n \\"errorCode\\": \\"AccessForbidden\\",\\n \\"errorMessage\\": \\"错误信息\\",\\n \\"event\\": \\"task-finished\\",\\n \\"sessionId\\": \\"xxxx\\",\\n \\"taskId\\": \\"xxxx\\",\\n \\"traceId\\": \\"xxxxx\\"\\n },\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"OCR文本输出\\\\n\\\\n\\"\\n },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\"\\n}","type":"json"}]',
],
- 'SubmitEssayCorrectionTask' => [
- 'summary' => '提交批改任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitEssayCorrectionTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitEnterpriseVocAnalysisTask' => [
+ 'summary' => 'Submits an asynchronous analysis task for enterprise Voice of the Customer (VOC).',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitEnterpriseVocAnalysisTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => 'The [workspace ID](~~2782167~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'tasks',
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The task description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。'],
+ ],
+ [
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Additional business information.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The prompt that describes the output format. If this parameter is not specified, the output is generated in JSON format based on the task description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '请直接输出json格式,不要输出其他内容:'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The model ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen-max'],
+ ],
+ [
+ 'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '批改任务列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The content tags.',
'type' => 'array',
'items' => [
- 'title' => '子任务',
- 'description' => '',
+ 'description' => 'The list of tag systems.',
'type' => 'object',
'properties' => [
- 'grade' => [
- 'title' => '年级,可选值有:'."\n"
- .'['."\n"
- .' "初中一年级",'."\n"
- .' "初中二年级",'."\n"
- .' "初中三年级",'."\n"
- .' "高中一年级",'."\n"
- .' "高中二年级",'."\n"
- .' "高中三年级"'."\n"
- .']',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '高中二年级',
- ],
- 'subject' => [
- 'title' => '科目,可选值有:['."\n"
- .' "语文",'."\n"
- .' "英语应用文",'."\n"
- .' "英语读后续写"'."\n"
- .' ]',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '语文',
- ],
- 'totalScore' => [
- 'title' => '总分',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
- 'question' => [
- 'title' => '作文题目',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'answer' => [
- 'title' => '作文回答',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'otherReviewPoints' => [
- 'title' => '其他审阅要点',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'customId' => [
- 'title' => ' 客户自定义ID。返回结果通过customId来区分不同任务。',
- 'type' => 'string',
- ],
+ 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxx'],
+ 'tagDefinePrompt' => ['description' => 'The prompt that defines the tag for the Large Language Model (LLM).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxx'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'grade',
+ 'name' => 'filterTags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '年级(公共值,优先取子任务中的grade)',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The filter tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'The filter tag name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '过滤标签名称'],
+ 'tagDefinePrompt' => ['description' => 'The prompt that defines the filter tag for the LLM.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '标签抽取的定义的Prompt'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '高中二年级',
+ 'example' => '',
],
],
[
- 'name' => 'subject',
+ 'name' => 'contents',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '科目(公共值,优先取子任务中的subject)',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of content to analyze. Specify one of \\`url\\`, \\`fileKey\\`, or \\`contents\\`. The array can contain a maximum of 200 items. To process more items, use the \\`fileKey\\` parameter or upload a file.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The content object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => 'The content. The number of characters cannot exceed 10,000.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxx'],
+ 'id' => ['description' => 'The content ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'id-xxxxx'],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '语文',
+ 'example' => '',
],
],
[
- 'name' => 'totalScore',
+ 'name' => 'url',
'in' => 'formData',
- 'schema' => [
- 'title' => '总分(公共值,优先取子任务中的 totalScore)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['description' => 'The URL of the content file to analyze. Specify one of \\`url\\`, \\`fileKey\\`, or \\`contents\\`. The file size cannot exceed 100 MB. The number of content items cannot exceed 60,000.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt'],
],
[
- 'name' => 'question',
+ 'name' => 'fileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '作文题目(公共值,优先取子任务中的question)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'The file key of the content file to analyze. Specify one of \\`url\\`, \\`fileKey\\`, or \\`contents\\`. The file key is a unique key that you obtain after you upload a file on the Quanmiao Software as a Service (SaaS) page.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt'],
],
[
- 'name' => 'otherReviewPoints',
+ 'name' => 'apiKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '其他评阅要点(公共值,优先取子任务中的otherReviewPoints )',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => 'Model Studio API key ', 'description' => 'The Alibaba Cloud Model Studio API key.', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxx'],
],
[
- 'name' => 'modelId',
+ 'name' => 'sourceTrace',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => 'Specifies whether to enable source tracing (custom outputFormat is not supported when source tracing is enabled) ', 'description' => 'Specifies whether to enable traceability. If you enable traceability, you cannot customize the output format.', 'type' => 'boolean', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'batchTask',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Whether to use the model\'s BATCH API (fee is halved, with timeliness within 24 hours)'."\n"
+ ."\n"
+ .'(Supported models for batch API include stable versions and some latest versions of Qwen Max, Plus, Flash, Turbo, and Long, as well as the QwQ series (qwq-plus, qwq-32b-preview) and certain third-party models (deepseek-r1, deepseek-v3).)'."\n", 'description' => 'Specifies whether to use the model\'s BATCH API. This reduces the cost by half and processes the task within 24 hours.'."\n"
+ ."\n"
+ .'(The BATCH API is supported by stable and some latest versions of Qwen-Max, Qwen-Plus, Qwen-Flash, Qwen-Turbo, and Qwen-Long. It is also supported by QwQ series models, such as qwq-plus and qwq-32b-preview, and some third-party models, such as deepseek-r1 and deepseek-v3.)', 'type' => 'boolean', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'positiveFilter',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Whether to enable positive filtering (true: positive filtering, default; false: negative filtering)', 'description' => 'Specifies whether to perform positive filtering. \\`true\\`: positive filtering (default). \\`false\\`: negative filtering.', 'type' => 'boolean', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'requestId' => [
- 'title' => '请求唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'NoPermission'],
'data' => [
- 'title' => '任务结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The business object.',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => 'a0cc71ec-fe07-47e5-bf12-6e1c46081c98'],
],
+ 'example' => '',
],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '403'],
+ 'message' => ['description' => 'The error description.', 'type' => 'string', 'title' => '', 'example' => '无权限访问接口'],
+ 'success' => ['description' => 'Indicates whether the request was successful. \\`true\\`: successful. \\`false\\`: failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"data\\": {\\n \\"taskId\\": \\"a0cc71ec-fe07-47e5-bf12-6e1c46081c98\\"\\n },\\n \\"httpStatusCode\\": 403,\\n \\"message\\": \\"无权限访问接口\\",\\n \\"success\\": false\\n}","type":"json"}]',
+ 'title' => 'Submit an enterprise VOC mining asynchronous task ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-04-17T11:51:14.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"NoData\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
],
- 'GetEssayCorrectionTask' => [
- 'summary' => '获取作业批改结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getEssayCorrectionTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitEssayCorrectionTask' => [
+ 'summary' => 'Submit an essay for correction.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitEssayCorrectionTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => '[The workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'tasks',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'A list of correction tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'A single correction task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'grade' => ['description' => 'The grade. Valid values are:'."\n"
+ .'\\['."\n"
+ .'"Junior High Grade 1",'."\n"
+ .'"Junior High Grade 2",'."\n"
+ .'"Junior High Grade 3",'."\n"
+ .'"Senior High Grade 1",'."\n"
+ .'"Senior High Grade 2",'."\n"
+ .'"Senior High Grade 3"'."\n"
+ .']', 'type' => 'string', 'example' => '高中二年级', 'title' => '', 'required' => false],
+ 'subject' => ['description' => 'The subject. Valid values are: \\['."\n"
+ .'"Chinese",'."\n"
+ .'"English Applied Writing",'."\n"
+ .'"English Read and Continue Writing"'."\n"
+ .']', 'type' => 'string', 'example' => '语文', 'title' => '', 'required' => false],
+ 'totalScore' => ['description' => 'The maximum possible score for the essay.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false],
+ 'question' => ['description' => 'The essay topic.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ 'answer' => ['description' => 'The student\'s response to the essay topic.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ 'otherReviewPoints' => ['description' => 'Additional review criteria.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ 'customId' => ['title' => 'Customer-defined ID. Return Result distinguishes different jobs by customId. ', 'description' => 'A custom ID that uniquely identifies the task.', 'type' => 'string', 'example' => 'xxxxx', 'required' => false],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'llm-xxx',
+ 'example' => '[{"grade": "高中二年级", "subject": "语文", "totalScore": 60, "question": "请以我的梦想为主题写一篇作文", "answer": "我的梦想是成为一名科学家...", "customId": "task-001"}]',
],
],
[
- 'name' => 'taskId',
- 'in' => 'query',
+ 'name' => 'grade',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A default grade to apply to all tasks. If a `grade` is also specified within an individual task, the task-level value takes precedence.', 'type' => 'string', 'example' => '高中二年级', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'subject',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A default subject to apply to all tasks. If a `subject` is also specified within an individual task, the task-level value takes precedence.', 'type' => 'string', 'example' => '语文', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'totalScore',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A default total score to apply to all tasks. If a `totalScore` is also specified within an individual task, the task-level value takes precedence.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'question',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A default essay topic to apply to all tasks. If a `question` is also specified within an individual task, the task-level value takes precedence.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'otherReviewPoints',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Default additional review criteria to apply to all tasks. If `otherReviewPoints` is also specified within an individual task, the task-level value takes precedence.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the model to use for correction.'."\n"
+ ."\n"
+ .'The following models are available:'."\n"
+ ."\n"
+ .'```json'."\n"
+ ."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "ModelName": "Custom Correction Model",'."\n"
+ .' "ModelId": "qwen-custom-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "Essay Correction Model",'."\n"
+ .' "ModelId": "qwen-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "Essay Correction Lite Model",'."\n"
+ .' "ModelId": "qwen-correction-v1-lite"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'```', 'type' => 'string', 'example' => 'qwen-correction-v1', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'dimensions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'The name of the dimension.', 'type' => 'string', 'example' => '内容完整度', 'title' => '', 'required' => false],
+ 'rubric' => ['description' => 'The scoring rubric for the dimension.', 'type' => 'string', 'example' => '文章内容是否完整,是否涵盖了题目的核心要求', 'title' => '', 'required' => false],
+ 'maxScore' => ['description' => 'The maximum score for the dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => '', 'required' => false],
+ ],
+ 'title' => '',
+ 'description' => 'A custom scoring dimension.',
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'example' => '[{"name": "内容完整度", "rubric": "文章内容是否完整,是否涵盖了题目的核心要求", "maxScore": 30}]',
+ 'title' => '',
+ 'description' => 'A list of custom scoring dimensions. This parameter is supported only by the `qwen-custom-correction-v1` model.',
'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'httpStatusCode' => [
- 'title' => 'Http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'title' => '响应失败时的消息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'success' => [
- 'title' => 'true:此次接口响应成功,false:响应失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'data' => [
- 'title' => '结果对象',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The task result.',
'type' => 'object',
'properties' => [
- 'status' => [
- 'title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PENDING',
- ],
- 'errorMessage' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'results' => [
- 'title' => '结果列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '结果对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'customId' => [
- 'title' => 'xxx',
- 'description' => 'xxx',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'result' => [
- 'title' => '评阅结果',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'score' => [
- 'title' => '作文审阅得分',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '58',
- ],
- 'usage' => [
- 'title' => '单个任务的token消耗数',
- '$ref' => '#/components/schemas/ModelUsage',
- ],
- ],
- ],
- ],
- 'totalUsage' => [
- 'title' => '所有任务总模型token消耗数',
- '$ref' => '#/components/schemas/ModelUsage',
- ],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"NoData\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Submit an essay grading job',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"successful\\",\\n \\"success\\": false,\\n \\"data\\": {\\n \\"status\\": \\"PENDING\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\",\\n \\"results\\": [\\n {\\n \\"customId\\": \\"1\\",\\n \\"result\\": \\"评阅结果\\\\n\\\\n\\",\\n \\"score\\": 58,\\n \\"usage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n }\\n ],\\n \\"totalUsage\\": {\\n \\"inputTokens\\": 0,\\n \\"outputTokens\\": 0,\\n \\"totalTokens\\": 0\\n }\\n }\\n}","type":"json"}]',
],
- 'GenerateBroadcastNews' => [
- 'summary' => '新闻播报-抽取分类获取播报热点',
- 'path' => '/{workspaceId}/quanmiao/lightapp/GenerateBroadcastNews',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitTagMiningAnalysisTask' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitTagMiningAnalysisTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-max', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'businessType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'clueMining', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The task description.', 'type' => 'string', 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间唯一标识',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ 'title' => '',
+ 'description' => 'A list of tag systems.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag definition.',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'tagDefinePrompt' => ['description' => 'The prompt for the tag definition.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'prompt',
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Additional information.', 'type' => 'string', 'example' => '额外信息', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The output format.', 'type' => 'string', 'example' => '请返回如下JSON格式,{"key1":"","key2":""}', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'url',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The URL of the file to be analyzed. Each item in the file must be separated by a line feed. You must specify either the contents or url parameter.', 'type' => 'string', 'maxLength' => 2000, 'title' => '', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt'],
+ ],
+ [
+ 'name' => 'contents',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '用户意图:比如“帮我播报体育热点”',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
+ 'description' => 'A list of content items to be analyzed. You must specify either the contents or url parameter.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The content to be analyzed.', 'type' => 'string', 'maxLength' => 2000, 'title' => '', 'required' => false, 'example' => 'xxx'],
+ 'required' => false,
+ 'maxItems' => 1000,
'example' => '',
],
],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Model Studio API key', 'description' => 'The API key for Alibaba Cloud Model Studio.', 'type' => 'string', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'batchTask',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'successful'],
+ 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
+ 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
'data' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response for the submitted task.',
'type' => 'object',
'properties' => [
- 'hotTopicSummaries' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'hotTopic' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'hotTopicVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-13_08',
- ],
- 'hotValue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1000000',
- ],
- 'id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1458tb3bjo7531kap42a',
- ],
- 'images' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'url' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://xxx.com/xxx.jpeg',
- ],
- ],
- ],
- ],
- 'textSummary' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
- 'sessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2bb0ea82dafd48a8817fadc4c90e2b52',
- ],
- 'taskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'text' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'usage' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'totalTokens' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- ],
- ],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
],
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"xx\\",\\n \\"data\\": {\\n \\"hotTopicSummaries\\": [\\n {\\n \\"category\\": \\"体育\\",\\n \\"hotTopic\\": \\"热点\\",\\n \\"hotTopicVersion\\": \\"2024-09-13_08\\",\\n \\"hotValue\\": 1000000,\\n \\"id\\": \\"1458tb3bjo7531kap42a\\",\\n \\"images\\": [\\n {\\n \\"url\\": \\"http://xxx.com/xxx.jpeg\\"\\n }\\n ],\\n \\"textSummary\\": \\"xxx\\"\\n }\\n ],\\n \\"sessionId\\": \\"2bb0ea82dafd48a8817fadc4c90e2b52\\",\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"text\\": \\"体育\\",\\n \\"usage\\": {\\n \\"inputTokens\\": 1,\\n \\"outputTokens\\": 2,\\n \\"totalTokens\\": 3\\n }\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true\\n}","type":"json"}]',
- ],
- 'SubmitTagMiningAnalysisTask' => [
- 'summary' => '轻应用-标签挖掘',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitTagMiningAnalysisTask',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Submit a label mining analysis job',
+ 'summary' => 'Performs tag mining for a lightweight application.',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-10T11:40:54.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"ok\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'SubmitVideoAnalysisTask' => [
+ 'summary' => 'Alibaba Cloud Model Studio mini app: Submit an offline asynchronous task for video understanding.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/submitVideoAnalysisTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => 'The workspace ID in Alibaba Cloud Model Studio. [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'videoUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The video URL.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'http://xxxx.mp4'],
+ ],
+ [
+ 'name' => 'videoModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The unique identifier for the model used in the video vision-language (VL) task. Supported models:'."\n"
+ ."\n"
+ .'- `quanmiao-vl-turbo`'."\n"
+ ."\n"
+ .'- `quanmiao-vl-plus`'."\n"
+ ."\n"
+ .'- `quanmiao-vl-max-thinking`'."\n"
+ ."\n"
+ .'- `quanmiao-vl-max`'."\n"
+ ."\n"
+ .'- `Qwen-VL-Post`', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-vl-turbo', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoModelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The prompt template for the video vision-language (VL) task. This template must include the `{videoAsrText}` variable, which represents the Automatic Speech Recognition (ASR) text from the video. If this parameter is not specified, the system uses a default template.', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一名视频分析师,擅长对各种视频片段进行理解。'."\n"
+ ."\n"
+ .'# 任务描述'."\n"
+ .'给你一个视频片段的多张关键帧图片,请你完成以下任务。'."\n"
+ .'- 输出每张图片的画面信息,包括人物、物体、动作、文字、字幕、镜头语言等。'."\n"
+ .'- 把每张图片的信息串联起来,生成视频的详细概述,还原该片段的剧情。'."\n"
+ ."\n"
+ .'# 限制'."\n"
+ .'- 分析范围严格限定于提供的视频子片段,不涉及视频之外的任何推测或背景信息。'."\n"
+ .'- 总结时需严格依据视频内容,不可添加个人臆测或创意性内容。'."\n"
+ .'- 保持对所有视频元素(尤其是文字和字幕)的高保真还原,避免信息遗漏或误解。'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 视频片段ASR信息 (如果输入为空则忽略ASR信息)'."\n"
+ .'{videoAsrText}'."\n"
+ ."\n"
+ .'# 输出格式'."\n"
+ .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。', 'title' => ''],
],
[
'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['description' => 'The unique identifier for the large model used for video summarization (text processing).'."\n"
+ ."\n"
+ .'**To run multiple text processing tasks, use the `textProcessTasks` parameter.** If `textProcessTasks` is specified, the system ignores this parameter, `modelCustomPromptTemplateId`, and `modelCustomPromptTemplate`.'."\n"
+ ."\n"
+ .'- `quanmiao-llm-max`'."\n"
+ ."\n"
+ .'- `quanmiao-llm-max-thinking`'."\n"
+ ."\n"
+ .'- `quanmiao-llm-plus`'."\n"
+ ."\n"
+ .'- `quanmiao-llm-turbo`', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max', 'title' => ''],
],
[
- 'name' => 'businessType',
+ 'name' => 'modelCustomPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the prompt template for video summarization. Valid values:'."\n"
+ ."\n"
+ .'- `PlotDetail`: Detailed plot analysis (default).'."\n"
+ ."\n"
+ .'- `Summary`: Content summary.'."\n"
+ ."\n"
+ .'- `ExtractVideoTag`: Tag extraction.'."\n"
+ ."\n"
+ .'- `ExplosivePointAnalysis`: Viral content analysis.'."\n"
+ ."\n"
+ .'- `MultiTask`: Multiple tasks.'."\n"
+ ."\n"
+ .'The `modelCustomPromptTemplate` parameter takes precedence over this parameter. If only an ID is provided, the system uses the default prompt associated with that ID.', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A custom prompt template for the large model used for video summarization. The template must include both the `{videoAsrText}` and `{videoAnalysisText}` variables. `{videoAsrText}` represents the ASR text from the video, and `{videoAnalysisText}` represents the vision-language (VL) analysis results for each shot in the video.', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一个专业的视频标注专员,擅长结合视频镜头信息来分析处理各种视频任务。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你结合输入数据串联、还原出整个视频的详细剧情。'."\n"
+ ."\n"
+ .'# 限制'."\n"
+ .'1.如出现语法上错误,或逻辑不通,请直接修改'."\n"
+ .'2.在视频分镜中,如果包含台词,可能会出现说话者与其所说内容不匹配的情况。因此,必须根据剧情的进展,准确判断每段台词的真实说话者'."\n"
+ .'3.如果视频分镜中无台词,请根据视频音频文字为其匹配台词'."\n"
+ .'4.修改后的故事请适当保留视频分镜中对人物、场景的描写'."\n"
+ .'5.帮忙润色一下故事,使其更具逻辑性'."\n"
+ .'6.结合视频分镜中的人物外观特点,如果有外观相近的人物是同一个角色。因此,需要将不同分镜中的人物角色统一。'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 资料一:视频分镜信息(视频各镜头的视觉描述信息)'."\n"
+ .'{videoAnalysisText}'."\n"
+ ."\n"
+ .'## 资料二:视频ASR转录信息(未标注出说话者,可能有错误和遗漏,如果没有输入ASR,则忽略此信息)'."\n"
+ .'{videoAsrText}'."\n"
+ ."\n"
+ .'# 输出格式'."\n"
+ .'直接输出视频剧情,不要输出其他信息。', 'title' => ''],
+ ],
+ [
+ 'name' => 'generateOptions',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务类型',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The video understanding tasks to perform.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The video understanding task to perform. Prerequisite tasks are executed automatically.'."\n"
+ ."\n"
+ .'- `videoAnalysis`: Vision-language analysis (VL). If this is the only option provided, the process stops after this analysis and performs no subsequent subtasks.'."\n"
+ ."\n"
+ .'- **`videoGenerate`: Text processing and video summarization (default)**. This includes `videoAnalysis`.'."\n"
+ ."\n"
+ .'- `videoTitleGenerate`: Video title generation. This includes `videoAnalysis` and `videoGenerate`.'."\n"
+ ."\n"
+ .'- `videoMindMappingGenerate`: Video mind map generation. This includes `videoAnalysis` and `videoGenerate`.', 'type' => 'string', 'required' => false, 'example' => 'videoGenerate', 'title' => ''],
'required' => false,
- 'example' => 'clueMining',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'taskDescription',
+ 'name' => 'videoExtraInfo',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Supplementary text about the video, such as a summary, description, or ASR transcript. To use this text, you must include the `{videoExtraInfo}` variable in the prompt template.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '视频描述了:xx'],
+ ],
+ [
+ 'name' => 'snapshotInterval',
'in' => 'formData',
+ 'schema' => ['description' => 'The frame sampling interval, in seconds. The value must be between 1 and 10, inclusive. A larger interval means fewer frames are extracted, which can reduce accuracy but also decrease processing time and cost. The default setting is optimized and recommended for most use cases. If you adjust it, a value between 1 and 3 is recommended.'."\n"
+ .'Note: This parameter has a higher priority than `frameSampleMethod.interval`. For typical scenarios, you can use the `interval` parameter within the `userdefined` mode of the `frameSampleMethod` object. The key difference is that the interval in `frameSampleMethod`\'s custom mode must be within a specific range corresponding to the video\'s duration.', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'splitInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Minimum shot interval: [1, 150]. The actual value used is the smaller of the current configuration and the system-recommended value based on video duration. ', 'description' => 'The minimum shot split interval, in seconds. The value must be an integer between 1 and 150, inclusive. If not specified, the system calculates an optimal interval based on the video\'s duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
+ ],
+ [
+ 'name' => 'language',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The language of the video. Valid values:'."\n"
+ ."\n"
+ .'- `chinese`: Chinese (default)'."\n"
+ ."\n"
+ .'- `french`: French'."\n"
+ ."\n"
+ .'- `english`: English'."\n"
+ ."\n"
+ .'- `japanese`: Japanese'."\n"
+ ."\n"
+ .'- `chineseEnglishFreely`: Mixed Chinese and English'."\n"
+ ."\n"
+ .'- `arabic`: Arabic'."\n"
+ ."\n"
+ .'- `korean`: Korean'."\n"
+ ."\n"
+ .'- `malay`: Malay'."\n"
+ ."\n"
+ .'- `thai`: Thai'."\n"
+ ."\n"
+ .'- `portuguese`: Portuguese'."\n"
+ ."\n"
+ .'- `spanish`: Spanish'."\n"
+ ."\n"
+ .'- `indonesian`: Indonesian'."\n"
+ ."\n"
+ .'- `vietnamese`: Vietnamese', 'type' => 'string', 'example' => 'chinese', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'frameSampleMethod',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The frame sampling method.',
+ 'type' => 'object',
+ 'properties' => [
+ 'methodName' => ['description' => 'The sampling method. Valid values:'."\n"
+ ."\n"
+ .'- `fast`: Fast/lower cost'."\n"
+ ."\n"
+ .'- `standard`: Standard (default)'."\n"
+ ."\n"
+ .'- `userdefined`: Custom', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''],
+ 'interval' => ['description' => 'The frame sampling interval in seconds. This parameter is valid only when `methodName` is set to `userdefined`.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''],
+ 'pixel' => ['description' => 'The maximum pixel length of the longest side of each sampled frame. This parameter is valid only when `methodName` is set to `userdefined`. The value must be between 300 and 768, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '768', 'title' => ''],
+ ],
'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
+ 'example' => 'english',
+ 'title' => '',
],
],
[
- 'name' => 'tags',
+ 'name' => 'videoRoles',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '标签体系列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'A list of characters to recognize in the video.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A character to be recognized in the video.',
'type' => 'object',
'properties' => [
- 'tagName' => [
- 'title' => '标签名称',
- 'description' => '',
- 'type' => 'string',
+ 'roleName' => ['description' => 'The character\'s name.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
+ 'roleInfo' => ['description' => 'A description of the character.', 'type' => 'string', 'required' => false, 'example' => '张三是一个男生', 'title' => ''],
+ 'urls' => [
+ 'description' => 'A list of URLs for the character\'s avatar images.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The URL of a character avatar image.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx', 'title' => ''],
'required' => false,
- 'example' => 'xxxx',
+ 'title' => '',
+ 'example' => '',
],
- 'tagDefinePrompt' => [
- 'title' => '标签定义提示词',
- 'description' => '',
- 'type' => 'string',
+ 'isAutoRecognition' => ['description' => 'Specifies whether to use a separate video URL for automatic recognition. If `true`, the timestamps of face images may not align with the main video frames, as they can come from different videos.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ 'timeIntervals' => [
+ 'description' => 'A list of time intervals for the character\'s appearances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ 'endTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '345546789', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'xxxx',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'extraInfo',
+ 'name' => 'textProcessTasks',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '额外信息',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'A list of video summarization (text processing) tasks. You can specify up to three tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A video summarization (text processing) task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['description' => 'The ID of the large model for video summarization. Supported models:'."\n"
+ ."\n"
+ .'- `qwen-max-latest`'."\n"
+ ."\n"
+ .'- `qwen-max`'."\n"
+ ."\n"
+ .'- `qwen-plus-latest`'."\n"
+ ."\n"
+ .'- `qwen-plus`'."\n"
+ ."\n"
+ .'- `qwen2.5-7b-instruct-1m`'."\n"
+ ."\n"
+ .'- `deepseek-r1`', 'type' => 'string', 'required' => false, 'example' => 'qwen-max-latest', 'title' => ''],
+ 'modelCustomPromptTemplate' => ['description' => 'A custom prompt template for the large model used for video summarization. The template must include both the `{videoAsrText}` and `{videoAnalysisText}` variables. `{videoAsrText}` represents the ASR text from the video, and `{videoAnalysisText}` represents the vision-language (VL) analysis results for each shot in the video.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
+ 'modelCustomPromptTemplateId' => ['description' => 'The ID of the prompt template for video summarization. Valid values:'."\n"
+ ."\n"
+ .'- `PlotDetail`: Detailed plot analysis (default).'."\n"
+ ."\n"
+ .'- `Summary`: Content summary.'."\n"
+ ."\n"
+ .'- `ExtractVideoTag`: Tag extraction.'."\n"
+ ."\n"
+ .'- `ExplosivePointAnalysis`: Viral content analysis.'."\n"
+ ."\n"
+ .'- `MultiTask`: Multiple tasks.'."\n"
+ ."\n"
+ .'The `modelCustomPromptTemplate` parameter takes precedence over this parameter. If only an ID is provided, the system uses the default prompt associated with that ID.', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '额外信息',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'outputFormat',
+ 'name' => 'faceIdentitySimilarityMinScore',
'in' => 'formData',
+ 'schema' => ['description' => 'The similarity threshold for character recognition. The value must be between 0 and 1, inclusive.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7', 'title' => ''],
+ ],
+ [
+ 'name' => 'videoShotFaceIdentityCount',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of frames (images) per shot to be used for character matching. The value must be an integer between 1 and 5, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'deduplicationId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Deduplication field: You can define your own business-specific UUID based on business requirements and scenarios. The system ensures that data with duplicate values in this field cannot be submitted again for at least 72 hours. ', 'description' => 'A custom unique identifier for request deduplication. The system rejects requests that have the same `deduplicationId` as a request submitted within the last 72 hours.', 'type' => 'string', 'example' => '1', 'required' => false],
+ ],
+ [
+ 'name' => 'excludeGenerateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '输出格式',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Steps to exclude from the generation process.'."\n"
+ ."\n"
+ .'- `videoCaption`: Video speech recognition (ASR)',
+ 'title' => 'Excluded generation steps: '."\n"
+ .'- videoCaption: Video speech recognition ',
+ 'type' => 'array',
+ 'items' => ['description' => 'A step to exclude from the generation process.'."\n"
+ ."\n"
+ .'- `videoCaption`: Video speech recognition (ASR)', 'type' => 'string', 'required' => false, 'example' => '[\\"videoCaption\\"]', 'title' => ''],
'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
+ 'example' => '',
],
],
[
- 'name' => 'url',
+ 'name' => 'videoCaptionInfo',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '待分析的内容文件URl(每条内容通过换行符分隔,contents、url二选一)',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Information about the captions (ASR).',
+ 'title' => 'Caption (ASR) information ',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoCaptions' => [
+ 'description' => 'An array of caption objects. You must provide either this parameter or `videoCaptionsFileUrl`.',
+ 'title' => 'Caption (ASR) Content. Specify either this field or videoCaptionsFileUrl. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A caption object that contains the text, speaker, and timestamp for a segment.',
+ 'title' => 'Caption (ASR) Content ',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['title' => 'Start time of the current sentence: milliseconds ', 'description' => 'The start time of the current sentence, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'required' => false],
+ 'endTime' => ['title' => 'End time of the current sentence: milliseconds ', 'description' => 'The end time of the current sentence, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'required' => false],
+ 'text' => ['title' => 'Content ', 'description' => 'The content.', 'type' => 'string', 'example' => '你好', 'required' => false],
+ 'speaker' => ['title' => 'role ', 'description' => 'The character who is speaking.', 'type' => 'string', 'example' => '张三', 'required' => false],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
- 'maxLength' => 2000,
+ 'example' => '',
],
],
[
- 'name' => 'contents',
+ 'name' => 'autoRoleRecognitionVideoUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Dedicated URL for Auto', 'description' => 'A separate video URL to use for automatic character recognition.', 'type' => 'string', 'required' => false, 'example' => 'http://'],
+ ],
+ [
+ 'name' => 'splitType',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'Segmentation pattern: minDuration (enforces a minimum segment duration), fixDuration (segments video into fixed-duration clips). The default pattern is minDuration. ', 'description' => 'The shot split method. Valid values are `minDuration` (ensures each shot meets a minimum duration) and `fixDuration` (splits the video into fixed-duration shots). The duration is set by `splitInterval`. Default: `minDuration`.', 'type' => 'string', 'example' => 'fixDuration', 'required' => false],
+ ],
+ [
+ 'name' => 'addDocumentParam',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '待分析的内容列表(contents、url二选一)',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '待分析的内容',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- 'maxLength' => 2000,
+ 'description' => 'Parameters for uploading the video and its analysis results as metadata to a Miaosou dataset.',
+ 'title' => 'Automatically save results (automatically upload to Miaosou dataset) ',
+ 'type' => 'object',
+ 'properties' => [
+ 'datasetId' => ['title' => 'Dataset ID ', 'description' => 'The ID of the Miaosou dataset. This parameter is required to upload the results.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3031'],
+ 'datasetName' => ['title' => 'Dataset Name ', 'description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'document' => [
+ 'description' => 'Parameters for uploading to Miaosou. If not provided, they are generated automatically.',
+ 'title' => 'Automatically save video parameters ',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => 'Video Name ', 'description' => 'The video name.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'docId' => ['title' => 'Video docId ', 'description' => 'A unique business identifier for the document, used for deduplication within the specified dataset.', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'categoryUuid' => ['title' => 'Category UUID', 'description' => 'The unique identifier for the document category.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'tags' => [
+ 'description' => 'An array of tags.',
+ 'title' => 'label',
+ 'type' => 'array',
+ 'items' => ['title' => 'value', 'description' => 'A tag.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'extend1' => ['title' => 'Extension field ', 'description' => 'Extended field 1.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend2' => ['title' => 'Extension field ', 'description' => 'Extended field 2.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend3' => ['title' => 'Extension field ', 'description' => 'Extended field 3.', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'metadata' => [
+ 'description' => 'The metadata.',
+ 'title' => 'Dictionary information',
+ 'type' => 'object',
+ 'properties' => [
+ 'keyValues' => [
+ 'description' => 'Metadata in a key-value structure.',
+ 'title' => 'Key-value format dictionary',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Metadata in a key-value structure.',
+ 'title' => 'Key-value format dictionary',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => 'Name ', 'description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'summary'],
+ 'value' => ['title' => 'Value ', 'description' => 'The field value.', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
],
'required' => false,
- 'maxItems' => 1000,
+ 'example' => '',
],
],
[
- 'name' => 'apiKey',
+ 'name' => 'videoUrls',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼APIKEY',
- 'type' => 'string',
+ 'description' => 'A list of video URLs. The videos are concatenated and processed as a single video. This feature is suitable for short video clips.',
+ 'title' => 'Multiple video URLs ',
+ 'type' => 'array',
+ 'items' => ['description' => 'A video URL.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '',
+ 'title' => 'Schema of Response',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'message' => [
- 'title' => '错误消息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'httpStatusCode' => [
- 'title' => 'http响应码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'title' => '请求是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'title' => '任务提交响应',
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
+ 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"success\\": true,\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Video Understanding - Submit Asynchronous Job ',
+ 'description' => '### Asynchronous tasks'."\n"
+ ."\n"
+ .'Unlike synchronous APIs, this API returns a response immediately after you submit an asynchronous task. The system schedules background tasks using a queuing mechanism and parallel processing. You can check the task status and retrieve the results by calling the "Get asynchronous task status and results" API.'."\n"
+ ."\n"
+ .'### API calls'."\n"
+ ."\n"
+ .'- You can call the API by using SDKs for most major programming languages.'."\n"
+ ."\n"
+ .'- You can debug and use the API directly in [OpenAPI Explorer]().'."\n"
+ ."\n"
+ .'- You can also go to the [Bailian - Film and Television Media Video Analysis Console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend), switch to the API tab, and view a call demo.'."\n"
+ ."\n"
+ .'### Concurrency'."\n"
+ ."\n"
+ .'| Item | Description |'."\n"
+ .'| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| Default concurrency | 2\\. This is the concurrency limit for running asynchronous tasks, not for API calls. |'."\n"
+ .'| Adjustable upper limit | You can increase the limit to 30 by calling the `UpdateVideoAnalysisConfig` API. |'."\n"
+ .'| Higher concurrency | If your business requires higher throughput, contact support to request a limit increase. |'."\n"
+ .'| Queuing mechanism | This limit defines the number of tasks that can run simultaneously. Tasks submitted beyond this limit are automatically queued. |'."\n"
+ ."\n"
+ .'### Role recognition'."\n"
+ ."\n"
+ .'- Use the API to identify people in a video.'."\n"
+ ."\n"
+ .'- **Default recognition limit**: Up to 16 people, with one image per role.'."\n"
+ ."\n"
+ .'- **Increase the limit**: To request a higher limit, join the DingTalk group with ID `116015001424` and contact the product R\\&D team.'."\n"
+ ."\n"
+ .'- **Timeout risk**: Too many role-matching operations in a single video analysis task can increase the risk of a timeout.'."\n"
+ ."\n"
+ .'### Scheduling and polling best practices'."\n"
+ ."\n"
+ .'Because API call concurrency is limited, we recommend the following:'."\n"
+ ."\n"
+ .'- **Concurrency scaling**: The adjustable concurrency limit applies to the number of asynchronous tasks processed simultaneously, not the task submission rate.'."\n"
+ ."\n"
+ .'- **Task submission**: Typically, submitting tasks serially is sufficient. If you have a large number of tasks, you can submit them with a concurrency of 2 to 3.'."\n"
+ ."\n"
+ .'- **Polling for results**: Tasks are processed in the order they are submitted. Therefore, only poll for the status of the N oldest incomplete tasks, where N equals your asynchronous task concurrency limit. Polling for other tasks is inefficient because they are still in the queue.'."\n"
+ ."\n"
+ .'### Agent integration'."\n"
+ ."\n"
+ .'Agents can use video analysis capabilities directly through a Skill:'."\n"
+ ."\n"
+ .'- **Skill name**: `alibabacloud-bailian-videoanalysis`'."\n"
+ ."\n"
+ .'- **Skill address**: <https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis>',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-10-17T01:54:58.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-27T09:29:33.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-18T05:48:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"ok\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\"\\n }\\n}","type":"json"}]',
],
- 'ListHotTopicSummaries' => [
- 'summary' => '轻应用-新闻播报-获取热点话题摘要列表',
- 'path' => '/{workspaceId}/quanmiao/lightapp/listHotTopicSummaries',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitVideoDetectShotTask' => [
+ 'summary' => 'Lightweight Application: Asynchronous Video Splitting Task\\'."\n"
+ .'To use the free video splitting feature, you must activate Media and Entertainment Video Understanding: https://bailian.console.aliyun.com/?tab=app#/app/app-market/quanmiao/video-comprehend\\'."\n"
+ .'The video splitting feature supports video processing for the following three scenarios:\\'."\n"
+ .'1\\. Program scenario\\'."\n"
+ .'2\\. News scenario\\'."\n"
+ .'3\\. Other scenarios\\'."\n"
+ .'For more information, including detailed usage recommendations and sample prompts, see the Additional Information section below.\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\'."\n"
+ .'\\',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitVideoDetectShotTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识,百炼首页左上角获取',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => 'Unique identifier for the Model Studio workspace. [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'],
],
[
- 'name' => 'category',
+ 'name' => 'videoUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '分类',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => 'URL of the video.', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.mp4', 'title' => ''],
],
[
- 'name' => 'hotTopic',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点话题',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => 'Large language model (LLM). We recommend deepseek-r1. Options:'."\n"
+ ."\n"
+ .'- deepseek-r1'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ ."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-llm-plus'."\n"
+ ."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'example' => 'deepseek-r1', 'title' => '', 'required' => false],
],
[
- 'name' => 'hotTopicVersion',
+ 'name' => 'options',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '热点话题版本',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Select how to perform shot detection. Options: ASR',
+ 'type' => 'array',
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR', 'title' => ''],
'required' => false,
- 'example' => '2024-09-13_12',
+ 'example' => '',
],
],
[
- 'name' => 'nextToken',
+ 'name' => 'deduplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==',
- ],
+ 'schema' => ['description' => 'Deduplication field. Define your unique business identifier as needed. For values that repeat in this field, the system prevents duplicate submissions for at least 72 hours.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false],
],
[
- 'name' => 'maxResults',
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'User-defined prompt for the LLM.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique task identifier.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'title' => ''],
+ ],
+ [
+ 'name' => 'originalSessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Unique identifier for the source task. To rerun a subtask (defined by the generateOptions field) based on a previous task, pass the previous task\'s taskId and originalSessionId. The backend loads the previous task\'s generated data, skips earlier steps, and improves efficiency. If the stored data is older than 7 days, the query fails and the system reruns dependent subtasks automatically.', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax', 'title' => ''],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplateId',
'in' => 'formData',
+ 'schema' => ['description' => 'ID of the prompt used by the LLM to generate video splitting results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'videoDetectShotShowPrompt'],
+ ],
+ [
+ 'name' => 'modelVlCustomPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the prompt used for VL detection.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'videoDetectShotVlShowPrompt'],
+ ],
+ [
+ 'name' => 'recognitionOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'Select how to detect content for each shot. Options: ASR, OCR, VL. You can select multiple.',
+ 'type' => 'array',
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR', 'title' => ''],
'required' => false,
- 'maximum' => '1000',
- 'minimum' => '0',
- 'exclusiveMinimum' => true,
- 'example' => '20',
+ 'example' => '',
],
],
+ [
+ 'name' => 'intelliSimpPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Prompt ID used to pre-simplify input for the large language model (LLM).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'intelliSimpShowPrompt'],
+ ],
+ [
+ 'name' => 'preModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Model to run intelliSimpPrompt. We recommend quanmiao-llm-max. Options:'."\n"
+ ."\n"
+ .'- deepseek-r1'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ ."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ ."\n"
+ .'- quanmiao-llm-plus'."\n"
+ ."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'example' => 'quanmiao-llm-max', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'intelliSimpPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'User-defined prompt to simplify input data for the LLM.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'vlPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'User-defined prompt for the VL model.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'language',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Speech recognition language:'."\n"
+ ."\n"
+ .'chinese: Chinese (default)'."\n"
+ .'french: French'."\n"
+ .'english: English'."\n"
+ .'japanese: Japanese'."\n"
+ .'chineseEnglishFreely: Chinese and English free speech'."\n"
+ .'arabic: Arabic'."\n"
+ .'korean: Korean'."\n"
+ .'malay: Malay'."\n"
+ .'thai: Thai'."\n"
+ .'portuguese: Portuguese'."\n"
+ .'spanish: Spanish'."\n"
+ .'indonesian: Indonesian'."\n"
+ .'vietnamese: Vietnamese', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'chinese'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'success' => ['description' => 'Operation status: true for success, false for failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'title' => '热点信息列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '热点信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'category' => [
- 'title' => '热点话题分类',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'hotTopic' => [
- 'title' => '热点话题名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'hotTopicVersion' => [
- 'title' => '热点话题摘要版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-13_12',
- ],
- 'hotValue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1000000',
- ],
- 'id' => [
- 'title' => '热点话题ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'db5dc5b3d8954a30b65ba700c9dda3bb',
- ],
- 'news' => [
- 'title' => '文章列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'comments' => [
- 'title' => '结构化摘要列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '结构化摘要',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'content' => [
- 'title' => '正文',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'pubTime' => [
- 'title' => '发布时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-10 15:32:00',
- ],
- 'title' => [
- 'title' => '标题',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- ],
- ],
- ],
- 'summary' => [
- 'title' => '热点话题结构化摘要',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'summaries' => [
- 'title' => '结构化摘要列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '结构化摘要',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'summary' => [
- 'title' => '摘要',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'title' => [
- 'title' => '标题',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- ],
- ],
- 'textSummary' => [
- 'title' => '热点话题文本摘要',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
+ 'description' => 'Result',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['description' => 'Unique task identifier', 'type' => 'string', 'title' => '', 'example' => '22ec888712de45b39b97983f8d166831'],
],
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'maxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'nextToken' => [
- 'title' => '下一页的token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==',
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'totalCount' => [
- 'title' => '总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"xx\\",\\n \\"data\\": [\\n {\\n \\"category\\": \\"财经\\",\\n \\"hotTopic\\": \\"xx\\",\\n \\"hotTopicVersion\\": \\"2024-09-13_12\\",\\n \\"hotValue\\": 1000000,\\n \\"id\\": \\"db5dc5b3d8954a30b65ba700c9dda3bb\\",\\n \\"news\\": [\\n {\\n \\"comments\\": [\\n {\\n \\"text\\": \\"xx\\"\\n }\\n ],\\n \\"content\\": \\"xx\\",\\n \\"pubTime\\": \\"2024-09-10 15:32:00\\",\\n \\"title\\": \\"xx\\",\\n \\"url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"summary\\": {\\n \\"summaries\\": [\\n {\\n \\"summary\\": \\"xx\\",\\n \\"title\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"textSummary\\": \\"xx\\"\\n }\\n ],\\n \\"httpStatusCode\\": 200,\\n \\"maxResults\\": 20,\\n \\"message\\": \\"success\\",\\n \\"nextToken\\": \\"JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==\\",\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true,\\n \\"totalCount\\": 200\\n}","type":"json"}]',
- ],
- 'GetTagMiningAnalysisTask' => [
- 'summary' => '获取挖掘分析任务结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getTagMiningAnalysisTask',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"success\\": true,\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"22ec888712de45b39b97983f8d166831\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Intelligent Video Splitting - Submit Asynchronous Job ',
+ 'extraInfo' => 'Currently, clip splitting supports processing videos in three scenarios: '."\n"
+ .'1. Program scenario '."\n"
+ .'2. News scenario '."\n"
+ .'3. Other scenarios '."\n"
+ ."\n"
+ .'For program scenario videos: '."\n"
+ .'It is recommended to use ASR-based shot segmentation and select ASR+VL for video recognition. '."\n"
+ .'For modelVlCustomPromptTemplateId, it is recommended to choose the program VL template (videoDetectShotVlShowPrompt) or customize the prompt via the vlPrompt field. '."\n"
+ .'For modelCustomPromptTemplateId, it is recommended to choose the program template (videoDetectShotShowPrompt) or customize the prompt via the prompt field. '."\n"
+ .'It is recommended to enable the feature that simplifies LLM input parameter text (using intelliSimpPromptTemplateId or intelliSimpPrompt). '."\n"
+ .'When intelliSimpPromptTemplateId is set to intelliSimpShowPrompt, it is recommended to use videoDetectShotShowPrompt for modelCustomPromptTemplateId. '."\n"
+ .'When intelliSimpPromptTemplateId is set to intelliSimpSecondShowPrompt, it is recommended to use videoDetectShotSecondShowPrompt for modelCustomPromptTemplateId. '."\n"
+ .'For preModelId, deepseek-v3.1 is recommended; for modelId, deepseek-r1 is recommended. '."\n"
+ ."\n"
+ .'For news scenario videos: '."\n"
+ .'News videos typically have clear and standardized audio. It is recommended to use only ASR for video content recognition and perform shot segmentation using ASR. '."\n"
+ .'If VL is enabled (not recommended), it is recommended to choose the news VL template (videoDetectShotVlNewsPrompt) for modelVlCustomPromptTemplateId or customize the prompt via the vlPrompt field. '."\n"
+ .'For modelCustomPromptTemplateId, it is recommended to choose the news template (videoDetectShotNewsPrompt) or customize the prompt via the prompt field. '."\n"
+ .'For preModelId, deepseek-v3.1 is recommended; for modelId, deepseek-r1 is recommended. '."\n"
+ ."\n"
+ .'For videos in other scenarios: '."\n"
+ .'If the audio is clear and covers the main information of the video, it is recommended to first try ASR-based shot segmentation and select ASR for video recognition. '."\n"
+ .'If the video itself contains limited information or little information is obtained during the video recognition step, it is recommended to first try not using intelliSimpPromptTemplateId or intelliSimpPrompt. '."\n"
+ ."\n"
+ .'If you wish to customize prompts, refer to the following sample templates: '."\n"
+ ."\n"
+ .' - name: videoDetectShotNewsPrompt'."\n"
+ .' # Role'."\n"
+ .' You are a professional news merging assistant. Please process the given ordered news segments according to the following requirements.'."\n"
+ .' Core capabilities: Precise merging based on news subject + Strict adherence to time annotations + Intelligent title generation'."\n"
+ .' Output must strictly follow the specified format.'."\n"
+ ."\n"
+ .' # Input data format:'."\n"
+ .' Time range: [Start Time]-[End Time], Content: [X], Speaker ID: [Y]'."\n"
+ .' (Speaker ID identifies the current speaker)'."\n"
+ ."\n"
+ .' # Task execution steps:'."\n"
+ .' 0. Pre-processing:'."\n"
+ .' Read the entire input, understand the meaning and subject of each news segment in context.'."\n"
+ ."\n"
+ .' 1. Compare two news segments:'."\n"
+ .' Compare the first and second segments to determine if they can be merged.'."\n"
+ .' If mergeable, proceed to step 2; otherwise, proceed to step 3.'."\n"
+ ."\n"
+ .' 2. If mergeable:'."\n"
+ .' Merge the two segments into a new segment.'."\n"
+ .' The new segment’s start time is the first segment’s start time.'."\n"
+ .' The new segment’s end time is the second segment’s end time.'."\n"
+ .' Then, compare this merged segment with the next segment and repeat step 1.'."\n"
+ ."\n"
+ .' 3. If not mergeable:'."\n"
+ .' Treat the first segment as an independent news segment.'."\n"
+ .' Its start time remains unchanged.'."\n"
+ .' Its end time is one second before the start time of the second segment.'."\n"
+ .' Then, compare the second segment with the next segment and repeat step 1.'."\n"
+ ."\n"
+ .' # Merging criteria (merge if at least one condition is met):'."\n"
+ .' - Both segments belong to the same news subject.'."\n"
+ .' - It is unclear whether they belong to the same subject, but merging does not introduce conflicts based on available information.'."\n"
+ ."\n"
+ .' # Sorting logic:'."\n"
+ .' Maintain original time order.'."\n"
+ ."\n"
+ .' # Input example:'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let’s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: xxxx, Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, Speaker ID: 1'."\n"
+ ."\n"
+ .' # Output format requirements:'."\n"
+ .' ## Output example:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime":"00:00:04",'."\n"
+ .' "endTime":"00:00:26",'."\n"
+ .' "title":"Weather Forecast",'."\n"
+ .' "summary":"Beijing’s weather forecast for the day"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime":"00:00:27",'."\n"
+ .' "endTime":"00:00:45",'."\n"
+ .' "title":"International News",'."\n"
+ .' "summary":"Content of international news"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ .' ## Output data requirements:'."\n"
+ .' startTime: Start time in HH:mm:ss format '."\n"
+ .' endTime: End time in HH:mm:ss format '."\n"
+ .' title: Entry title, concisely summarizing the main event '."\n"
+ .' summary: Entry summary, capturing core content '."\n"
+ ."\n"
+ .' # Now process the following input data:'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotShowPrompt'."\n"
+ .' ### **Ideal output result**'."\n"
+ .' Each program occupies an independent time interval, and hosting content between programs also occupies its own interval.'."\n"
+ .' ### **Task requirements**'."\n"
+ .' You are a live program director. Based on the input time intervals:'."\n"
+ .' 1. **Merge consecutive intervals with identical program content/theme**'."\n"
+ .' 2. **Identify transitions and handle them separately**'."\n"
+ .' 3. Generate a title and summary for each final interval'."\n"
+ .' 4. Merge consecutive non-program content (e.g., transitions, ads) with the same theme into one interval'."\n"
+ ."\n"
+ .' **Core rules**:'."\n"
+ .' 1. Title rules:'."\n"
+ .' - Program content: Reflect core subject (e.g., “Sports News”)'."\n"
+ .' - Transition content: Uniformly named “transition”'."\n"
+ .' - Do not invent program names not mentioned'."\n"
+ .' 2. Merging rules:'."\n"
+ .' - Consecutive hosting, ads, or other transition content must be merged into one interval—even if any two of these types appear consecutively'."\n"
+ .' - Consecutive intervals belonging to the same program must be merged'."\n"
+ .' - Do not merge different program content'."\n"
+ .' - Transitions must not be merged with program content'."\n"
+ .' - Intervals with no specific content must be merged with the previous interval, except transitions (e.g., transition hosting), which must remain independent'."\n"
+ .' 3. Summary rules:'."\n"
+ .' - Summarize core content in one concise sentence (≤20 characters)'."\n"
+ .' - For multi-element content, focus on the most central theme'."\n"
+ .' - Avoid repetitive descriptions'."\n"
+ .' - Ensure each summary is self-contained and does not rely on other intervals'."\n"
+ .' 4. Transition identification: Host linking segments or content-free transitions are considered transitions'."\n"
+ ."\n"
+ .' **Output format**:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss",'."\n"
+ .' "endTime": "HH:mm:ss",'."\n"
+ .' "title": "Title",'."\n"
+ .' "summary": "Summary"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Processing flow:'."\n"
+ ."\n"
+ .' Scan time intervals sequentially'."\n"
+ .' Merge eligible intervals per the above rules'."\n"
+ .' For each final interval:'."\n"
+ .' Identify if it is a transition → If yes: title = “transition”'."\n"
+ .' If not a transition → Extract core subject as title'."\n"
+ .' Summarize core content in one sentence'."\n"
+ ."\n"
+ .' ### **Sorting rule**'."\n"
+ .' - Maintain original time order.'."\n"
+ ."\n"
+ .' ### **Input example**'."\n"
+ .' ```'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let’s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: Next is international news, today’s key events include…, Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, latest match results are…, Speaker ID: 1'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output format**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss", // Start Time'."\n"
+ .' "endTime": "HH:mm:ss", // End Time'."\n"
+ .' "title": "Entry Title", // Concise summary of subject'."\n"
+ .' "summary": "Entry Summary" // Core content summary'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output example**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:04",'."\n"
+ .' "endTime": "00:00:26",'."\n"
+ .' "title": "Weather Forecast",'."\n"
+ .' "summary": "Overview of Beijing’s weather for the day."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:28",'."\n"
+ .' "endTime": "00:00:45",'."\n"
+ .' "title": "International News",'."\n"
+ .' "summary": "Coverage of major international events today."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:46",'."\n"
+ .' "endTime": "00:00:55",'."\n"
+ .' "title": "Sports News",'."\n"
+ .' "summary": "Latest updates on sporting events."'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ``` '."\n"
+ .' ### **Please process the following input data**'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotSecondShowPrompt'."\n"
+ .' ### **Ideal output result**'."\n"
+ .' Each program occupies an independent interval, and all non-program content between programs also occupies its own interval.'."\n"
+ .' ### **Task requirements**'."\n"
+ .' You are a live program director. Based on the input time intervals:'."\n"
+ .' 1. Identify the type of program and classify non-program content (e.g., ads, announcements)'."\n"
+ .' 2. Merge consecutive intervals with identical program content/theme and identical non-program content/theme'."\n"
+ .' 3. For program intervals, extract and summarize content; for non-program intervals (e.g., ads, announcements), condense into concise summaries; short intervals of the same non-program type may be merged appropriately'."\n"
+ .' 4. If multiple programs exist, segment and summarize each separately; if only one program exists, segment it by internal content/theme and summarize each part'."\n"
+ .' 5. Identify precise start and end times (to the second) for each interval and generate title, summary, start time, and end time'."\n"
+ ."\n"
+ .' **Core rules**:'."\n"
+ .' 1. Title rules:'."\n"
+ .' - Program content: Reflect core subject (e.g., “Sports News”)'."\n"
+ .' - Non-program content: Name based on summarized content, e.g., “transition”, “ad”'."\n"
+ .' - Do not invent program names not mentioned'."\n"
+ .' 2. Merging rules:'."\n"
+ .' - Must merge consecutive intervals of the same program'."\n"
+ .' - Do not merge different program content'."\n"
+ .' - Non-program content must not be merged with program content'."\n"
+ .' - Host introductions to programs must not be merged with the program itself'."\n"
+ .' - Intervals with no specific content must be merged with the previous interval, except transitions (e.g., transition hosting), which must remain independent'."\n"
+ .' 3. Summary rules:'."\n"
+ .' - Summarize core content in one concise sentence (≤20 characters)'."\n"
+ .' - For multi-element content, focus on the most central theme'."\n"
+ .' - Avoid repetitive descriptions'."\n"
+ .' - Ensure each summary is self-contained'."\n"
+ .' 4. Transition identification: Host linking segments or content-free transitions are considered transitions'."\n"
+ .' 5. Interval identification: Start and end times must be precise to the second'."\n"
+ .' 6. Primary task is program content recognition; non-program content must be summarized and categorized'."\n"
+ ."\n"
+ .' **Output format**:'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss",'."\n"
+ .' "endTime": "HH:mm:ss",'."\n"
+ .' "title": "Title",'."\n"
+ .' "summary": "Summary"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Processing flow:'."\n"
+ ."\n"
+ .' Scan time intervals sequentially'."\n"
+ .' Merge consecutive intervals with identical content'."\n"
+ .' For each final interval:'."\n"
+ .' Identify if it is a program → If yes: title = extracted program content'."\n"
+ .' If not a program → title = summarized category (e.g., transition, ad)'."\n"
+ .' Summarize core content in one sentence'."\n"
+ ."\n"
+ .' ### **Sorting rule**'."\n"
+ .' - Maintain original time order.'."\n"
+ ."\n"
+ .' ### **Input example**'."\n"
+ .' ```'."\n"
+ .' Time range: 00:00:04-00:00:26, Content: First, let’s focus on the weather, Speaker ID: 1'."\n"
+ .' Time range: 00:00:28-00:00:45, Content: Next is international news, today’s key events include…, Speaker ID: 2'."\n"
+ .' Time range: 00:00:46-00:00:55, Content: Sports news, latest match results are…, Speaker ID: 1'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output format**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "HH:mm:ss", // Start Time'."\n"
+ .' "endTime": "HH:mm:ss", // End Time'."\n"
+ .' "title": "Entry Title", // Concise summary of subject'."\n"
+ .' "summary": "Entry Summary" // Core content summary'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ```'."\n"
+ ."\n"
+ .' ### **Output example**'."\n"
+ .' ```json'."\n"
+ .' {'."\n"
+ .' "results": ['."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:04",'."\n"
+ .' "endTime": "00:00:26",'."\n"
+ .' "title": "Weather Forecast",'."\n"
+ .' "summary": "Overview of Beijing’s weather for the day."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:28",'."\n"
+ .' "endTime": "00:00:45",'."\n"
+ .' "title": "International News",'."\n"
+ .' "summary": "Coverage of major international events today."'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "startTime": "00:00:46",'."\n"
+ .' "endTime": "00:00:55",'."\n"
+ .' "title": "Sports News",'."\n"
+ .' "summary": "Latest updates on sporting events."'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ``` '."\n"
+ .' ### **Please process the following input data**'."\n"
+ .' {query}'."\n"
+ ."\n"
+ .' - name: videoDetectShotVlNewsPrompt'."\n"
+ .' # Task objective'."\n"
+ .' Identify visual information from a set of images.'."\n"
+ .' # Output rules:'."\n"
+ .' - If no information is detected, output “none”. Do not fabricate visual details. Keep language concise, clear, and fluent.'."\n"
+ .' - Strictly follow the output example format. Do not omit escape characters.'."\n"
+ .' - Output length must not exceed 100 characters. Emphasize narrative coherence across the image sequence.'."\n"
+ .' # Output example:'."\n"
+ .' '."\n"
+ .'xxx'."\n"
+ ."\n\n"
+ .' - name: videoDetectShotVlShowPrompt'."\n"
+ .' # Task objective'."\n"
+ .' These are sampled frames from a program. Identify text and coherent narrative from the images. (If a program name is present, incorporate it into the narrative; otherwise, omit it. If a host appears and performs inter-program transitions, explicitly mark this in the output.)'."\n"
+ .' # Output rules:'."\n"
+ .' - If no information is detected, output “none”. Do not fabricate visual details. Keep language concise, clear, and fluent.'."\n"
+ .' - Strictly follow the output example format. Do not omit escape characters.'."\n"
+ .' - Output length must not exceed 100 characters. Emphasize narrative coherence.'."\n"
+ .' - **Must fully and non-redundantly output all detected spoken subtitles**, excluding watermarks, channel logos (e.g., “XX TV”), etc.'."\n"
+ .' - “Program name” refers specifically to segment or performance titles within the program. Do not interpret show titles like “XX Gala” or “XX Show” as program names. **Do not invent or fabricate program names.**'."\n"
+ .' - Output must reflect the core narrative of the image sequence without reversing emphasis.'."\n"
+ .' # Example with program name:'."\n"
+ .' Program name:《Do Androids Dream of Electric Sheep?》'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ .' # Example without program name:'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ .' # Host transition example:'."\n"
+ .' Subtitle: xxx'."\n"
+ .' Plot[transition]: Bounty hunter Rick hunts androids. To encourage remaining humans to emigrate, each emigrant receives an android helper.'."\n"
+ ."\n"
+ .' - name: intelliSimpShowPrompt'."\n"
+ .' {text}'."\n"
+ .' Role: You are a TV program editor-director'."\n"
+ .' Task objective: This is a textual summary of a program. Simplify the text to highlight key content while preserving structure and time interval order.'."\n"
+ .' Ideal output: Each program occupies an independent interval; hosting content between programs also occupies its own interval and must not be merged with program content.'."\n"
+ ."\n"
+ .' Execution steps:'."\n"
+ .' 1. Read the full text and understand the subject of each time interval in context. If both dialogue and subtitle content exist in an interval (explicitly labeled as “Subtitle:” with content not being “none”, “no content”, etc.), replace dialogue with subtitle content.'."\n"
+ .' 2. If adjacent intervals are coherent and share the same subject, merge them into one interval using the earliest start time and latest end time.'."\n"
+ .' 3. Simplify content within each interval while preserving original structure.'."\n"
+ .' 4. Validate the final output against the rules. If invalid, regenerate (do not output validation steps—only final result).'."\n"
+ ."\n"
+ .' Specific rules:'."\n"
+ ."\n"
+ .' 1. The earliest interval must start at 00:00:00; the last interval must end at the same time as the original last interval.'."\n"
+ .' 2. Output format must exactly match the input—no extra notes or comments.'."\n"
+ .' 3. All intervals must be processed; partial processing is prohibited.'."\n"
+ .' 4. Merge as many intervals as possible while satisfying all other conditions.'."\n"
+ .' 5. Different programs, transition hosting, ads, etc., must not be merged into one interval.'."\n"
+ .' 6. Time accuracy must be maintained.'."\n"
+ ."\n"
+ .' Strictly follow these rules. Do not output only a simplified example—output the complete simplified result.'."\n"
+ ."\n"
+ .' - intelliSimpSecondShowPrompt'."\n"
+ .' {text}'."\n"
+ .' Role: You are a TV program editor-director'."\n"
+ .' Task objective: This is a textual summary of a program. Simplify the text to highlight key content while preserving structure and time interval order.'."\n"
+ .' Ideal output: If multiple programs exist, each occupies an independent interval; if only one program exists, its different content/themes are segmented into separate intervals. Non-program content must not be merged with program content.'."\n"
+ ."\n"
+ .' Execution steps:'."\n"
+ .' 1. Read the full text and understand the subject of each time interval in context.'."\n"
+ .' 2. If adjacent intervals are reasonably coherent and share the same subject (apply lenient judgment), merge them into one interval using the earliest start time and latest end time.'."\n"
+ .' 3. Simplify content within each interval while preserving original structure.'."\n"
+ .' 4. Validate the final output against the rules. If invalid, regenerate (do not output validation steps—only final result).'."\n"
+ ."\n"
+ .' Specific rules:'."\n"
+ ."\n"
+ .' 1. The earliest interval must start at 00:00:00; the last interval must end at the same time as the original last interval.'."\n"
+ .' 2. Output format must exactly match the input—no extra notes or comments.'."\n"
+ .' 3. All intervals must be processed; partial processing is prohibited.'."\n"
+ .' 4. Merge as many intervals as possible while satisfying all other conditions.'."\n"
+ .' 5. Different programs, transition hosting, ads, etc., must not be merged into one interval.'."\n"
+ .' 6. Time accuracy must be maintained.'."\n"
+ ."\n"
+ .' Strictly follow these rules when processing the text.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateVideoAnalysisConfig' => [
+ 'summary' => 'Video Comprehension - Update Configuration',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisConfig',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务ID'."\n",
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- [
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => 'workspaceId',
- 'description' => 'workspaceId',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '', 'description' => 'UUID of the Alibaba Cloud Model Studio workspace: [Obtain workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'asyncConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Video Comprehension - Offline job concurrency, with a valid range of [2, 30]', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
],
'responses' => [
@@ -10358,338 +8311,156 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'httpStatusCode' => [
- 'title' => 'HTTP响应吗',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '业务响应结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'results' => [
- 'title' => '分析结果列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '分析对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'payload' => [
- 'title' => '载荷对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '模型响应文本',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- ],
- ],
- 'usage' => [
- 'title' => '用量',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'inputToken' => [
- 'title' => '输入token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputToken' => [
- 'title' => '输出token',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'totalToken' => [
- 'title' => '总token数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '300',
- ],
- ],
- ],
- ],
- ],
- 'header' => [
- 'title' => '响应头信息',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '大模型请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'event' => [
- 'title' => '事件',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'errorCode' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'errorMessage' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- 'customId' => [
- 'title' => '索引',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'status' => [
- 'title' => '任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'RUNNIN',
- ],
- 'errorCode' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'errorMessage' => [
- 'title' => '错误消息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'requestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Fault description', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the operation succeeded: true indicates success, and false indicates failure', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Video Comprehension - Update Configuration',
+ 'description' => 'Alibaba Cloud Model Studio lightweight application - Video Comprehension - Update Configuration: This API allows you to modify the concurrency configuration for asynchronous jobs. You can try it out in the [Video Comprehension console](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend). For examples of invoking this API using the software development kit (SDK), refer to the samples under “API” in the console.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"successful\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"results\\": [\\n {\\n \\"payload\\": {\\n \\"output\\": {\\n \\"text\\": \\"xxxx\\"\\n },\\n \\"usage\\": {\\n \\"inputToken\\": 100,\\n \\"outputToken\\": 200,\\n \\"totalToken\\": 300\\n }\\n },\\n \\"header\\": {\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"event\\": \\"task-finished\\",\\n \\"errorCode\\": \\"DataNotExists\\",\\n \\"errorMessage\\": \\"数据不存在\\"\\n },\\n \\"customId\\": \\"1\\"\\n }\\n ],\\n \\"status\\": \\"RUNNIN\\",\\n \\"errorCode\\": \\"任务错误Code\\\\n\\\\n\\",\\n \\"errorMessage\\": \\"任务错误消息\\\\n\\\\n\\"\\n },\\n \\"message\\": \\"DataNotExists\\",\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\",\\n \\"success\\": true\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'translator' => 'machine',
],
- 'CancelAsyncTask' => [
- 'summary' => '取消异步任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/cancelAsyncTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoAnalysisTask' => [
+ 'summary' => 'Video Understanding - Modify Job Status: Currently, only job cancellation is supported.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTask',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxxxxx',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UUID of the Model Studio workspace: [Obtain workspaceId](~~2587495~~) ', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['title' => '', 'description' => 'UUID of the job', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'taskStatus',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Task Status:'."\n"
+ .'- CANCELED: Cancel the job', 'type' => 'string', 'required' => true, 'example' => 'CANCELED'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'httpStatusCode' => [
- 'title' => 'http响应码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'success' => [
- 'title' => '此次请求是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'UUID of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => '任务不存在', 'title' => ''],
+ 'success' => ['description' => 'Indicates whether the operation succeeded: true indicates success, and false indicates failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'title' => '此次取消是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'description' => 'Job information',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['title' => '', 'description' => 'UUID of the job', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'taskStatus' => ['title' => '', 'description' => 'Task Status', 'type' => 'string', 'example' => 'CANCELED'],
+ 'taskErrorMessage' => ['title' => '', 'description' => 'Job failure message', 'type' => 'string', 'example' => '主动取消'],
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Video Understanding - Modify asynchronous Job Status',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"NoPermission\\",\\n \\"message\\": \\"无权限访问接口\\",\\n \\"httpStatusCode\\": 403,\\n \\"success\\": false,\\n \\"data\\": true\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"117F5ABE-CF02-5502-9A3F-E56BC9081A64\\",\\n \\"code\\": \\"DataNotExists\\",\\n \\"message\\": \\"任务不存在\\",\\n \\"success\\": false,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"taskStatus\\": \\"CANCELED\\",\\n \\"taskErrorMessage\\": \\"主动取消\\"\\n }\\n}","type":"json"}]',
+ 'translator' => 'machine',
],
- 'HotNewsRecommend' => [
- 'summary' => '热点新闻推荐',
- 'path' => '/{workspaceId}/quanmiao/lightapp/hotNewsRecommend',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoAnalysisTasks' => [
+ 'summary' => 'Video Understanding – Batch Cancel Tasks',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTasks',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'prompt',
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier for the Model Studio workspace: For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '推荐新闻的提示词',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => '',
+ 'description' => 'List of task IDs',
+ 'type' => 'array',
+ 'items' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''],
+ 'required' => true,
'example' => '',
],
],
[
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'name' => 'taskStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Task status:'."\n"
+ ."\n"
+ .'- CANCELED: Cancel task', 'type' => 'string', 'required' => true, 'example' => 'CANCELED', 'title' => ''],
],
],
'responses' => [
@@ -10699,222 +8470,762 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '阿里云为该请求生成的唯一标识符。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '575D5893-01DB-5C81-A899-74F67616762A',
- ],
- 'code' => [
- 'title' => '接口返回码:200:表示成功。其它:表示错误码。错误码详情,请参见错误码。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'success' => [
- 'title' => '是否调用成功:true:调用成功。 false:调用失败。',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ok',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8'],
+ 'code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'success' => ['description' => 'Success status: true for success, false for failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'title' => '新闻推荐结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'news' => [
- 'title' => '推荐新闻列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '推荐新闻对象',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'title' => [
- 'title' => '标题',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'content' => [
- 'title' => '内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'url' => [
- 'title' => '链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'pubTime' => [
- 'title' => '发布时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-09-10 15:32:00',
- ],
- 'source' => [
- 'title' => '新闻源',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'searchSource' => [
- 'title' => '搜索源',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'imageUrls' => [
- 'title' => '新闻图片列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.png',
- ],
- ],
- ],
- ],
+ 'title' => '',
+ 'description' => 'Deletion result',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Deletion result',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'taskStatus' => ['description' => 'Task status', 'type' => 'string', 'example' => 'CANCELED', 'title' => ''],
+ 'taskErrorMessage' => ['description' => 'Task failure message', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'taskErrorCode' => ['description' => 'Task failure code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
],
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8\\",\\n \\"code\\": \\"successful\\",\\n \\"message\\": \\"success\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"taskId\\": \\"xx\\",\\n \\"taskStatus\\": \\"CANCELED\\",\\n \\"taskErrorMessage\\": \\"xx\\",\\n \\"taskErrorCode\\": \\"xx\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Video Understanding - Batch Cancel Job',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"575D5893-01DB-5C81-A899-74F67616762A\\",\\n \\"code\\": \\"200\\",\\n \\"success\\": true,\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"news\\": [\\n {\\n \\"title\\": \\"xx\\",\\n \\"content\\": \\"xx\\",\\n \\"url\\": \\"http://xxx\\",\\n \\"pubTime\\": \\"2024-09-10 15:32:00\\",\\n \\"source\\": \\"新华社\\",\\n \\"searchSource\\": \\"QuarkCommonNews:联网检索\\",\\n \\"imageUrls\\": [\\n \\"http://www.example.com/xxx.png\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'GetFileContent' => [
- 'summary' => '获取文件内容',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getFileContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoDetectShotConfig' => [
+ 'summary' => 'Update the configuration for smart video segmentation.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoDetectShotConfig',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'fileKey',
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace: [Get the workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'asyncConcurrency',
'in' => 'formData',
+ 'schema' => ['description' => 'Maximum number of concurrent offline tasks for video understanding. Valid values: 2 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/1154600634854327_10045847/300469535473178749_300469535473178749_ee11508152b74137ac5747a6f632256e.docx',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'ok', 'title' => ''],
+ 'success' => ['description' => 'Operation result: true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Intelligent Clip Extraction - Update Configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateVideoDetectShotTask' => [
+ 'summary' => 'Updates the status of an asynchronous task for smart video segmentation. The only supported update is to cancel the task.',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/updateVideoDetectShotTask',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxx',
- ],
+ 'schema' => ['description' => 'Alibaba Cloud Model Studio workspace ID. [Get your workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'taskStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Task status:'."\n"
+ ."\n"
+ .'- CANCELED: Cancel the task', 'type' => 'string', 'required' => true, 'example' => 'CANCELED', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'BE603C85-90AA-50FC-A2D6-128AA9FA200D',
- ],
- 'success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '575D5893-01DB-5C81-A899-74F67616762A'],
+ 'code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'success' => ['description' => 'Operation result: true means success. false means failure', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'httpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Task details',
'type' => 'object',
'properties' => [
- 'content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'title' => '', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'taskStatus' => ['description' => 'Task status', 'type' => 'string', 'title' => '', 'example' => 'SUCCESSED'],
+ 'taskErrorMessage' => ['description' => 'Error message for a failed task', 'type' => 'string', 'title' => '', 'example' => 'xx'],
],
- ],
- 'httpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"575D5893-01DB-5C81-A899-74F67616762A\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"successful\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"taskStatus\\": \\"SUCCESSED\\",\\n \\"taskErrorMessage\\": \\"xx\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Intelligent Clip Segmentation - Modify asynchronous task status',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BE603C85-90AA-50FC-A2D6-128AA9FA200D\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"content\\": \\"xxxx\\"\\n },\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"successful\\",\\n \\"code\\": \\"successful\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'quanmiaolightapp.cn-beijing.aliyuncs.com', 'endpoint' => 'quanmiaolightapp.cn-beijing.aliyuncs.com', 'vpc' => 'quanmiaolightapp-vpc.cn-beijing.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'InvalidParam', 'message' => 'Param learningSamples is invalid: learningSamples not empty and cannot exceed 4000 characters.', 'http_code' => 400, 'description' => 'The total length of the learningSamples is not empty and cannot exceed 4000 characters.'],
+ ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'http_code' => 403, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetVideoAnalysisTask'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RunVideoAnalysis'],
+ ['description' => 'Request parameters changed', 'api' => 'SubmitVideoAnalysisTask'],
+ ],
+ 'createdAt' => '2025-12-16T12:55:41.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'quanmiaolightapp.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetVideoAnalysisTask'],
+ ['description' => 'Response parameters changed', 'api' => 'RunVideoAnalysis'],
+ ],
+ 'createdAt' => '2025-11-24T13:18:08.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'QuanMiaoLightApp',
+ 'productName' => 'Alibaba Cloud Model Studio',
+ 'ramCodes' => ['quanmiaolightapp'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'RunEnterpriseVocAnalysis',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEnterpriseVocAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVideoAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateBroadcastNews',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateBroadcastNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVideoDetectShotConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunScriptRefine',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitVideoDetectShotTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelAsyncTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunStyleWriting',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunStyleWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVideoAnalysisTasks',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunMarketingInformationWriting',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTagMiningAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunHotTopicSummary',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVideoDetectShotTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVideoDetectShotTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVideoAnalysisConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitTagMiningAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitEssayCorrectionTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunEssayCorrection',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEssayCorrection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunScriptChat',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFileContent',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetFileContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunMarketingInformationExtract',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationExtract',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunVideoDetectShot',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoDetectShot',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAnalysisTagDetailByTaskId',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunNetworkContentAudit',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunNetworkContentAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunScriptPlanning',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptPlanning',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHotTopicSummaries',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListHotTopicSummaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitEnterpriseVocAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunTagMiningAnalysis',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunTagMiningAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEnterpriseVocAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVideoAnalysisConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitVideoAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunOcrParse',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunOcrParse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunScriptContinue',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptContinue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunVideoAnalysis',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVideoDetectShotConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEssayCorrectionTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateOutputFormat',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateOutputFormat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'HotNewsRecommend',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:HotNewsRecommend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportAnalysisTagDetailByTaskId',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunHotTopicChat',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateVideoAnalysisTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];