summaryrefslogtreecommitdiff
path: root/data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php')
-rw-r--r--data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php15680
1 files changed, 5746 insertions, 9934 deletions
diff --git a/data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php b/data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php
index 9f74089..25eb105 100644
--- a/data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php
+++ b/data/zh_cn/quanmiaolightapp/2024-08-01/api-docs.php
@@ -1,128 +1,72 @@
<?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' => '电商零售推广文案写作',
+ 'children' => ['RunMarketingInformationWriting', 'RunMarketingInformationExtract'],
'type' => 'directory',
- 'children' => [
- 'RunMarketingInformationWriting',
- 'RunMarketingInformationExtract',
- ],
+ 'title' => '电商零售推广文案写作',
+ 'id' => 314280,
],
[
- 'id' => 197183,
- 'title' => '传媒/零售文章风格与格式学习',
+ 'children' => ['RunStyleWriting'],
'type' => 'directory',
- 'children' => [
- 'RunStyleWriting',
- ],
+ 'title' => '传媒/零售文章风格与格式学习',
+ 'id' => 314291,
],
[
- 'id' => 197180,
- 'title' => '影视互娱剧本创作',
+ 'children' => ['RunScriptRefine', 'RunScriptChat', 'RunScriptPlanning', 'RunScriptContinue'],
'type' => 'directory',
- 'children' => [
- 'RunScriptRefine',
- 'RunScriptChat',
- 'RunScriptPlanning',
- 'RunScriptContinue',
- ],
+ 'title' => '影视互娱剧本创作',
+ 'id' => 314275,
],
[
- 'id' => 197182,
- 'title' => '影视传媒视频理解',
+ 'children' => ['SubmitVideoAnalysisTask', 'GetVideoAnalysisTask', 'UpdateVideoAnalysisConfig', 'GetVideoAnalysisConfig', 'RunVideoAnalysis', 'UpdateVideoAnalysisTask', 'UpdateVideoAnalysisTasks'],
'type' => 'directory',
- 'children' => [
- 'SubmitVideoAnalysisTask',
- 'GetVideoAnalysisTask',
- 'UpdateVideoAnalysisTask',
- 'UpdateVideoAnalysisTasks',
- 'UpdateVideoAnalysisConfig',
- 'GetVideoAnalysisConfig',
- 'RunVideoAnalysis',
- ],
+ 'title' => '影视传媒视频理解',
+ 'id' => 314283,
],
[
- 'id' => 302549,
- 'title' => '影视传媒智能拆条',
+ 'children' => ['SubmitVideoDetectShotTask', 'GetVideoDetectShotTask', 'UpdateVideoDetectShotTask', 'UpdateVideoDetectShotConfig', 'GetVideoDetectShotConfig', 'RunVideoDetectShot'],
'type' => 'directory',
- 'children' => [
- 'SubmitVideoDetectShotTask',
- 'GetVideoDetectShotTask',
- 'UpdateVideoDetectShotTask',
- 'UpdateVideoDetectShotConfig',
- 'GetVideoDetectShotConfig',
- 'RunVideoDetectShot',
- ],
+ 'title' => '影视传媒智能拆条',
+ 'id' => 314320,
],
[
- 'id' => 197184,
- 'title' => '车机网络热点信息互动问答',
+ 'children' => ['RunHotTopicChat', 'RunHotTopicSummary'],
'type' => 'directory',
- 'children' => [
- 'RunHotTopicChat',
- 'RunHotTopicSummary',
- ],
+ 'title' => '车机网络热点信息互动问答',
+ 'id' => 314293,
],
[
- 'id' => 204667,
- 'title' => '泛企业VOC挖掘',
+ 'children' => ['RunEnterpriseVocAnalysis'],
'type' => 'directory',
- 'children' => [
- 'RunEnterpriseVocAnalysis',
- 'SubmitEnterpriseVocAnalysisTask',
- 'GetEnterpriseVocAnalysisTask',
- 'ExportAnalysisTagDetailByTaskId',
- 'ListAnalysisTagDetailByTaskId',
- ],
+ 'title' => '泛企业VOC挖掘',
+ 'id' => 314309,
],
[
- 'id' => 201588,
- 'title' => '泛企业线索挖掘',
+ 'children' => ['GenerateOutputFormat', 'RunTagMiningAnalysis'],
'type' => 'directory',
- 'children' => [
- 'GenerateOutputFormat',
- 'RunTagMiningAnalysis',
- ],
+ 'title' => '泛企业线索挖掘',
+ 'id' => 314298,
],
[
- 'id' => 201577,
- 'title' => '网络内容安全审核',
+ 'children' => ['RunNetworkContentAudit'],
'type' => 'directory',
- 'children' => [
- 'RunNetworkContentAudit',
- ],
+ 'title' => '网络内容安全审核',
+ 'id' => 314296,
],
[
- 'id' => 222910,
- 'title' => '作文批改',
+ 'children' => ['RunEssayCorrection', 'RunOcrParse', 'SubmitEssayCorrectionTask', 'GetEssayCorrectionTask'],
'type' => 'directory',
- 'children' => [
- 'RunEssayCorrection',
- 'RunOcrParse',
- 'SubmitEssayCorrectionTask',
- 'GetEssayCorrectionTask',
- ],
+ 'title' => '作文批改',
+ 'id' => 314315,
],
[
- 'id' => 203451,
- 'title' => '其他',
+ 'children' => ['GenerateBroadcastNews', 'SubmitTagMiningAnalysisTask', 'ListHotTopicSummaries', 'GetTagMiningAnalysisTask', 'HotNewsRecommend', 'GetFileContent', 'CancelAsyncTask', 'ExportAnalysisTagDetailByTaskId', 'GetEnterpriseVocAnalysisTask', 'ListAnalysisTagDetailByTaskId', 'SubmitEnterpriseVocAnalysisTask', 'BatchCancelTasks', 'BatchQueryTaskStatus', 'GetTaskExecutionStatistics'],
'type' => 'directory',
- 'children' => [
- 'GenerateBroadcastNews',
- 'SubmitTagMiningAnalysisTask',
- 'ListHotTopicSummaries',
- 'GetTagMiningAnalysisTask',
- 'CancelAsyncTask',
- 'HotNewsRecommend',
- 'GetFileContent',
- ],
+ 'title' => '其他',
+ 'id' => 314301,
],
],
'components' => [
@@ -131,258 +75,513 @@
'description' => '模型用量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '模型输入token数',
- 'description' => '模型输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '951',
- ],
- 'outputTokens' => [
- 'title' => '模型输出token数',
- 'description' => '模型输出token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- ],
- 'totalTokens' => [
- 'title' => '总token数据',
- 'description' => '总token数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '964',
- ],
+ 'inputTokens' => ['title' => '模型输入token数', 'description' => '模型输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '951'],
+ 'outputTokens' => ['title' => '模型输出token数', 'description' => '模型输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'totalTokens' => ['title' => '总token数据', 'description' => '总token数据', 'type' => 'integer', 'format' => 'int64', 'example' => '964'],
],
],
],
],
'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' => '路径参数,[业务空间id](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-26ca1703f6d71e6e',
- ],
+ 'schema' => ['description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'modelId',
+ 'name' => 'taskCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '大模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max'."\n"
- .'qwen-plus',
- ],
+ 'schema' => ['title' => '任务类型标识', 'description' => '任务类型标识', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask'],
],
[
- 'name' => 'writingType',
+ 'name' => 'taskIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '写作类型:'."\n"
- .'generateProductTitle - 生成商品标题'."\n"
- .'productTitleTranslation - 商品标题翻译'."\n"
- .'generateProductSummary - 生成商品摘要'."\n"
- .'productRedBook-生成关于某产品的小红书笔记'."\n"
- .'productEvaluating-商品使用测评文案'."\n"
- .'circleOfFriends-适合发朋友圈的推广营销文案'."\n"
- .'marketingActivities-营销活动的宣传文案'."\n"
- .'productAdvertisement-某公司/产品的广告词'."\n"
- .'travel-旅游类营销推广文章'."\n"
- .'other-其他类型的营销文案',
- 'type' => 'string',
+ 'title' => '任务ID列表,最多10000条',
+ 'description' => '任务ID列表,最多10000条',
+ 'type' => 'array',
+ 'items' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
- 'example' => 'productRedBook',
+ 'example' => '["xxxx1","xxxx2"]',
],
],
- [
- 'name' => 'customPrompt',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '自定义写作要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '语言要精美。',
+ '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' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Success'],
+ 'httpStatusCode' => ['title' => 'Http状态码', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'message' => ['title' => '响应失败时的消息', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => '成功'],
+ 'success' => ['title' => 'true:此次接口响应成功,false:响应失败', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'true'],
+ 'data' => [
+ 'title' => '结果对象',
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'results' => [
+ 'title' => '取消结果列表',
+ 'description' => '取消结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '取消结果项',
+ 'description' => '取消结果项',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => 'xxxx'],
+ 'success' => ['title' => '是否取消成功', 'description' => '是否取消成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errorMessage' => ['title' => '错误信息(取消失败时)', 'description' => '错误信息(取消失败时)', 'type' => 'string', 'example' => '错误信息(取消失败时)'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量取消异步任务',
+ 'summary' => '批量取消任务',
+ '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"}]',
+ ],
+ 'BatchQueryTaskStatus' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/batchQueryTaskStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'sourceMaterial',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '写作参考内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ps5是sony新一代的游戏机,他创新性的...',
- ],
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'customLimitation',
+ 'name' => 'taskCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '自定义写作限制',
- 'type' => 'string',
- 'required' => false,
- 'example' => '不要有错别字',
- ],
+ 'schema' => ['title' => '任务类型标识', 'description' => '任务类型标识', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask'],
],
[
- 'name' => 'inputExample',
+ 'name' => 'taskIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '自定义写作输入素材样例',
- 'type' => 'string',
+ 'title' => '任务ID列表,最多100条',
+ 'description' => '任务ID列表,最多100条',
+ 'type' => 'array',
+ 'items' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
- 'example' => '产品名字:xxx'."\n"
- .'产品特点:xxx',
+ 'example' => '["xxxx1","xxxx2"]',
],
],
- [
- 'name' => 'outputExample',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '自定义写作输出格式样例',
- 'type' => 'string',
- 'required' => false,
- 'example' => '写作输出内容样例',
+ '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' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Success'],
+ 'httpStatusCode' => ['title' => 'Http状态码', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'message' => ['title' => '响应失败时的消息', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => '成功'],
+ 'success' => ['title' => 'true:此次接口响应成功,false:响应失败', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'true'],
+ 'data' => [
+ 'title' => '结果对象',
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskStatusList' => [
+ 'title' => '任务状态列表',
+ 'description' => '任务状态列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '任务状态项',
+ 'description' => '任务状态项',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => 'xxxx'],
+ 'status' => ['title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消,NOT_FOUND:任务不存在)', 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消,NOT_FOUND:任务不存在)', 'type' => 'string', 'example' => 'RUNNING'],
+ 'errorMessage' => ['title' => '错误信息(当任务失败时,此字段会有值)', 'description' => '错误信息(当任务失败时,此字段会有值)', 'type' => 'string', 'example' => '错误信息'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量查询异步任务状态',
+ 'summary' => '批量查询任务状态',
+ '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"}]',
+ ],
+ 'CancelAsyncTask' => [
+ 'summary' => '取消异步任务',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/cancelAsyncTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'language',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '百炼业务空间ID', 'description' => '[百炼业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxxxx'],
+ ],
+ [
+ 'name' => 'taskId',
'in' => 'formData',
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '目标语言(用于商品标题翻译)',
- 'description' => '目标语言(用于商品标题翻译)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
+ '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' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'NoPermission'],
+ 'message' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '无权限访问接口'],
+ 'httpStatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '403'],
+ 'success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'false'],
+ 'data' => ['title' => '此次取消是否成功', 'description' => '此次取消是否成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '根据任务ID取消异步任务的执行',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ExportAnalysisTagDetailByTaskId' => [
+ 'summary' => '导出挖掘任务明细',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/exportAnalysisTagDetailByTaskId',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'keywords',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxxxxx'],
+ ],
+ [
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '关键词(用于生成商品标题和商品摘要)',
- 'description' => '关键词(用于生成商品标题和商品摘要)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '运动鞋 透气 减震 跑步',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
- 'name' => 'generateCount',
+ 'name' => 'category',
'in' => 'formData',
- 'schema' => [
- 'title' => '生成数量(用于生成商品标题和商品摘要,取值范围:1-15)',
- 'description' => '生成数量(用于生成商品标题和商品摘要,取值范围:1-15)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['title' => '分类筛选', 'description' => '分类筛选', 'type' => 'string', 'required' => false, 'example' => '标签分类'],
],
[
- 'name' => 'wordCountRange',
+ 'name' => 'categories',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '字数范围(用于商品标题翻译,格式:最小字数-最大字数)',
- 'description' => '字数范围(用于商品标题翻译,格式:最小字数-最大字数)',
- 'type' => 'string',
+ 'title' => '多分类筛选',
+ 'description' => '多分类筛选',
+ 'type' => 'array',
+ 'items' => ['title' => '标签分类', 'description' => '标签分类', 'type' => 'string', 'required' => false, 'example' => '标签分类列表'],
'required' => false,
- 'example' => '10-20',
],
],
- [
- 'name' => 'otherRequirements',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '其他要求(用于三种新的写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'description' => '其他要求(用于三种新的写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '要求标题简洁有力,突出产品特点',
+ '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' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => 'ok'],
+ 'httpStatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => 'URL(临时公网可下载的URL,1小时失效)', 'description' => 'URL(临时公网可下载的URL,1小时失效)', 'type' => 'string', 'example' => 'http://www.example.com/xxxx.xlsx'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '根据任务ID导出分析明细',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GenerateBroadcastNews' => [
+ 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单热点推荐:理解用户意图,获取对应频道下热点列表。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/GenerateBroadcastNews',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '业务空间唯一标识', 'description' => '[业务空间唯一标识](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
[
'name' => 'prompt',
'in' => 'formData',
+ 'schema' => ['title' => '用户意图:比如“帮我播报体育热点”', 'description' => '用户意图', 'type' => 'string', 'required' => true, 'example' => '帮我播报体育热点'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '自定义提示词(用于可控式生成模型,适用写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'description' => '自定义提示词(用于可控式生成模型,适用写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请根据关键词生成吸引人的商品标题',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'data' => [
+ 'description' => '分类和新闻热点数据',
+ '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' => '热点话题ID', 'type' => 'string', 'example' => '1458tb3bjo7531kap42a'],
+ 'images' => [
+ 'description' => '相关图片列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '相关图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['description' => '图片url', 'type' => 'string', 'example' => 'http://xxx.com/xxx.jpeg'],
+ ],
+ ],
+ ],
+ 'textSummary' => ['description' => '热点话题文本摘要', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ 'sessionId' => ['description' => '对话ID', 'type' => 'string', 'example' => '2bb0ea82dafd48a8817fadc4c90e2b52'],
+ 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'text' => ['description' => '理解结果', 'type' => 'string', 'example' => '体育'],
+ 'usage' => [
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'totalTokens' => ['description' => '总token量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ ],
+ ],
+ ],
+ ],
+ 'httpStatusCode' => ['description' => 'http状态码', '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ ],
+ ],
+ ],
+ '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' => '播报单(热榜)热点推荐',
+ 'description' => '理解用户意图,获取对应频道下热点列表,比如“播报体育新闻”。历史接口,建议走“播报单(热榜)问答接口 RunHotTopicChat”,完全覆盖了当前接口的能力。'."\n"
+ ."\n"
+ .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
+ ."\n"
+ .'通过SDK方式调用API可参考控制台“API”下的java、python示例。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateBroadcastNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GenerateOutputFormat' => [
+ 'summary' => '轻应用-标签挖掘-获取示例输出格式。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/generateOutputFormat',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'extParameters',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ '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'],
+ ],
+ [
+ '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',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '扩展参数(Map结构,包含 minWordLength、maxWordLength、enableThinking、thinkingBudget 等参数,所有参数值均为 String 类型)',
- 'description' => '扩展参数(Map结构,所有参数值均为 String 类型):'."\n"
- .'- enableThinking:是否启用思考模式,取值为 "true" 或 "false"'."\n"
- .'- thinkingBudget:思考预算,用于控制思考模式的预算(整数,字符串形式)'."\n"
- .'- resultFormat:结果格式,用于设置输出格式'."\n"
- .'- incrementalOutput:是否启用增量输出,取值为 "true" 或 "false"',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'title' => '参数KEY',
- 'description' => '参数KEY',
- 'type' => 'string',
- 'example' => '大模型参数KEY',
+ '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,
],
- 'example' => '{'."\n"
- .' "minWordLength": "10",'."\n"
- .' "maxWordLength": "50",'."\n"
- .' "enableThinking": "true",'."\n"
- .' "thinkingBudget": "2000"'."\n"
- .' }',
+ 'required' => true,
],
],
[
- 'name' => 'apiKey',
+ 'name' => 'extraInfo',
'in' => 'formData',
- 'schema' => [
- 'description' => '集成接入的API 密钥。获取[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',
- ],
+ 'schema' => ['title' => '额外信息', 'description' => '额外信息', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
],
],
'responses' => [
@@ -392,97 +591,170 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '是否结束',
- 'type' => 'boolean',
- 'example' => '2024-06-21T10:29:52+08:00',
- ],
- 'header' => [
- 'description' => 'HTTP请求头。格式为key1:value1,通过回车键换行。',
+ 'code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'data' => [
+ 'title' => '示例格式对象',
+ 'description' => '示例格式对象',
'type' => 'object',
'properties' => [
- 'event' => [
- 'description' => 'event名称',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'description' => 'event描述',
- 'type' => 'string',
- 'example' => '可空',
- ],
- 'requestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => '436BC5AE-0573-59D8-9803-6B5FDCD3BBA1',
- ],
- 'sessionId' => [
- 'description' => '对应的会话id'."\n",
- 'type' => 'string',
- 'example' => 'uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd',
- ],
- 'taskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '13312125943232',
- ],
- 'traceId' => [
- 'description' => '跟踪ID',
- 'type' => 'string',
- 'example' => '213e20e517049392478441155e8b2a',
- ],
- 'errorMessage' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
+ 'outputFormat' => ['title' => '输出格式', 'description' => '输出格式', 'type' => 'string', 'example' => '请直接以如下JSON格式输出,不要输出其他内容:'."\n"
+ .'{'."\n"
+ .' "是否近期买房": "",'."\n"
+ .' "购房付款方式": "",'."\n"
+ .' "家庭人口数量": "",'."\n"
+ .' "房间数量需求": "",'."\n"
+ .' "买房投资诉求": "",'."\n"
+ .' "客户买房类型": "",'."\n"
+ .' "客户买房预算": "",'."\n"
+ .' "客户居住地": "",'."\n"
+ .' "用户核心需求": ['."\n"
+ .' ""'."\n"
+ .' ],'."\n"
+ .' "年龄": "",'."\n"
+ .' "性别": "",'."\n"
+ .' "职业":""'."\n"
+ .'}'."\n"],
],
],
- 'payload' => [
- 'description' => '返回结果的payload,json结构,不同event结构不同',
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '获取输出格式示例',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateOutputFormat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetEnterpriseVocAnalysisTask' => [
+ 'summary' => '获取企业VOC分析任务结果',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getEnterpriseVocAnalysisTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID'."\n", 'type' => 'string', 'required' => false, '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' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'NoPermission'],
+ 'httpStatusCode' => ['title' => 'Http状态码', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '403'],
+ 'message' => ['title' => '响应失败时的消息', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => '无权限访问接口'],
+ 'success' => ['title' => 'true:此次接口响应成功,false:响应失败', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'false'],
+ 'data' => [
+ 'title' => '结果对象',
+ 'description' => '结果对象',
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '输出',
+ 'status' => ['title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', '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' => [
- 'description' => '写作内容返回',
- 'type' => 'string',
- 'example' => 'playstation5新时代的...',
- ],
- 'reasonContent' => [
- 'title' => '模型推理内容',
- 'description' => '模型推理内容',
- 'type' => 'string',
- 'example' => '推理内容',
- ],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'inputTokens' => ['description' => '输入token量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'usage' => [
- 'description' => 'token描述',
+ 'statisticsOverview' => [
+ 'title' => '统计概览',
+ 'description' => '统计概览',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'description' => '输出token数',
- '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"],
+ ],
+ ],
+ ],
+ ],
],
- 'totalTokens' => [
- 'description' => '总token数',
- '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'],
+ ],
+ ],
+ ],
+ ],
],
],
],
+ 'modelId' => ['title' => '此次使用的模型ID', 'description' => '此次使用的模型ID', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelName' => ['title' => '此次使用的模型名称', 'description' => '此次使用的模型名称', 'type' => 'string', 'example' => '通义千问-MAX'],
],
],
],
@@ -491,109 +763,510 @@
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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' => '获取企业VOC分析任务结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '电商零售推广文案写作',
],
- 'RunMarketingInformationExtract' => [
- 'summary' => '电商零售内容实体抽取。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationExtract',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'GetEssayCorrectionTask' => [
+ 'summary' => '获取作文批改结果',
+ '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',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => '[百炼业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务唯一标识', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '路径参数,[业务空间id](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'w-08a4a3ba7104917c',
+ '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' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'successful'],
+ 'httpStatusCode' => ['title' => 'Http状态码', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'message' => ['title' => '响应失败时的消息', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => 'successful'],
+ 'success' => ['title' => 'true:此次接口响应成功,false:响应失败', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'false'],
+ 'data' => [
+ 'title' => '结果对象',
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'type' => 'string', 'example' => 'PENDING'],
+ 'errorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '任务错误消息'."\n"
+ ."\n"],
+ 'results' => [
+ 'title' => '结果列表',
+ 'description' => '结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '批改结果',
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'customId' => ['title' => '自定义ID', 'description' => 'xxx', 'type' => 'string', 'example' => '1'],
+ 'errorMessage' => ['title' => '报错信息(当报错时,此字段会有值)', 'description' => '报错信息(当报错时,此字段会有值)', 'type' => 'string', 'example' => '触发模型限流'],
+ 'errorCode' => ['title' => '错误码(当报错时,此字段会有值)', 'description' => '错误码(当报错时,此字段会有值)', 'type' => 'string', 'example' => 'RateLimit'],
+ 'result' => ['title' => '评阅结果文本', 'description' => '评阅结果', 'type' => 'string', 'example' => '评阅结果'."\n"
+ ."\n"],
+ 'score' => ['title' => '作文审阅得分(整数类型)', 'description' => '作文审阅得分', 'type' => 'integer', 'format' => 'int32', 'example' => '58'],
+ 'dimensionResults' => [
+ 'title' => '各维度评分结果(自定义维度模式)',
+ 'description' => '各维度评分结果(自定义维度模式)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '维度评分结果',
+ 'description' => '维度评分结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '维度名称', 'description' => '维度名称', 'type' => 'string', 'example' => '内容完整度'],
+ 'analysis' => ['title' => '优劣势分析', 'description' => '优劣势分析', 'type' => 'string', 'example' => '文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。'],
+ 'score' => ['title' => '得分', 'description' => '得分', 'type' => 'number', 'format' => 'double', 'example' => '25.5'],
+ 'maxScore' => ['title' => '满分', 'description' => '满分', 'type' => 'number', 'format' => 'double', 'example' => '30'],
+ ],
+ ],
+ ],
+ 'overallComment' => ['title' => '总评', 'description' => '总评', 'type' => 'string', 'example' => '整体表现良好,建议在论述深度上进一步加强。'],
+ 'usage' => ['title' => '单个任务的token消耗数', 'description' => '单个任务的token消耗数', '$ref' => '#/components/schemas/ModelUsage'],
+ ],
+ ],
+ ],
+ 'totalUsage' => ['title' => '所有任务总模型token消耗数', 'description' => '所有任务总模型token消耗数', '$ref' => '#/components/schemas/ModelUsage'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '获取作文批改任务结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetFileContent' => [
+ 'summary' => '获取文件内容',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getFileContent',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'modelId',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'fileKey',
'in' => 'formData',
+ 'schema' => ['description' => '文件FileKey(妙笔服务文件唯一标识)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/1154600634854327_10045847/300469535473178749_300469535473178749_ee11508152b74137ac5747a6f632256e.docx'],
+ ],
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '阿里云百炼平台[工作空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '大模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max'."\n"
- .'qwen-plus',
+ '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' => '是否成功:true 成功,false 失败', 'type' => 'string', 'example' => 'true'],
+ 'data' => [
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['description' => '内容', 'type' => 'string', 'example' => 'xxxx'],
+ ],
+ ],
+ 'httpStatusCode' => ['description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'code' => ['description' => '响应Code码', 'type' => 'string', 'example' => 'successful'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '获取文件内容',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetFileContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTagMiningAnalysisTask' => [
+ 'summary' => '获取挖掘分析任务结果。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getTagMiningAnalysisTask',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'extractType',
- 'in' => 'formData',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务ID'."\n", 'description' => '任务ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => 'workspaceId', 'description' => '[workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '抽取类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'point-商品卖点'."\n"
- .'introduce-商品介绍中的要素'."\n"
- .'article-营销文案中的要素'."\n"
- .'comment-对商品看法中的要素'."\n"
- .'feature-feature',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'httpStatusCode' => ['title' => 'HTTP响应吗', 'description' => 'HTTP响应吗', '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' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputToken' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'totalToken' => ['title' => '总token数', 'description' => '总token数', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
+ ],
+ ],
+ ],
+ ],
+ 'header' => [
+ 'title' => '响应头信息',
+ 'description' => '响应头信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '大模型请求ID', 'description' => '大模型请求ID', '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' => '任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'type' => 'string', 'example' => 'RUNNIN'],
+ 'errorCode' => ['title' => '错误信息', 'description' => '任务错误Code', 'type' => 'string', 'example' => '任务错误Code'."\n"
+ ."\n"],
+ 'errorMessage' => ['title' => '错误消息', 'description' => '任务错误消息', 'type' => 'string', 'example' => '任务错误消息'."\n"
+ ."\n"],
+ ],
+ ],
+ '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'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '获取标签挖掘分析任务结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTaskExecutionStatistics' => [
+ 'summary' => '查询任务执行情况统计',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/getTaskExecutionStatistics',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'customPrompt',
- 'in' => 'formData',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'taskCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务类型标识', 'description' => '任务类型标识', 'type' => 'string', 'required' => true, 'example' => 'EssayCorrectionTask'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '抽取指令',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你是一位商品广告设计师,根据下面的产品介绍,生成一句话来描述该产品的卖点。',
+ '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' => 'A1B2C3D4-E5F6-7890-GHIJ-KLMNOPQRST'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'Success'],
+ 'httpStatusCode' => ['title' => 'Http状态码', 'description' => 'Http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'message' => ['title' => '响应失败时的消息', 'description' => '响应失败时的消息', 'type' => 'string', 'example' => '成功'],
+ 'success' => ['title' => 'true:此次接口响应成功,false:响应失败', 'description' => 'true:此次接口响应成功,false:响应失败', 'type' => 'boolean', 'example' => 'true'],
+ 'data' => [
+ 'title' => '结果对象',
+ 'description' => '结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'runningCount' => ['title' => '运行中的任务个数', 'description' => '运行中的任务个数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'waitingCount' => ['title' => '排队中的任务个数', 'description' => '排队中的任务个数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'completedCount' => ['title' => '已完成的任务个数', 'description' => '已完成的任务个数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'tpmPerMinute' => [
+ 'title' => '最近一天内TPM每分钟完成任务数量',
+ 'description' => '最近一天内TPM每分钟完成任务数量',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '每分钟完成任务数',
+ 'description' => '每分钟完成任务数',
+ 'type' => 'object',
+ 'properties' => [
+ 'time' => ['title' => '时间点(分钟粒度),格式:yyyy-MM-dd HH:mm', 'description' => '时间点(分钟粒度),格式:yyyy-MM-dd HH:mm', 'type' => 'string', 'example' => '2024-08-01 10:00'],
+ 'count' => ['title' => '该分钟内完成任务数量', 'description' => '该分钟内完成任务数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询任务执行情况统计',
+ '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' => '视频理解:获取基础配置。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisConfig',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'sourceMaterials',
- 'in' => 'formData',
- 'style' => 'json',
+ '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' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '要进行抽取的内容',
- 'type' => 'array',
- 'items' => [
- 'description' => '要抽取的文章内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ps5是sony新一代的游戏机,他创新性的...',
+ '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' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'ok'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '异步任务并发数',
+ 'description' => '异步任务并发数',
+ 'type' => 'object',
+ 'properties' => [
+ 'asyncConcurrency' => ['title' => '异步任务并发数', 'description' => '异步任务并发数:取值范围[2~10]', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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"}]',
+ 'title' => '视频理解-获取配置',
+ 'description' => '阿里云百炼轻应用-视频理解-获取配置:通过这个接口可以查看异步任务并发配置。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。通过SDK方式调用API可参考控制台“API”下的示例。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ ],
+ 'GetVideoAnalysisTask' => [
+ 'summary' => '轻应用-获取视频理解异步任务结果。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisTask',
+ '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' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx'],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'required' => true, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -601,669 +1274,1523 @@
'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' => '返回结果的header',
+ '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' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'data' => [
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'event' => [
+ 'header' => [
'description' => 'event名称',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'eventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '可空',
- ],
- 'requestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => 'F08C71C0-9399-548C-838B-1DA01DE211B0',
- ],
- 'sessionId' => [
- 'description' => 'sessionId,可用于标记对话',
- 'type' => 'string',
- 'example' => '121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2',
+ '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' => '全量路ID', 'type' => 'string', 'example' => '215045f817272303448235204efdef'],
+ ],
],
- 'taskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '12826092918145',
+ 'payload' => [
+ 'description' => '结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'description' => '结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoAnalysisResult' => [
+ 'description' => '语言分析对应生成内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => 'vl生成文本结果', 'type' => 'string', 'example' => 'xxx'],
+ 'usage' => [
+ 'description' => 'Token数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'imageTokens' => ['description' => '图片token', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ ],
+ 'videoShotAnalysisResults' => [
+ 'description' => '视频每个分镜对应语言分析结果::因内容较大,请从resultJsonFileUrl文件中获取',
+ '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' => 'xxxx'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'videoCaptionResult' => [
+ 'description' => '视频字幕',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'videoCaptions' => [
+ 'description' => '视频字幕',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视频字幕',
+ 'type' => 'object',
+ 'properties' => [
+ 'endTime' => ['description' => '结束时间,相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'],
+ 'endTimeFormat' => ['description' => '结束时间,格式化结果', 'type' => 'string', 'example' => '00:01'],
+ 'startTime' => ['description' => '开始时间,相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'startTimeFormat' => ['description' => '开始时间,格式化结果', 'type' => 'string', 'example' => '00:01'],
+ 'text' => ['description' => '字幕内容', 'type' => 'string', 'example' => 'xxxx'],
+ 'speaker' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'example' => '张三'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'videoGenerateResult' => [
+ 'description' => '文本总结结果:多任务时,请从videoGenerateResults字段获取结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '生成文本', 'type' => 'string', 'example' => 'xxx'],
+ 'usage' => [
+ 'description' => '输出Token数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
+ ],
+ 'modelId' => ['description' => '模型id', 'type' => 'string', 'example' => 'qwen-max-latest'],
+ 'modelReduce' => ['description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性', 'type' => 'boolean', 'example' => 'qwen-plus-latest'],
+ 'reasonText' => ['description' => '模型思考过程', 'type' => 'string', 'example' => 'xx'],
+ 'index' => ['description' => '多任务标号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'videoMindMappingGenerateResult' => [
+ 'description' => '脑图生成结束',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '生成文本', 'type' => 'string', 'example' => '小吃街'],
+ 'usage' => [
+ 'description' => '输入Token数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
+ ],
+ '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' => '三级节点'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'videoTitleGenerateResult' => [
+ 'description' => '标题生成结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '文本生成结果', 'type' => 'string', 'example' => 'xxxx'],
+ 'usage' => [
+ 'description' => 'Token数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ ],
+ ],
+ ],
+ ],
+ 'resultJsonFileUrl' => ['title' => '全量结果文件地址:'."\n"
+ .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
+ .'当前包含的字段:'."\n"
+ .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
+ .'其他字段获取方式不变,文本方式返回。'."\n"
+ .'文件类型:json'."\n"
+ .'文件内容:全量报文,包含文本方式返回的'."\n"
+ .'返回event:task-finished', 'description' => '结果json文件地址:'."\n"
+ ."\n"
+ .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用:'."\n"
+ ."\n"
+ .'- 当前包含的字段:数据结构定义见RunVideoAnalysis接口'."\n"
+ .' - videoShotSnapshotResult:每个分片抽帧信息,包括每帧url'."\n"
+ .' - videoShotAnalysisResults:每个分片语言分析结果明细'."\n"
+ .'- 其他字段获取方式不变,文本方式返回。'."\n"
+ .'- 文件类型:json'."\n"
+ .'- 文件内容:全量报文,包含文本方式返回的'."\n"
+ .'返回event:task-finished', 'type' => 'string', 'example' => 'http://xxx'],
+ 'videoGenerateResults' => [
+ 'description' => '当入参为多任务时(textProcessTasks有值),返回文本加工结果对应这个字段,可以通过数据所在数组位置(下标)或index(1开始)找到对应结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文本加工任务结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'modelId' => ['description' => '模型id', 'type' => 'string', 'example' => 'xx'],
+ 'index' => ['description' => '多任务标号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'text' => ['description' => '生成内容', 'type' => 'string', 'example' => 'xx'],
+ 'reasonText' => ['description' => '模型思考过程', 'type' => 'string', 'example' => 'xx'],
+ 'usage' => [
+ 'description' => '用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'videoRoleRecognitionResult' => [
+ 'description' => '自动识别结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoRoles' => [
+ 'description' => '角色列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'roleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'xx'],
+ 'roleInfo' => ['description' => '人物信息', 'type' => 'string', 'example' => 'xx'],
+ 'timeIntervals' => [
+ 'description' => '角色出场时间段列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'endTime' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '342463553646'],
+ 'timestamp' => ['description' => '当前时间段角色出场时间', 'type' => 'integer', 'format' => 'int64', 'example' => '42553453253'],
+ 'url' => ['description' => '角色图片', 'type' => 'string', 'example' => 'http://'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ratio' => ['description' => '出场率', 'type' => 'number', 'format' => 'float', 'example' => '0.2'],
+ 'isAutoRecognition' => ['description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)', 'type' => 'boolean'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'videoCalculatorResult' => [
+ 'title' => '费用估算结果',
+ 'description' => '费用估算结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'items' => [
+ 'title' => '计费项明细',
+ 'description' => '计费项明细',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '计费项明细',
+ 'description' => '计费项明细',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '计费项名称', 'description' => '计费项名称', 'type' => 'string', 'example' => 'xxx'],
+ 'type' => ['title' => '名称', 'description' => '类型', 'type' => 'string', 'example' => 'token'],
+ 'inputToken' => ['title' => '类型', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputToken' => ['title' => '输入token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'time' => ['title' => '计费时长', 'description' => '计费时长', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'inputExpense' => ['title' => '输入token计费', 'description' => '输入token计费', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'outputExpense' => ['title' => '输入token计费', 'description' => '输入token计费', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'timeExpense' => ['title' => '输出token计费', 'description' => '输出token计费', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'totalExpense' => ['title' => '费用', 'description' => '费用', 'type' => 'number', 'format' => 'double', 'example' => '0.098'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'addDatasetDocumentsResult' => [
+ 'title' => '自动保存执行结果',
+ 'description' => '自动保存执行结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['title' => '自动保存任务状态:1 成功,0 失败', 'description' => '自动保存任务状态:1 成功,0 失败', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'title' => ['title' => '视频名称', 'description' => '视频名称', 'type' => 'string', 'example' => 'xx'],
+ 'docId' => ['title' => '视频docId', 'description' => '视频docId', 'type' => 'string', 'example' => 'xxx'],
+ 'errorMessage' => ['title' => '如果自动保存失败,则输出错误信息', 'description' => '如果自动保存失败,则输出错误信息', 'type' => 'string', 'example' => 'xx'],
+ 'docUuid' => ['title' => '视频的docUuid', 'description' => '视频的docUuid', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ ],
+ 'usage' => [
+ 'description' => 'token描述',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ ],
+ ],
+ ],
],
- 'traceId' => [
- 'description' => '日志轨迹ID',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
+ 'taskRunInfo' => [
+ 'title' => '运行信息',
+ 'description' => '运行信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'concurrentChargeEnable' => ['title' => '是否使用付给并发:true时,按照实际运行时长计量', 'description' => '是否使用付费并发:true时,按照实际运行时长计量', 'type' => 'boolean', 'example' => 'true'],
+ 'responseTime' => ['title' => '运行时长:rt', 'description' => '运行时长:从任务被调度开始到任务完成的耗时,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ ],
],
+ 'taskStatus' => ['description' => '任务状态。'."\n"
+ .'- PENDING:待执行'."\n"
+ .'- RUNNING:执行中'."\n"
+ .'- SUCCESSED:成功'."\n"
+ .'- SUSPENDED:暂停'."\n"
+ .'- FAILED:失败'."\n"
+ .'- CANCELED: 取消', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'errorMessage' => ['description' => '异常错误信息', 'type' => 'string', 'example' => 'Access was denied, message: No such namespace namespaces/mjp-test-default.'],
],
],
- 'payload' => [
- 'description' => '返回结果的payload,json结构,不同event结构不同',
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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\\": true\\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' => '视频理解-获取异步任务状态和结果',
+ 'description' => '阿里云百炼轻应用-视频理解-获取异步任务状态和结果:通过这个接口可以查看“提交异步任务”接口提交的视频理解任务状态和结果。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。'."\n"
+ .'> 当返回结果中包含`header -> errorCode = ViolationOfSecurityPolicy`时,表明该请求触发了系统的安全策略限制,请对请求内容进行相应的修改。此时,`videoAnalysisResult`等业务数据返回为空。'."\n"
+ .'>',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-11-24T13:17:56.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-15T11:40:37.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetVideoDetectShotConfig' => [
+ 'summary' => '智能拆条-获取配置',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoDetectShotConfig',
+ '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ ],
+ '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' => [
- 'output' => [
- 'description' => '页面展示信息',
+ '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"}]',
+ 'title' => '智能拆条-获取配置',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', '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' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'data' => [
+ 'description' => '结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'header' => [
+ 'description' => 'event名称',
'type' => 'object',
'properties' => [
- 'text' => [
- 'description' => '抽取内容返回',
- 'type' => 'string',
- 'example' => 'playstation 5新一代的...',
- ],
+ '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' => '全量路ID', 'type' => 'string', 'example' => '215045f817272303448235204efdef'],
],
],
- 'usage' => [
- 'description' => 'token描述',
+ 'payload' => [
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'description' => '输出token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
+ 'output' => [
+ 'description' => '结果',
+ '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' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'xxx', 'description' => 'xxx'],
+ 'description' => '',
+ ],
+ ],
+ 'videoRecognitionResult' => [
+ 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
+ 'description' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
+ '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'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'totalTokens' => [
- 'description' => '总token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'usage' => [
+ 'description' => 'token数量',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '36'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '49'],
+ ],
],
],
],
+ 'taskRunInfo' => [
+ 'title' => '运行信息',
+ 'description' => '运行信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'concurrentChargeEnable' => ['title' => '是否使用付给并发:true时,按照实际运行时长计量', 'description' => '是否使用付给并发:true时,按照实际运行时长计量', 'type' => 'boolean', 'example' => 'true'],
+ 'responseTime' => ['title' => '运行时长:rt', 'description' => '运行时长:rt', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ ],
+ ],
+ 'taskStatus' => ['description' => '任务状态', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'errorMessage' => ['description' => '异常错误信息', 'type' => 'string', 'example' => 'Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.'],
],
],
],
],
],
],
- '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' => '电商零售内容实体抽取',
- ],
- 'RunStyleWriting' => [
- 'summary' => '传媒/零售文章风格与格式学习。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runStyleWriting',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
- 'sse',
+ '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' => '智能拆条-获取异步任务状态和结果',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'HotNewsRecommend' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/hotNewsRecommend',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '推荐新闻的提示词', 'description' => '推荐新闻的提示词', 'type' => 'string', 'required' => false, 'example' => '今天的财经新闻'],
+ ],
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
],
- 'produces' => [
- 'application/octet-stream',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '阿里云为该请求生成的唯一标识符。', 'description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '575D5893-01DB-5C81-A899-74F67616762A'],
+ 'code' => ['title' => '接口返回码:200:表示成功。其它:表示错误码。错误码详情,请参见错误码。', 'description' => '接口返回码:200:表示成功。其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
+ 'success' => ['title' => '是否调用成功:true:调用成功。 false:调用失败。', 'description' => '是否调用成功:true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'ok'],
+ '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' => 'QuarkCommonNews:联网检索'],
+ 'imageUrls' => [
+ 'title' => '新闻图片列表',
+ 'description' => '新闻图片列表',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址列表', 'type' => 'string', 'example' => 'http://www.example.com/xxx.png'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '新闻热点推荐',
+ 'summary' => '热点新闻推荐',
+ 'description' => '理解用户意图,获取对应频道下热点列表,比如“播报体育新闻”。历史接口,建议走“播报单(热榜)问答接口 RunHotTopicChat”,完全覆盖了当前接口的能力。'."\n"
+ ."\n"
+ .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
+ ."\n"
+ .'通过SDK方式调用API可参考控制台“API”下的java、python示例。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:HotNewsRecommend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
+ ],
+ 'ListAnalysisTagDetailByTaskId' => [
+ 'summary' => '获取挖掘分析结果明细列表',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/listAnalysisTagDetailByTaskId',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ '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' => 'nextToken',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '标记当前开始读取的位置,置空表示从头开始', 'description' => '标记当前开始读取的位置,置空表示从头开始', 'type' => 'string', 'required' => false, 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g=='],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '本次读取的最大数据记录数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => ['title' => '挖掘的任务ID', 'description' => '挖掘的任务ID', 'type' => 'string', 'required' => true, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9xb8mx',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'totalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', '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' => 'MaxResults本次请求所返回的最大记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'code' => ['title' => '响应Code码', 'description' => '响应Code码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'message' => ['title' => '响应消息', 'description' => '响应消息', 'type' => 'string', 'example' => '成功'],
+ 'success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'false'],
+ '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' => '标签值'],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'originResponse' => ['title' => '原始挖掘响应', 'description' => '原始挖掘响应', 'type' => 'string', 'example' => '原始响应'],
+ 'sourceList' => [
+ 'title' => '溯源原文列表,启用sourceTrace时会返回该字段',
+ 'description' => '溯源原文列表,启用sourceTrace时会返回该字段',
+ 'type' => 'array',
+ 'items' => ['title' => '溯源原文,启用sourceTrace时会返回该字段', 'description' => '溯源原文,启用sourceTrace时会返回该字段', 'type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '获取挖掘结果明细列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListHotTopicSummaries' => [
+ 'summary' => '阿里云百炼-轻应用-车机/内容平台新闻热榜互动-查询完整播报单(热榜):通过这个接口可以获取播报单所有内容。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/listHotTopicSummaries',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'learningSamples',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '百炼业务空间唯一标识,百炼首页左上角获取', 'description' => '百炼业务空间唯一标识,百炼首页左上角获取', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'category',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '分类', 'description' => '分类', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'hotTopic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热点话题', 'description' => '热点话题', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'hotTopicVersion',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热点话题版本', 'description' => '热点话题版本', 'type' => 'string', 'required' => false, 'example' => '2024-09-13_12'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g=='],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '每页返回最大数量。'."\n"
+ ."\n"
+ .'> 默认100,最大1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '20'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '需要作为学习样本的文章集合',
- 'description' => '需要作为学习样本的文章集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '需要作为学习样本的文章',
- 'type' => 'string',
- 'required' => false,
- 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ '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' => '热点话题ID', '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'],
+ ],
+ ],
+ ],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', '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' => '下一页的token', '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'totalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
- 'required' => false,
- 'example' => '["在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
- .'"]',
- 'maxItems' => 10,
- 'minItems' => 1,
],
],
+ ],
+ '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' => '查询完整播报单(热榜)',
+ 'description' => '通过这个接口可以获取“完整播报单(热榜)”下所有内容,包括频道、热点、热度、播报摘要等,默认获取当前最近版本的播报单,通过制定版本可以获取指定时间段系统版本或自定义版本的播报单内容。'."\n"
+ ."\n"
+ .'建议走最新的[**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)接口:出入参更完善。'."\n"
+ ."\n"
+ .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
+ ."\n"
+ .'通过SDK方式调用API可参考控制台“API”页签下的java、python示例。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListHotTopicSummaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RunEnterpriseVocAnalysis' => [
+ 'summary' => '企业VOC分析。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runEnterpriseVocAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
[
- 'name' => 'writingTheme',
+ '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'taskDescription',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户输入的写作主题,可以对主题进行自定义调整效果',
- 'description' => '用户输入的写作主题,可以对主题进行自定义调整效果',
- 'type' => 'string',
- 'required' => false,
- 'example' => '帮我写一篇关于妙笔产品等文案',
- 'maxLength' => 2000,
- ],
+ 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => '你是一名经验丰富的数据分析师,擅长从文本评论中提取结构化信息。你需要从用户评论列表中识别和提取出与以下四个维度相关的关键词和短语:'."\n"
+ .' '."\n"
+ .' 索引:输入评论JSON数组中的索引(从零开始)表示针对该条索引抽取的维度。'."\n"
+ .' 购买动机:描述用户购买产品的原因、需求或驱动力的关键词或短语。'."\n"
+ .' 未满足需求点:用户在使用产品过程中提到的未满足需求或问题的关键词或短语。'."\n"
+ .' 使用场景:用户提到的具体使用场景、使用方式或环境的关键词或短语。'."\n"
+ .' 正负面观点:明确表示用户对产品或服务的正面或负面看法的关键词或短语。'],
],
[
- 'name' => 'styleFeature',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文体特征标识符。如果指定了此参数,接口会按照指定的文体特征进行写作',
- 'description' => '文体特征标识符。如果指定了此参数,接口会按照指定的文体特征进行写作',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章特点1:标题采用话题标签形式,增强社交媒体传播性。\\n文章特点2:开篇通过引言简述背景,快速关联当下热点话题。\\n文章特点3:使用记者调查作为支撑,列举具体行业实例,增强论述的现实基础。\\n文章特点4:引入法律观点平衡论述,提供政策依据,并倡导正面价值观。\\n\\n示例文章特点总结:该文以社会热点为导向,运用具有传播力的标题设计,通过现象观察引入话题,结合实地调查数据展现广泛的社会现象,同时援引法律规定进行评析,确保论述客观性,并在结尾处倡导积极健康的职场文化,整体结构紧凑,信息丰富且具有引导性。',
- 'maxLength' => 1000,
- ],
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
],
[
- 'name' => 'referenceMaterials',
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '额外信息(业务补充信息)', 'description' => '额外信息(业务补充信息)', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['title' => '输出格式', 'description' => '输出格式', 'type' => 'string', 'required' => false, 'example' => '按照如下格式输出:{"text1": "xxxx", "text2": "xxxx"}'],
+ ],
+ [
+ 'name' => 'content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '这是一段需要分析的文本内容'],
+ ],
+ [
+ 'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '大模型生成功能的内容素材模型集合',
- 'description' => '大模型生成功能的内容素材模型集合',
+ 'title' => '业务标签体系',
+ 'description' => '业务标签体系',
'type' => 'array',
'items' => [
- 'description' => '大模型生成功能的内容素材',
- 'type' => 'string',
+ 'description' => '标签体系列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '标签名称'],
+ 'tagDefinePrompt' => ['description' => '标签定义提示词', 'type' => 'string', 'required' => false, 'example' => '标签定义提示词'],
+ ],
'required' => false,
- 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。',
],
'required' => false,
- 'example' => '是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
- .'"]',
],
],
[
- 'name' => 'processStage',
+ 'name' => 'filterTags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => ' * 代表处理阶段'."\n"
- .' * "full": 生成特点分析和创作内容'."\n"
- .' * "analysisStage": 仅生成特点分析'."\n"
- .' * "creationStage": 仅生成创作内容',
- 'description' => ' * 代表处理阶段'."\n"
- .' * "full": 生成特点分析和创作内容'."\n"
- .' * "analysisStage": 仅生成特点分析'."\n"
- .' * "creationStage": 仅生成创作内容',
- 'type' => 'string',
+ 'title' => '过滤标签',
+ 'description' => '过滤标签',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '标签名称'],
+ 'tagDefinePrompt' => ['description' => '标签定义提示词', 'type' => 'string', 'required' => false, 'example' => '标签定义提示词'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
],
],
[
- 'name' => 'useSearch',
+ 'name' => 'apiKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否自动检索互联网补充素材',
- 'description' => '是否自动检索互联网补充素材',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '百炼APIKEY', 'description' => '百炼APIKEY', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxx'],
+ ],
+ [
+ 'name' => 'akProxy',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'none', 'type' => 'string', 'required' => false, 'example' => 'none'],
+ ],
+ [
+ 'name' => 'sourceTrace',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否启用溯源(启用溯源时不支持自定义outputformat)', 'description' => '是否启用溯源(启用溯源时不支持自定义outputformat)', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'positiveFilter',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否正向筛选(true-正向筛选,默认;false-反向筛选)', 'type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '响应',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '输出是否完成,true表示完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'header' => [
- 'description' => '流式输出 header头,包含返回通用信息',
+ 'title' => '消息头',
+ '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' => '请求ID',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '一次会话ID',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '一次生成任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
],
- 'example' => '{"event":"task-progress-start-generating","sessionId":"3cd10828-0e42-471c-8f1a-931cde20b035","taskId":"d3be9981-ca2d-4e17-bf31-1c0a628e9f99","traceId":"66bef4a7f5d61ff3c43f3b710574e175"}',
],
'payload' => [
- 'description' => '返回结果的payload,json结构,不同event结构不同',
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出内容对象',
- 'description' => '输出内容对象',
+ 'title' => '输出结果',
+ 'description' => '输出结果',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '这是测试输出',
+ 'text' => ['title' => '输出摘要文本', 'description' => '输出摘要文本', 'type' => 'string', 'example' => '输出摘要文本'."\n"
+ ."\n"],
+ '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'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
+ 'reasonContent' => ['title' => '推理模型返回的推理内容', 'description' => '推理模型返回的推理内容', 'type' => 'string'],
],
- 'example' => '{'."\n"
- .' "text": "这是测试输出"'."\n"
- .' }',
],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '大模型token用量信息',
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
- 'example' => '{'."\n"
- .' "inputTokens": 1816,'."\n"
- .' "outputTokens": 96,'."\n"
- .' "totalTokens": 1912'."\n"
- .' }',
],
],
- 'example' => '{'."\n"
- .' "output": {'."\n"
- .' "text": "这是测试输出"'."\n"
- .' },'."\n"
- .' "usage": {'."\n"
- .' "inputTokens": 1816,'."\n"
- .' "outputTokens": 96,'."\n"
- .' "totalTokens": 1912'."\n"
- .' }'."\n"
- .'}',
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '49483FFC-0CB9-5163-8D3E-234E276E6DA8'],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '在线企业VOC分析',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-17T11:51:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEnterpriseVocAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '传媒/零售文章风格与格式学习',
+ '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"}]',
],
- 'RunScriptRefine' => [
- 'summary' => '剧本对话内容的整理。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptRefine',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunEssayCorrection' => [
+ 'summary' => '作业批改',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runEssayCorrection',
+ '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' => 'none',
- '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' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-zna577pdximvztk5',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxxxxx'],
],
[
- 'name' => 'taskId',
+ 'name' => 'grade',
+ 'in' => 'formData',
+ 'schema' => ['title' => '年级', 'description' => '年级', 'type' => 'string', 'required' => false, 'example' => '初中一年级'],
+ ],
+ [
+ 'name' => 'subject',
+ 'in' => 'formData',
+ 'schema' => ['title' => '学科', 'description' => '学科', 'type' => 'string', 'required' => false, 'example' => '语文'],
+ ],
+ [
+ 'name' => 'totalScore',
+ 'in' => 'formData',
+ 'schema' => ['title' => '总分', 'description' => '总分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'question',
+ 'in' => 'formData',
+ 'schema' => ['title' => '题目', 'description' => '题目不能为空', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'answer',
'in' => 'formData',
+ 'schema' => ['title' => '作答内容', 'description' => '作答内容', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'otherReviewPoints',
+ 'in' => 'formData',
+ 'schema' => ['title' => '其他评审要点', 'description' => '其他评审要点', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID,默认作文批改模型1'."\n"
+ .'```json'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "ModelName": "自定义批改模型",'."\n"
+ .' "ModelId": "qwen-custom-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "作文批改模型1",'."\n"
+ .' "ModelId": "qwen-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "作文批改轻量模型",'."\n"
+ .' "ModelId": "qwen-correction-v1-lite"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => 'qwen-correction-v1'],
+ ],
+ [
+ 'name' => 'dimensions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID,相同的任务ID,表示一组任务对话',
- 'description' => '任务唯一标识'."\n"
- ."\n"
- .'> '."\n"
- .'>- taskId默认无需填写,系统将自动生成。当后续任务填写的taskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>- 建议手动赋值taskId,以便关联上下文。',
- 'type' => 'string',
+ 'title' => '自定义评分维度列表(仅 qwen-custom-correction-v1 模型支持)',
+ 'description' => '自定义评分维度列表(仅 qwen-custom-correction-v1 模型支持)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '自定义评分维度',
+ 'description' => '自定义评分维度',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '维度名称', 'description' => '维度名称', 'type' => 'string', 'required' => false, 'example' => '内容完整度'],
+ 'rubric' => ['title' => '维度细则描述', 'description' => '维度细则描述', 'type' => 'string', 'required' => false, 'example' => '文章内容是否完整,是否涵盖了题目的核心要求'],
+ 'maxScore' => ['title' => '维度满分', 'description' => '维度满分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- 'maxLength' => 1000,
+ 'example' => '[{"name": "内容完整度", "rubric": "文章内容是否完整,是否涵盖了题目的核心要求", "maxScore": 30}]',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '响应',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '输出是否完成,true 表示完成',
- 'type' => 'boolean',
- ],
'header' => [
- 'description' => '流式输出 header头,包含返回通用信息',
+ 'title' => '消息头',
+ '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' => '请求ID',
- 'type' => 'string',
- 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '一次会话ID',
- 'type' => 'string',
- 'example' => '17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '一次生成任务ID',
- 'type' => 'string',
- 'example' => '14356391-6c6c-40d5-b80a-8ecd03b69d72',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
],
],
'payload' => [
- 'description' => '返回结果的payload,json结构,不同event结构不同',
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出内容对象',
- 'description' => '输出内容对象',
+ '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' => '正文',
+ 'text' => ['title' => '输出摘要文本', 'description' => '审阅结果', 'type' => 'string', 'example' => '审阅结果'."\n"
+ ."\n"],
+ 'reasoningContent' => ['title' => '推理思考过程', 'description' => '推理思考过程', 'type' => 'string', 'example' => '首先分析文章结构,发现开头、正文、结尾完整...'],
+ 'score' => ['title' => '作文审阅得分', 'description' => '作文审阅得分', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'dimensionResults' => [
+ 'title' => '各维度评分结果(自定义维度模式)',
+ 'description' => '各维度评分结果(自定义维度模式)',
'type' => 'array',
'items' => [
- 'description' => '正文',
+ 'title' => '维度评分结果',
+ 'description' => '维度评分结果',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"第一幕":" 幕次: 第一幕\\n\\n 场面描述"}',
- 'description' => '正文,剧幕内容',
+ 'properties' => [
+ 'name' => ['title' => '维度名称', 'description' => '维度名称', 'type' => 'string', 'example' => '内容完整度'],
+ 'analysis' => ['title' => '优劣势分析', 'description' => '优劣势分析', 'type' => 'string', 'example' => '文章内容较为完整,涵盖了题目的核心要求,但部分论述略显简略。'],
+ 'score' => ['title' => '得分', 'description' => '得分', 'type' => 'number', 'format' => 'double', 'example' => '25.5'],
+ 'maxScore' => ['title' => '满分', 'description' => '满分', 'type' => 'number', 'format' => 'double', 'example' => '30'],
],
],
],
+ 'overallComment' => ['title' => '总评', 'description' => '总评', 'type' => 'string', 'example' => '整体表现良好,建议在论述深度上进一步加强。'],
],
],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '大模型Token用量信息',
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
],
],
],
- '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' => '作文批改',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-02T05:52:12.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEssayCorrection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '影视互娱剧本创作-剧本整理',
],
- 'RunScriptChat' => [
- 'summary' => '长剧本创作。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptChat',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunHotTopicChat' => [
+ 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单(热榜)问答:可以对播报单、新闻、开放域内容问答。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicChat',
+ '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' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据模型ID。默认:qwen-max-latest', 'type' => 'string', 'required' => false, 'example' => 'qwen-max-latest'],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'prompt模版', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'generateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-rz8db8d00rcn2p0xc',
+ 'title' => '生成模式列表:默认textChatGenerate',
+ 'description' => '生成模式列表:默认textChatGenerate',
+ 'type' => 'array',
+ 'items' => ['title' => '生成模式:'."\n"
+ .'- categoryRecommend:频道热点推荐'."\n"
+ .'- textChatGenerate:问答(默认)'."\n"
+ .'- internetSearch:互联网搜索'."\n"
+ .'- queryRecommend:query推荐', 'description' => '生成模式:summaryChatGenerate、newsChatGenerate和控制台第三步两个选项对应,可以直接使用,其他场景可以按需要组合:'."\n"
+ .'- 能力组合:内置好的,原子能力+搜索源的组合'."\n"
+ .' - summaryChatGenerate:对应轻应用控制台“仅针对聚合新闻播报单内已包含的信息进行回答”,包括categoryRecommend, hotTopicSummarySearch, textChatGenerate'."\n"
+ .' - newsChatGenerate:对应轻应用控制台“允许针对新闻的原始素材和互联网开放域进行搜索后回答“,包括hotTopicNewsSearch, internetSearch, textChatGenerate'."\n"
+ .'- 原子能力:'."\n"
+ .' - categoryRecommend:频道热点推荐,比如“推荐下体育新闻”'."\n"
+ .' - textChatGenerate:问答,仅次选项时,必须明确指定源internetSearch、hotTopicSummarySearch、hotTopicNewsSearch,比如“xxx事件哪天发生的”'."\n"
+ .' - queryRecommend:开启query推荐,单独结构返回'."\n"
+ .'- 搜索源:'."\n"
+ .' - hotTopicSummarySearch:热榜摘要搜索源'."\n"
+ .' - hotTopicNewsSearch:热榜新闻详情搜索源'."\n"
+ .' - internetSearch:互联网通用领域搜索源', 'type' => 'string', 'required' => false, 'example' => 'newsChatGenerate'],
+ 'required' => false,
],
],
[
+ 'name' => 'taskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '对话任务唯一标识:多轮时,这个值保持不变', 'description' => '对话任务唯一标识:多轮时,这个值保持不变', 'type' => 'string', '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'],
+ ],
+ [
'name' => 'prompt',
'in' => 'formData',
+ 'schema' => ['title' => '用户问题', 'description' => '用户问题', 'type' => 'string', 'required' => false, 'example' => '帮我播报体育热点'],
+ ],
+ [
+ 'name' => 'hotTopicVersion',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热榜版本', 'description' => '热榜版本', 'type' => 'string', 'required' => false, 'example' => '2024-09-13_12'],
+ ],
+ [
+ 'name' => 'category',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热榜中平道', 'description' => '热榜频道', 'type' => 'string', 'required' => false, 'example' => '体育'],
+ ],
+ [
+ 'name' => 'hotTopics',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '用户输入的剧本指令',
- 'description' => '用户输入的剧本指令',
- 'type' => 'string',
- 'required' => true,
- 'example' => '创建角色:林晓晓',
- 'maxLength' => 9000,
+ 'title' => '热点名称列表',
+ 'description' => '热点名称列表',
+ 'type' => 'array',
+ 'items' => ['title' => '热点标题名称', 'description' => '热点标题名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'required' => false,
],
],
[
- 'name' => 'taskId',
+ 'name' => 'imageCount',
'in' => 'formData',
+ 'schema' => ['title' => '配图张数:不一定都有图', 'description' => '配图张数:不一定都有图,取值[1-3]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'stepForBroadcastContentConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID,相同的任务ID,表示一组任务对话',
- 'description' => '任务唯一标识'."\n"
- ."\n"
- .'> '."\n"
- .'>- taskId默认无需填写,系统将自动生成。当后续任务填写的taskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>- 建议手动赋值taskId,以便关联上下文。',
- 'type' => 'string',
+ 'title' => '新闻播报内容配置:仅Saas用,Paas调用建议走hotTopicVersion',
+ 'description' => '新闻播报内容配置:仅Saas用,Paas调用建议走hotTopicVersion',
+ 'type' => 'object',
+ 'properties' => [
+ 'categories' => [
+ 'title' => '选择的频道列表',
+ 'description' => '选择的频道列表',
+ 'type' => 'array',
+ 'items' => ['title' => '频道', 'description' => '频道', 'type' => 'string', 'required' => false, 'example' => '体育'],
+ 'required' => false,
+ ],
+ 'customHotValueWeights' => [
+ 'title' => '热度计算维度',
+ 'description' => '热度计算维度,不传,则走默认',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '热度计算维度列表',
+ 'description' => '热度计算维度列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'dimension' => ['title' => '权重维度唯一标识:'."\n"
+ .'- views("阅读量")'."\n"
+ .'- comments("评论量")'."\n"
+ .'- ups("点赞数")'."\n"
+ .'- downs("点踩数")'."\n"
+ .'- publishTime("发布时间")', 'description' => '权重维度唯一标识:'."\n"
+ .'- views("阅读量")'."\n"
+ .'- comments("发表观点量")'."\n"
+ .'- ups("点赞数")'."\n"
+ .'- downs("点踩数")'."\n"
+ .'- publishTime("发布时间")', 'type' => 'string', 'required' => false, 'example' => 'comments'],
+ 'weight' => ['title' => '权重,0-10之间', 'description' => '权重,0-10之间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'topicCount' => ['title' => '话题数量', 'description' => '话题数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'messages',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '上下文',
+ 'description' => '上下文',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '角色:user、assistant、system',
+ 'description' => '角色:user、assistant、system',
+ 'type' => 'object',
+ 'properties' => [
+ 'role' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ 'content' => ['title' => '发生时间', 'description' => '发生时间', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'createTime' => ['title' => '时间', 'description' => '时间', 'type' => 'string', 'required' => false, 'example' => '2024-12-10 18:51:29'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- 'maxLength' => 1000,
],
],
],
@@ -1274,466 +2801,396 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'description' => '输出是否完成,true 表示完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'header' => [
- 'description' => '流式输出 header头,包含返回通用信息',
+ 'title' => '消息头',
+ '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' => '请求ID',
- 'type' => 'string',
- 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '一次会话ID',
- 'type' => 'string',
- 'example' => '147648697127_914847410985_1730600302167',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '一次生成任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
],
],
'payload' => [
- 'description' => '返回结果的 payload,json 结构',
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出内容对象',
- 'description' => '输出内容对象',
+ 'title' => '输出结果',
+ 'description' => '输出结果',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '以下是角色信息',
+ 'articles' => [
+ 'title' => '参照内容列表',
+ 'description' => '参照内容列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '内容列表',
+ 'description' => '内容列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '正文', 'description' => '正文', 'type' => 'string', 'example' => 'xxx'],
+ 'pubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-09-22 16:45:06'],
+ 'score' => ['title' => '相关度', 'description' => '相关度', 'type' => 'number', 'format' => 'double', 'example' => '0.8'],
+ 'searchSourceName' => ['title' => '文章来源名称', 'description' => '文章来源名称', 'type' => 'string', 'example' => '互联网'],
+ 'select' => ['title' => '是否参照', 'description' => '是否参照', 'type' => 'boolean', 'example' => 'true'],
+ 'summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'test'],
+ 'url' => ['title' => '链接', 'description' => '链接', 'type' => 'string', 'example' => 'http://xxx'],
+ ],
+ ],
],
+ 'hotTopicSummaries' => [
+ 'title' => '热点列表',
+ 'description' => '热点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '热点',
+ 'description' => '热点',
+ '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' => '热点话题文本摘要', 'description' => '热点话题文本摘要', 'type' => 'string', 'example' => 'xxx'],
+ 'customTextSummary' => ['title' => '自定义热点话题文本摘要', 'description' => '自定义热点话题文本摘要', 'type' => 'string', 'example' => 'xxx'],
+ 'news' => [
+ 'title' => '新闻列表',
+ 'description' => '新闻列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '新闻',
+ 'description' => '新闻',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xxx'],
+ 'url' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'http://xxx'],
+ ],
+ ],
+ ],
+ 'images' => [
+ 'title' => '图片列表',
+ 'description' => '图片列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '图片',
+ 'description' => '图片',
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['title' => '图片', 'description' => '图片', 'type' => 'string', 'example' => 'http://www.example.com/xxx.png'],
+ ],
+ ],
+ ],
+ 'url' => ['title' => '热点话题的URL', 'description' => '热点话题的URL', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'],
+ 'pubTime' => ['title' => '热点话题发布时间', 'description' => '热点话题发布时间', 'type' => 'string', 'example' => '2025-05-20 12:00:00'],
+ ],
+ ],
+ ],
+ 'multimodalMedias' => [
+ 'title' => '配图',
+ 'description' => '配图',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '配图',
+ 'description' => '配图',
+ 'type' => 'object',
+ 'properties' => [
+ 'fileUrl' => ['title' => '链接', 'description' => '链接', 'type' => 'string', 'example' => 'http://xxxx'],
+ 'mediaType' => ['title' => '类型:'."\n"
+ .'- image:图片', 'description' => '类型:'."\n"
+ .'- image:图片', 'type' => 'string', 'example' => 'image'],
+ 'sortScore' => ['title' => '相关度', 'description' => '相关度', 'type' => 'number', 'format' => 'double', 'example' => '0.8'],
+ ],
+ ],
+ ],
+ 'recommendQueries' => [
+ 'title' => '推荐query列表',
+ 'description' => '推荐query列表',
+ 'type' => 'array',
+ 'items' => ['title' => '推荐query', 'description' => '推荐query', 'type' => 'string', 'example' => '关于xx你有什么看法?'],
+ ],
+ 'searchQuery' => ['title' => '改写后query', 'description' => '改写后query', 'type' => 'string', 'example' => 'xxx'],
+ 'text' => ['title' => '生成正文:答案等', 'description' => '生成正文:答案等', 'type' => 'string', 'example' => 'xx'],
+ 'category' => ['title' => '新闻播报场景的领域识别(时政、社会、国际等频道识别)', 'description' => '新闻播报场景的领域识别(时政、社会、国际等频道识别)', 'type' => 'string', 'example' => '国际'],
+ 'keyword' => ['title' => '新闻播报场景的关键字识别', 'description' => '新闻播报场景的关键字识别', 'type' => 'string', 'example' => 'AI'],
+ 'location' => ['title' => '新闻播报场景的地点名识别', 'description' => '新闻播报场景的地点名识别', 'type' => 'string', 'example' => '杭州'],
],
],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '大模型Token用量信息',
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8'],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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' => '播报单(热榜)问答',
+ 'description' => '## 当前接口RunHotTopicChat说明'."\n"
+ .'通过此接口,可以对播报单(热榜)、热榜新闻、开放域内容做问答,包括频道推荐、热点推荐、热点内容问答等。'."\n"
+ ."\n"
+ .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
+ ."\n"
+ .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
+ ."\n"
+ .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
+ ."\n"
+ .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
+ ."\n"
+ .'## 新闻热榜互动全量API说明'."\n"
+ .'### API明细'."\n"
+ ."\n"
+ .'#### AI妙笔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) - **查询完整播报单(热榜)** --常用'."\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) - 提交自定义播报单任务'."\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) - 获取自定义播报单任务结果'."\n"
+ ."\n"
+ .'#### 阿里云百炼全妙轻应用SDK下:对应alibabacloud-quanmiaolightapp20240801'."\n"
+ ."\n"
+ .'- **RunHotTopicChat** - **播报单(热榜)问答** --常用'."\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) - 播报单热点自定义摘要生成'."\n"
+ ."\n"
+ .'### 场景说明'."\n"
+ .'#### 场景1:获取完整播报单(热榜)全量或者部分频道热点:'."\n"
+ .'- GetHotTopicBroadcast:查询播报单'."\n"
+ ."\n"
+ .'#### 场景2:针对播报单或通用领域问题做问答:'."\n"
+ .'- RunHotTopicChat:问答'."\n"
+ ."\n"
+ .'#### 场景3:内置播报单(热榜)不满足要求,需要个性化定制(频道、个性化摘要等):'."\n"
+ .'- SubmitCustomHotTopicBroadcastJob:提交自定义播报单任务'."\n"
+ .'- GetCustomHotTopicBroadcastJob:轮训自定义播报单任务状态'."\n"
+ .'- GetHotTopicBroadcast:获取自定义播报单信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T11:27:41.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-11T12:52:13.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-03T13:08:10.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-03T03:26:38.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '影视互娱剧本创作-交互式创作',
],
- 'RunScriptPlanning' => [
- 'summary' => '影视互娱乐剧本创作-剧本策划。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptPlanning',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunHotTopicSummary' => [
+ 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单热点自定义摘要生成:流式生成自定义风格的热点摘要。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicSummary',
+ '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' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-e9zzbkg0aj2mlXX',
- ],
+ 'schema' => ['description' => '路径参数,[业务空间id](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'scriptName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '自然语言输入剧本名称'."\n",
- 'description' => '自然语言输入剧本名称'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '都市战神',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptTypeKeyword',
+ 'name' => 'hotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'description' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '现代,都市,爱情,玄幻',
- 'maxLength' => 5000,
- ],
+ 'schema' => ['title' => '热点播报单版本号', 'description' => '热点播报单版本号', 'type' => 'string', 'required' => true, 'example' => '2024-10-16_8'],
],
[
- 'name' => 'scriptSummary',
+ 'name' => 'topicIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'description' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'type' => 'string',
+ 'title' => '要进行摘要热点话题ID列表',
+ 'description' => '要进行摘要热点话题ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '热点ID', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
'required' => true,
- 'example' => '在一个宁静的小镇上,每个家庭都在同一天收到一个神秘的、没有标记的包裹。',
- 'maxLength' => 5000,
- ],
- ],
- [
- 'name' => 'scriptShotCount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的分镜数量:单个剧本内用户可以定义生成对应的镜头描述数量【1-10个】',
- 'description' => '剧本的分镜数量:单个剧本内用户可以定义生成对应的镜头描述数量,取值范围为1~10个',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10',
- 'minimum' => '1',
- 'example' => '3',
- 'default' => '3',
- ],
- ],
- [
- 'name' => 'dialogueInScene',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否需要具体分镜对白,default=false',
- 'description' => '是否需要具体分镜对白,default=false',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'plotConflict',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '可读性:用户可以勾选是否增加剧情冲突、反转情节的策划内容,勾选后可自动生成在剧情中',
- 'description' => '可读性:用户可以勾选是否增加剧情冲突、反转情节的策划内容,勾选后可自动生成在剧情中',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'true',
+ 'example' => 'xxxxx',
],
],
[
- 'name' => 'additionalNote',
+ 'name' => 'stepForCustomSummaryStyleConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '其他补充:用户可以在文本输入框中,通过自然语言的描述进行开放性调整,例如增加紧张刺激时刻的描述等等,帮助用户进行效果调整',
- 'description' => '其他补充:用户可以在文本输入框中,通过自然语言的描述进行开放性调整,例如增加紧张刺激时刻的描述等等,帮助用户进行效果调整',
- 'type' => 'string',
- 'required' => false,
- 'example' => '故事尽可能狗血',
- 'maxLength' => 5000,
+ 'title' => '自定义输出风格配置',
+ 'description' => '自定义输出风格配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'summaryImageCount' => ['title' => '摘要图片数量', 'description' => '摘要图片数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ 'summaryPrompt' => ['title' => '自定义摘要Prompt', 'description' => '自定义摘要Prompt', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '响应',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'end' => [
- 'title' => '输出是否完成,true 表示完成',
- 'description' => '输出是否完成,true 表示完成',
- 'type' => 'boolean',
- ],
'header' => [
- 'title' => '流式输出 header 头,包含返回通用信息',
- 'description' => '流式输出 header 头,包含返回通用信息',
+ 'title' => '消息头',
+ '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' => '请求ID',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '一次会话ID',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '一次生成任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
],
],
'payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出内容对象',
- 'description' => '输出内容对象',
+ 'title' => '输出结果',
+ 'description' => '输出结果',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '这是测试输出',
- ],
+ 'text' => ['title' => '输出摘要文本', 'description' => '输出摘要文本', 'type' => 'string', 'example' => '这是测试输出'],
+ 'topicId' => ['title' => '热点ID', 'description' => '热点ID', 'type' => 'string', 'example' => 'xxx'],
],
],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '大模型token用量信息',
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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 \\"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"}]',
+ 'title' => '播报单热点自定义摘要生成',
+ 'description' => '通过此接口,可以流式生成播报单热点下自定义风格的热点摘要。'."\n"
+ ."\n"
+ .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
+ ."\n"
+ .'通过SDK方式调用API可参考控制台“API”下的示例。',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-13T13:25:04.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '影视互娱剧本创作-剧本策划',
- 'description' => '根据用户对剧本前要的简单输入,就可得到剧本梗概及分镜头的简要描述,帮助编辑人员快速构思剧本框架',
],
- 'RunScriptContinue' => [
- 'summary' => '影视互娱乐剧本创作-剧本续写。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptContinue',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'RunMarketingInformationExtract' => [
+ 'summary' => '电商零售内容实体抽取。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationExtract',
+ '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' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-e9zzbkg0aj2mlXX',
- ],
+ 'schema' => ['description' => '路径参数,[业务空间id](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'w-08a4a3ba7104917c'],
],
[
- 'name' => 'scriptTypeKeyword',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'description' => '剧本类型关键词:用户针对该剧本类型进行定性描述,如历史架空、科幻、爱情、玄幻等描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '悬疑,都市,惊悚',
- 'maxLength' => 5000,
- ],
+ 'schema' => ['description' => '大模型ID。', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'."\n"
+ .'qwen-plus'],
],
[
- 'name' => 'scriptSummary',
+ 'name' => 'extractType',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'description' => '剧本梗概:用户针对该剧本进行简短的故事说明',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一队全副武装的执法人员和消防员闯入了一间明显已被遗弃多日、门窗紧闭并用胶带封死的公寓,面对着屋内令人作呕的恶臭和门厅里的混乱场面,他们似乎在寻找某种隐藏的真相或危险源,而一封日期为16号的信件成为了揭开谜团的关键线索,随着便衣探员深入探索,一系列封闭的房间暗示着这里曾发生过不为人知的秘密事件。',
- 'maxLength' => 5000,
- ],
+ 'schema' => ['description' => '抽取类型', 'type' => 'string', 'required' => false, 'example' => 'point-商品卖点'."\n"
+ .'introduce-商品介绍中的要素'."\n"
+ .'article-营销文案中的要素'."\n"
+ .'comment-对商品看法中的要素'."\n"
+ .'feature-feature'],
],
[
- 'name' => 'userProvidedContent',
+ 'name' => 'customPrompt',
'in' => 'formData',
+ 'schema' => ['description' => '抽取指令', 'type' => 'string', 'required' => false, 'example' => '你是一位商品广告设计师,根据下面的产品介绍,生成一句话来描述该产品的卖点。'],
+ ],
+ [
+ 'name' => 'sourceMaterials',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '上文补充描述:用户针对某一段小说内容续写,需要用户提供上文补充',
- 'description' => '上文补充描述:用户针对某一段小说内容续写,需要用户提供上文补充',
- 'type' => 'string',
- 'required' => true,
- 'example' => '门厅一片狼藉。朝向天井的窗户开着。公寓门突然被撞开了。\\n一名便衣探员、两名穿制服的警察和几位消防员———也身着工作服———进来,四下张望。他们都戴着手套以及盖住口鼻的面罩。在他们身后,门房和他妻子也挤进门厅。他们都捂着鼻子。门房的另一只手里拿着一叠信件和促销广告单。他们身后,跟着一位女邻居。\\n便衣探员(对门房和邻居):请在外面等候。\\n他向一名警察示意,警察正忙着把好奇的旁观者请出门外。\\n警察(对门房,指着那一叠信件):最近的一封是哪天的?\\n门房(查对信件):最近的一封似乎是16号的......等一下......\\n便衣探员想打开左侧的门,却是徒劳。门用胶带封上了。\\n便衣探员(对消防员):你来试一下好吗?\\n消防员摆弄门的时候,便衣探员进了卧室隔壁的餐厅。他迅速打开窗,转身,想经过对开门进左侧的房间。这两扇门也锁着,门缝被贴上了胶带。他右转进入起居室,也打开了窗户',
- 'maxLength' => 5000,
+ 'description' => '要进行抽取的内容',
+ 'type' => 'array',
+ 'items' => ['description' => '要抽取的文章内容', 'type' => 'string', 'required' => false, 'example' => 'ps5是sony新一代的游戏机,他创新性的...'],
+ 'required' => false,
],
],
],
@@ -1744,110 +3201,37 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'end' => [
- 'title' => '输出是否完成,true 表示完成',
- 'description' => '输出是否完成,true 表示完成',
- 'type' => 'boolean',
- ],
+ 'end' => ['description' => '是否结束', 'type' => 'boolean', 'example' => '{\'TimeZone\': \'Asia/Shanghai\', \'DateTime\': \'2024-03-07T17:00:09+08:00\'}'],
'header' => [
- 'title' => '流式输出 header 头,包含返回通用信息',
- 'description' => '流式输出 header 头,包含返回通用信息',
+ 'description' => '返回结果的header',
'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' => '请求ID',
- 'type' => 'string',
- 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF',
- ],
- 'sessionId' => [
- 'title' => '一次会话ID',
- 'description' => '一次会话ID',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'taskId' => [
- 'title' => '一次生成任务ID',
- 'description' => '一次生成任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'traceId' => [
- 'title' => '链路traceid ',
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
+ 'event' => ['description' => 'event名称', 'type' => 'string', 'example' => 'result-generated'],
+ 'eventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '可空'],
+ 'requestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => 'F08C71C0-9399-548C-838B-1DA01DE211B0'],
+ 'sessionId' => ['description' => 'sessionId,可用于标记对话', 'type' => 'string', 'example' => '121dlsga4o7golrl1hojazg0u9lvytjc17ebgzzj2u4zukgh122tfg7wj1e6a1vcowy1ewzinauxriai9atcr6r323mm9ddbr0bg5m61ij8hxnf8664tstlfkfol6m8luc4shs3gums7l46uauyy0xndqmhdjtdon6coyhb4x17bo762bg9e3tb2geufg2'],
+ 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '12826092918145'],
+ 'traceId' => ['description' => '日志轨迹ID', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc'],
],
],
'payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
+ 'description' => '返回结果的payload,json结构,不同event结构不同',
'type' => 'object',
'properties' => [
'output' => [
- 'title' => '输出内容对象',
- 'description' => '输出内容对象',
+ 'description' => '页面展示信息',
'type' => 'object',
'properties' => [
- 'text' => [
- 'title' => '输出内容',
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '这是测试输出',
- ],
+ 'text' => ['description' => '抽取内容返回', 'type' => 'string', 'example' => 'playstation 5新一代的...'],
],
],
'usage' => [
- 'title' => '大模型token用量信息',
- 'description' => '大模型token用量信息',
+ 'description' => 'token描述',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'title' => '输入Token数量',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出Token数量',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'inputTokens' => ['description' => '输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['description' => '输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['description' => '总token数', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
@@ -1856,708 +3240,528 @@
],
],
],
- '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 \\"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' => '电商零售内容实体抽取',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationExtract',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '影视互娱剧本创作-剧本续写',
- 'description' => '根据用户输入剧本上文描述,即可快速生产下文,扩展编辑人员续写思路。',
],
- 'SubmitVideoAnalysisTask' => [
- 'summary' => '阿里云百炼轻应用-提交视频理解离线异步任务。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/submitVideoAnalysisTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunMarketingInformationWriting' => [
+ 'summary' => '电商零售推广文案写作。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runMarketingInformationWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'],
],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => '路径参数,[业务空间id](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d71e6e'],
],
[
- 'name' => 'videoUrl',
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频url',
- 'description' => '视频url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxx.mp4',
- ],
+ 'schema' => ['description' => '大模型ID。', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'."\n"
+ .'qwen-plus'],
],
[
- 'name' => 'videoModelId',
+ 'name' => 'writingType',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频vl任务模型唯一标识,支持的模型:'."\n"
- .'- quanmiao-vl-turbo'."\n"
- .'- quanmiao-vl-plus'."\n"
- .'- quanmiao-vl-max-thinking'."\n"
- .'- quanmiao-vl-max'."\n"
- .'- Qwen-VL-Post',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-vl-turbo',
- ],
+ 'schema' => ['description' => '写作类型:'."\n"
+ .'generateProductTitle - 生成商品标题'."\n"
+ .'productTitleTranslation - 商品标题翻译'."\n"
+ .'generateProductSummary - 生成商品摘要'."\n"
+ .'productRedBook-生成关于某产品的小红书笔记'."\n"
+ .'productEvaluating-商品使用测评文案'."\n"
+ .'circleOfFriends-适合发朋友圈的推广营销文案'."\n"
+ .'marketingActivities-营销活动的宣传文案'."\n"
+ .'productAdvertisement-某公司/产品的广告词'."\n"
+ .'travel-旅游类营销推广文章'."\n"
+ .'other-其他类型的营销文案', 'type' => 'string', 'required' => false, 'example' => 'productRedBook'],
],
[
- 'name' => 'videoModelCustomPromptTemplate',
+ 'name' => 'customPrompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频vl任务prompt模版:必须包含{videoAsrText}变量,{videoAsrText}是视频的ASR文本信息,默认取页面看到的默认值。',
- '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"
- .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。',
- ],
+ 'schema' => ['description' => '自定义写作要求', 'type' => 'string', 'required' => false, 'example' => '语言要精美。'],
],
[
- 'name' => 'modelId',
+ 'name' => 'sourceMaterial',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结(文本加工)依赖的大模型唯一标识,'."\n"
- ."\n"
- .'**如果文本加工阶段想跑多任务**,可以走textProcessTasks字段,如果传入了textProcessTasks,则当前字段和当前字段对应的prompt模版id,prompt模版将不再生效。'."\n"
- ."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-llm-max',
- ],
+ 'schema' => ['description' => '写作参考内容', 'type' => 'string', 'required' => false, 'example' => 'ps5是sony新一代的游戏机,他创新性的...'],
],
[
- 'name' => 'modelCustomPromptTemplateId',
+ 'name' => 'customLimitation',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
- ."\n"
- .'- PlotDetail:剧情详解(默认);'."\n"
- .'- Summary:内容概述;'."\n"
- .'- ExtractVideoTag:提取标签;'."\n"
- .'- ExplosivePointAnalysis:爆点分析;'."\n"
- .'- MultiTask:多类任务;'."\n"
- ."\n"
- .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
+ 'schema' => ['description' => '自定义写作限制', 'type' => 'string', 'required' => false, 'example' => '不要有错别字'],
],
[
- 'name' => 'modelCustomPromptTemplate',
+ 'name' => 'inputExample',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。',
- '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"
- .'直接输出视频剧情,不要输出其他信息。',
- ],
+ 'schema' => ['description' => '自定义写作输入素材样例', 'type' => 'string', 'required' => false, 'example' => '产品名字:xxx'."\n"
+ .'产品特点:xxx'],
],
[
- 'name' => 'generateOptions',
+ 'name' => 'outputExample',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '视频理解生成任务选项。',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频理解生成任务选项:包含的任务,会自动前置执行。'."\n"
- .'- videoAnalysis:视频语言分析(VL):如果仅传次值,则运行到视频语言分析后就结束了,不再跑后面的文本加工等子任务;'."\n"
- .'- **videoGenerate:文本加工-视频总结(默认)**,包含 videoAnalysis;'."\n"
- .'- videoTitleGenerate:视频标题生成,包含 videoAnalysis、videoGenerate;'."\n"
- .'- videoMindMappingGenerate:视频思维导图生成,包含 videoAnalysis、videoGenerate;videoRoleRecognition:角色自动识别。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoGenerate',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '自定义写作输出格式样例', 'type' => 'string', 'required' => false, 'example' => '写作输出内容样例'],
],
[
- 'name' => 'videoExtraInfo',
+ 'name' => 'language',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量',
- 'description' => '和视频相关的补充文字资料:您可以自定义扩展文本素材,应用到生成中,需要手动调整 prompt 模版,增加{videoExtraInfo}变量,传入的内容可以是视频摘要、视频简介或视频 ASR 转录信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '视频描述了:xx',
- ],
+ 'schema' => ['title' => '目标语言(用于商品标题翻译)', 'description' => '目标语言(用于商品标题翻译)', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
- 'name' => 'snapshotInterval',
+ 'name' => 'keywords',
'in' => 'formData',
- 'schema' => [
- 'title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。',
- 'description' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。'."\n"
- .'建议使用:当前字段优先级高于frameSampleMethod.interval,一般场景可以使用frameSampleMethod字段自定义(userdefined)模式下的interval,区别在于frameSampleMethod自定义模式interval取值需要在指定的视频时长对应抽帧间隔范围内。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '关键词(用于生成商品标题和商品摘要)', 'description' => '关键词(用于生成商品标题和商品摘要)', 'type' => 'string', 'required' => false, 'example' => '运动鞋 透气 减震 跑步'],
],
[
- 'name' => 'splitInterval',
+ 'name' => 'generateCount',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值',
- 'description' => '视频分镜最小间隔:单位秒,取值范围[1, 150],默认根据视频长度取推荐值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '生成数量(用于生成商品标题和商品摘要,取值范围:1-15)', 'description' => '生成数量(用于生成商品标题和商品摘要,取值范围:1-15)', 'type' => 'string', 'required' => false, 'example' => '5'],
],
[
- 'name' => 'language',
+ 'name' => 'wordCountRange',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)',
- 'description' => '语言,可传参数'."\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:越南语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chinese',
- ],
+ 'schema' => ['title' => '字数范围(用于商品标题翻译,格式:最小字数-最大字数)', 'description' => '字数范围(用于商品标题翻译,格式:最小字数-最大字数)', 'type' => 'string', 'required' => false, 'example' => '10-20'],
],
[
- 'name' => 'frameSampleMethod',
+ 'name' => 'otherRequirements',
+ 'in' => 'formData',
+ 'schema' => ['title' => '其他要求(用于三种新的写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)', 'description' => '其他要求(用于三种新的写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)', 'type' => 'string', 'required' => false, 'example' => '要求标题简洁有力,突出产品特点'],
+ ],
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义提示词(用于可控式生成模型,适用写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)', 'description' => '自定义提示词(用于可控式生成模型,适用写作类型:generateProductTitle、generateProductSummary、productTitleTranslation)', 'type' => 'string', 'required' => false, 'example' => '请根据关键词生成吸引人的商品标题'],
+ ],
+ [
+ 'name' => 'extParameters',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '抽帧方式',
+ 'title' => '扩展参数(Map结构,包含 minWordLength、maxWordLength、enableThinking、thinkingBudget 等参数,所有参数值均为 String 类型)',
+ 'description' => '扩展参数(Map结构,所有参数值均为 String 类型):'."\n"
+ .'- enableThinking:是否启用思考模式,取值为 "true" 或 "false"'."\n"
+ .'- thinkingBudget:思考预算,用于控制思考模式的预算(整数,字符串形式)'."\n"
+ .'- resultFormat:结果格式,用于设置输出格式'."\n"
+ .'- incrementalOutput:是否启用增量输出,取值为 "true" 或 "false"',
'type' => 'object',
- 'properties' => [
- 'methodName' => [
- 'description' => '抽帧类型,可传参数包括'."\n"
- .'- fast:快速/更低成本'."\n"
- .'- standard:标准(默认)'."\n"
- .'- userdefined:自定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
- 'interval' => [
- 'description' => '抽帧间隔:单位秒,仅在userdefined模式下有效',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '2',
- ],
- 'pixel' => [
- 'description' => '抽帧像素:每一帧最大边像素,仅在userdefined模式下有效,取值范围是300到768',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '768',
- ],
- ],
'required' => false,
- 'example' => 'english',
+ 'additionalProperties' => ['title' => '参数KEY', 'description' => '参数KEY', 'type' => 'string', 'example' => '大模型参数KEY'],
+ 'example' => '{'."\n"
+ .' "minWordLength": "10",'."\n"
+ .' "maxWordLength": "50",'."\n"
+ .' "enableThinking": "true",'."\n"
+ .' "thinkingBudget": "2000"'."\n"
+ .' }',
],
],
[
- 'name' => 'videoRoles',
+ 'name' => 'apiKey',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => '集成接入的API 密钥。获取[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'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '角色列表',
- 'description' => '识别视频中的人物身份列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '识别视频中的人物身份',
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'description' => '人物名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
- 'roleInfo' => [
- 'description' => '人物信息描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三是一个男生',
+ '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' => 'HTTP请求头。格式为key1:value1,通过回车键换行。',
+ 'type' => 'object',
+ 'properties' => [
+ 'event' => ['description' => 'event名称', 'type' => 'string', 'example' => 'result-generated'],
+ 'eventInfo' => ['description' => 'event描述', 'type' => 'string', 'example' => '可空'],
+ 'requestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => '436BC5AE-0573-59D8-9803-6B5FDCD3BBA1'],
+ 'sessionId' => ['description' => '对应的会话id'."\n", 'type' => 'string', 'example' => 'uqubxgqzlnf4exfektij032lgb3yvix678p232n56387aqxdo4uutdt9wstqzovvz6j3ho7wnbgye785u79yn5q3euqmsvzmqdn3nmfq2826oscjvsi43kof8b8uxufpp1x97jjukk6jd3183hy8ni6hqpskuhuascpd'],
+ 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '13312125943232'],
+ 'traceId' => ['description' => '跟踪ID', 'type' => 'string', 'example' => '213e20e517049392478441155e8b2a'],
+ 'errorMessage' => ['description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
],
- 'urls' => [
- 'description' => '人物头像地址',
- 'type' => 'array',
- 'items' => [
- 'description' => '人物头像地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
+ ],
+ 'payload' => [
+ 'description' => '返回结果的payload,json结构,不同event结构不同',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['description' => '写作内容返回', 'type' => 'string', 'example' => 'playstation5新时代的...'],
+ 'reasonContent' => ['title' => '模型推理内容', 'description' => '模型推理内容', 'type' => 'string', 'example' => '推理内容'],
+ ],
],
- 'required' => false,
- ],
- 'isAutoRecognition' => [
- 'description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'timeIntervals' => [
- 'description' => '角色出场时间段列表',
- 'type' => 'array',
- 'items' => [
+ 'usage' => [
+ 'description' => 'token描述',
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
- 'endTime' => [
- 'description' => '结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '345546789',
- ],
+ 'inputTokens' => ['description' => '输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['description' => '输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['description' => '总token数', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
- 'required' => false,
],
- 'required' => false,
],
],
- 'required' => false,
],
- 'required' => false,
],
],
- [
- 'name' => 'textProcessTasks',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '视频总结(文本加工)任务列表:最多支持3个',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频总结(文本加工)任务',
- 'type' => 'object',
- 'properties' => [
- 'modelId' => [
- 'description' => '视频总结依赖的大模型唯一标识,支持的模型'."\n"
- ."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-r1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max-latest',
- ],
- 'modelCustomPromptTemplate' => [
- 'description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'modelCustomPromptTemplateId' => [
- 'description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
- ."\n"
- .'- PlotDetail:剧情详解(默认);'."\n"
- .'- Summary:内容概述;'."\n"
- .'- ExtractVideoTag:提取标签;'."\n"
- .'- ExplosivePointAnalysis:爆点分析;'."\n"
- .'- MultiTask:多类任务;'."\n"
- ."\n"
- .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
- ],
- 'required' => false,
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '电商零售推广文案写作',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-30T06:32:54.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-17T11:50:20.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-11-06T11:56:39.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ ],
+ 'RunNetworkContentAudit' => [
+ 'summary' => '轻应用-网络内容审核。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runNetworkContentAudit',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
[
- 'name' => 'faceIdentitySimilarityMinScore',
+ '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '人物识别相似度阈值:0~1',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.7',
- ],
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
],
[
- 'name' => 'videoShotFaceIdentityCount',
+ 'name' => 'businessType',
'in' => 'formData',
- 'schema' => [
- 'description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量:[1~5]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '业务类型', 'description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'clueMining'],
],
[
- 'name' => 'deduplicationId',
+ 'name' => 'taskDescription',
'in' => 'formData',
- 'schema' => [
- 'title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'description' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。'],
],
[
- 'name' => 'excludeGenerateOptions',
+ 'name' => 'content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待分析文本', 'description' => '待分析文本', 'type' => 'string', 'required' => true, 'example' => '待分析文本'],
+ ],
+ [
+ 'name' => 'tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
- 'description' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
+ 'title' => '标签体系列表',
+ 'description' => '标签体系列表',
'type' => 'array',
'items' => [
- 'description' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
- 'type' => 'string',
+ 'description' => '标签列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'tagDefinePrompt' => ['title' => '标签定义提示词', 'description' => '标签定义提示词', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
'required' => false,
- 'example' => '[\\"videoCaption\\"]',
],
'required' => false,
],
],
[
- 'name' => 'videoCaptionInfo',
+ 'name' => 'extraInfo',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '额外信息', 'description' => '额外信息', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['title' => '输出格式', 'description' => '输出格式', 'type' => 'string', 'required' => false, 'example' => '请返回如下JSON格式,{"key1":"","key2":""}'],
+ ],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集成接入的API 密钥。获取[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'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '字幕(asr)信息',
- 'description' => '字幕(asr)信息',
+ 'title' => '响应',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'videoCaptions' => [
- 'title' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
- 'description' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
- 'type' => 'array',
- 'items' => [
- 'title' => '字幕(asr)内容',
- 'description' => '字幕(asr)内容',
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '当前句子开始时间:毫秒',
- 'description' => '当前句子开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
- 'endTime' => [
- 'title' => '当前句子结束时间:毫秒',
- 'description' => '当前句子结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10000',
- ],
- 'text' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你好',
+ 'header' => [
+ 'title' => '消息头',
+ 'description' => '消息头',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
+ ],
+ ],
+ 'payload' => [
+ 'title' => '消息体',
+ 'description' => '消息体',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '输出结果',
+ 'description' => '输出结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出摘要文本', 'description' => '输出摘要文本', 'type' => 'string', 'example' => 'xxxx'],
],
- 'speaker' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
+ ],
+ 'usage' => [
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
- 'required' => false,
],
- 'required' => false,
- ],
- 'videoCaptionFileUrl' => [
- 'title' => '视频字幕(ASR)文件',
- 'description' => '视频字幕(ASR)文件',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss:// | http://',
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5'],
+ ],
+ ],
+ ],
+ ],
+ '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' => '网络内容安全审核',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunNetworkContentAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ ],
+ 'RunOcrParse' => [
+ 'summary' => '作文图片OCR解析',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runOcrParse',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
+ [
+ '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' => 'autoRoleRecognitionVideoUrl',
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'url',
'in' => 'formData',
- 'schema' => [
- 'title' => '自动识别专属url',
- 'description' => '自动识别功能单独的视频地址Url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://',
- ],
+ 'schema' => ['title' => '图片URL(url与fileKey二选一)', 'description' => '图片URL(url与fileKey二选一)', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt'],
],
[
- 'name' => 'splitType',
+ 'name' => 'fileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'description' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fixDuration',
- ],
+ 'schema' => ['description' => '图片URL(url与fileKey二选一)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt'],
],
[
- 'name' => 'addDocumentParam',
+ 'name' => 'modelId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-vl-ocr-latest'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '结果自动保存(自动上传妙搜数据集)',
- 'description' => '指定数据集后:视频理解结果作为meta信息和视频一起上传到妙搜',
+ 'title' => '响应',
+ 'description' => '响应',
'type' => 'object',
'properties' => [
- 'datasetId' => [
- 'title' => '数据集id',
- 'description' => '数据集id:如果期望上传到妙搜,这个字段必选',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3031',
- ],
- 'datasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'header' => [
+ 'title' => '消息头',
+ 'description' => '消息头',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
+ ],
],
- 'document' => [
- 'title' => '自动保存视频参数',
- 'description' => '上传妙搜相关参数:不录入会自动生成',
+ 'payload' => [
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '视频名称',
- 'description' => '视频名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'description' => '文档业务唯一标识:同数据集会排重',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'categoryUuid' => [
- 'title' => '类目唯一标识',
- 'description' => '文档类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'tags' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'title' => 'value',
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
+ 'output' => [
+ 'title' => '输出结果',
+ 'description' => '输出结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出摘要文本', 'description' => 'OCR文本输出', 'type' => 'string', 'example' => 'OCR文本输出'."\n"
+ ."\n"],
],
- 'required' => false,
- ],
- 'extend1' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'extend2' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
],
- 'extend3' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'metadata' => [
- 'title' => '字典信息',
- 'description' => '元数据',
+ 'usage' => [
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'keyValues' => [
- 'title' => 'key-value格式字典',
- 'description' => 'keyValue结构的元数据',
- 'type' => 'array',
- 'items' => [
- 'title' => 'key-value格式字典',
- 'description' => 'keyValue 结构的元数据',
- 'type' => 'object',
- 'properties' => [
- 'key' => [
- 'title' => '名称',
- 'description' => '字段名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'summary',
- ],
- 'value' => [
- 'title' => '取值',
- 'description' => '字段值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
- 'required' => false,
],
],
- 'required' => false,
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
- 'required' => false,
],
],
- [
- 'name' => 'videoUrls',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '多视频url',
- 'description' => '多视频url',
- 'type' => 'array',
- 'items' => [
- 'description' => '多视频url:会合并成一个视频处理,适合短视频场景',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '图片OCR解析',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunOcrParse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ ],
+ 'RunScriptChat' => [
+ 'summary' => '长剧本创作。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptChat',
+ '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', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'workspaceId',
+ 'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-rz8db8d00rcn2p0xc'],
+ ],
+ [
+ 'name' => 'prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '用户输入的剧本指令', 'description' => '用户输入的剧本指令', 'type' => 'string', 'required' => true, 'example' => '创建角色:林晓晓', 'maxLength' => 9000],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务ID,相同的任务ID,表示一组任务对话', 'description' => '任务唯一标识'."\n"
+ ."\n"
+ .'> '."\n"
+ .'>- taskId默认无需填写,系统将自动生成。当后续任务填写的taskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>- 建议手动赋值taskId,以便关联上下文。', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'maxLength' => 1000],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -2565,42 +3769,42 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'end' => ['description' => '输出是否完成,true 表示完成', 'type' => 'boolean', 'example' => 'true'],
+ 'header' => [
+ 'description' => '流式输出 header头,包含返回通用信息',
+ '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' => '请求ID', 'type' => 'string', 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3'],
+ 'sessionId' => ['title' => '一次会话ID', 'description' => '一次会话ID', 'type' => 'string', 'example' => '147648697127_914847410985_1730600302167'],
+ 'taskId' => ['title' => '一次生成任务ID', 'description' => '一次生成任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['title' => '链路traceid ', 'description' => '链路traceid ', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc'],
+ ],
],
- 'data' => [
- 'description' => '结果',
+ 'payload' => [
+ 'description' => '返回结果的 payload,json 结构',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
+ 'output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '以下是角色信息'],
+ ],
+ ],
+ 'usage' => [
+ 'title' => '大模型token用量信息',
+ 'description' => '大模型Token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入Token数量', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出Token数量', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总oken数量', 'description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
],
],
],
@@ -2610,80 +3814,64 @@
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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' => '影视互娱剧本创作-交互式创作',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-18T12:33:20.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '视频理解-提交异步任务',
- 'description' => '- 阿里云百炼轻应用-视频理解-提交离线异步任务:区别于在线同步接口,可以提交视频理解异步任务,无需等待执行结束,后台异步调度(排队、并行),结果可以通过“获取异步任务状态和结果”接口查询。'."\n"
- ."\n"
- .'- **并发说明**:默认支持2并发(异步任务运行并发,非次接口调用并发),可以通过配置接口(UpdateVideoAnalysisConfig)调整并发到30(如果业务量大,可以联系客服或运营等申请更多并发),并发数等于后台同时运行的任务数,超过并发数的任务会后台排队。'."\n"
- ."\n"
- .'- **接口调用说明**,支持绝大部分开发语言SDK方式接入,openapi门户可以直接调试和使用,也可以到[**轻应用-影视传媒视频理解**](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)控制台,切换到“API”页签下查看调用demo。'."\n"
- ."\n"
- .'- **角色识别说明**:通过API接口的方式实现“识别视频中的人物身份”,默认可支持识别16个人物,每个角色1张图片。如需进一步放宽此限制,请加入钉钉群:116015001424,联系产研。但一个视频理解任务中做太多次人物角色匹配 ,存在超时风险。'."\n"
- ."\n"
- .'- **调度轮询最佳实践**:因接口调用并发有限制,建议如下'."\n"
- .' - **扩并发**:扩的是异步处理任务的并发,非提交任务接口的并发'."\n"
- .' - **提交任务接口**:理论串行都可以。如果任务多,可以适当2、3个并发提交任务。'."\n"
- .' - **结果轮询**:任务会按照提交顺序调度。理论只需要周期轮询最早未完成的top n(n==异步任务并发数)的任务就行。更多的任务状态只会是排队中。轮序意义不大。',
],
- 'GetVideoAnalysisTask' => [
- 'summary' => '轻应用-获取视频理解异步任务结果。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunScriptContinue' => [
+ 'summary' => '影视互娱乐剧本创作-剧本续写。',
+ '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' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-e9zzbkg0aj2mlXX'],
],
[
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ '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],
+ ],
+ [
+ 'name' => 'userProvidedContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '上文补充描述:用户针对某一段小说内容续写,需要用户提供上文补充', 'description' => '上文补充描述:用户针对某一段小说内容续写,需要用户提供上文补充', 'type' => 'string', 'required' => true, 'example' => '门厅一片狼藉。朝向天井的窗户开着。公寓门突然被撞开了。\\n一名便衣探员、两名穿制服的警察和几位消防员———也身着工作服———进来,四下张望。他们都戴着手套以及盖住口鼻的面罩。在他们身后,门房和他妻子也挤进门厅。他们都捂着鼻子。门房的另一只手里拿着一叠信件和促销广告单。他们身后,跟着一位女邻居。\\n便衣探员(对门房和邻居):请在外面等候。\\n他向一名警察示意,警察正忙着把好奇的旁观者请出门外。\\n警察(对门房,指着那一叠信件):最近的一封是哪天的?\\n门房(查对信件):最近的一封似乎是16号的......等一下......\\n便衣探员想打开左侧的门,却是徒劳。门用胶带封上了。\\n便衣探员(对消防员):你来试一下好吗?\\n消防员摆弄门的时候,便衣探员进了卧室隔壁的餐厅。他迅速打开窗,转身,想经过对开门进左侧的房间。这两扇门也锁着,门缝被贴上了胶带。他右转进入起居室,也打开了窗户', 'maxLength' => 5000],
],
],
'responses' => [
@@ -2693,722 +3881,45 @@
'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' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'end' => ['title' => '输出是否完成,true 表示完成', 'description' => '输出是否完成,true 表示完成', 'type' => 'boolean'],
+ 'header' => [
+ 'title' => '流式输出 header 头,包含返回通用信息',
+ 'description' => '流式输出 header 头,包含返回通用信息',
+ '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' => '请求ID', 'type' => 'string', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF'],
+ 'sessionId' => ['title' => '一次会话ID', 'description' => '一次会话ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'taskId' => ['title' => '一次生成任务ID', 'description' => '一次生成任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['title' => '链路traceid ', 'description' => '链路traceid ', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
+ ],
],
- 'data' => [
- 'description' => '结果',
+ 'payload' => [
+ 'title' => '返回结果的 payload,json 结构',
+ 'description' => '返回结果的 payload,json 结构',
'type' => 'object',
'properties' => [
- 'header' => [
- 'description' => 'event名称',
- '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' => '全量路ID',
- 'type' => 'string',
- 'example' => '215045f817272303448235204efdef',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '结果',
+ 'output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '结果',
- 'type' => 'object',
- 'properties' => [
- 'videoAnalysisResult' => [
- 'description' => '语言分析对应生成内容',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => 'vl生成文本结果',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'usage' => [
- 'description' => 'Token数量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'imageTokens' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'videoShotAnalysisResults' => [
- 'description' => '视频每个分镜对应语言分析结果::因内容较大,请从resultJsonFileUrl文件中获取',
- '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' => 'xxxx',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoCaptionResult' => [
- 'description' => '视频字幕',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'videoCaptions' => [
- 'description' => '视频字幕',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频字幕',
- 'type' => 'object',
- 'properties' => [
- 'endTime' => [
- 'description' => '结束时间,相对时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20000',
- ],
- 'endTimeFormat' => [
- 'description' => '结束时间,格式化结果',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'startTime' => [
- 'description' => '开始时间,相对时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'startTimeFormat' => [
- 'description' => '开始时间,格式化结果',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'text' => [
- 'description' => '字幕内容',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoGenerateResult' => [
- 'description' => '文本总结结果:多任务时,请从videoGenerateResults字段获取结果',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '生成文本',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'usage' => [
- 'description' => '输出Token数量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- 'modelId' => [
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'qwen-max-latest',
- ],
- 'modelReduce' => [
- 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性',
- 'type' => 'boolean',
- 'example' => 'qwen-plus-latest',
- ],
- 'reasonText' => [
- 'description' => '模型思考过程',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'index' => [
- 'description' => '多任务标号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'videoMindMappingGenerateResult' => [
- 'description' => '脑图生成结束',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '生成文本',
- 'type' => 'string',
- 'example' => '小吃街',
- ],
- 'usage' => [
- 'description' => '输入Token数量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- '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' => '三级节点',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoTitleGenerateResult' => [
- 'description' => '标题生成结果',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'usage' => [
- 'description' => 'Token数量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- 'resultJsonFileUrl' => [
- 'title' => '全量结果文件地址:'."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
- .'当前包含的字段:'."\n"
- .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
- .'其他字段获取方式不变,文本方式返回。'."\n"
- .'文件类型:json'."\n"
- .'文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'description' => '结果json文件地址:'."\n"
- ."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用:'."\n"
- ."\n"
- .'- 当前包含的字段:数据结构定义见RunVideoAnalysis接口'."\n"
- .' - videoShotSnapshotResult:每个分片抽帧信息,包括每帧url'."\n"
- .' - videoShotAnalysisResults:每个分片语言分析结果明细'."\n"
- .'- 其他字段获取方式不变,文本方式返回。'."\n"
- .'- 文件类型:json'."\n"
- .'- 文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'videoGenerateResults' => [
- 'description' => '当入参为多任务时(textProcessTasks有值),返回文本加工结果对应这个字段,可以通过数据所在数组位置(下标)或index(1开始)找到对应结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '文本加工任务结果',
- 'type' => 'object',
- 'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'modelId' => [
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'index' => [
- 'description' => '多任务标号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'text' => [
- 'description' => '生成内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'reasonText' => [
- 'description' => '模型思考过程',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'usage' => [
- 'description' => '用量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoRoleRecognitionResult' => [
- 'description' => '自动识别结果',
- 'type' => 'object',
- 'properties' => [
- 'videoRoles' => [
- 'description' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'description' => '角色名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'roleInfo' => [
- 'description' => '人物信息',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'timeIntervals' => [
- 'description' => '角色出场时间段列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'endTime' => [
- 'description' => '结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '342463553646',
- ],
- 'timestamp' => [
- 'description' => '当前时间段角色出场时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42553453253',
- ],
- 'url' => [
- 'description' => '角色图片',
- 'type' => 'string',
- 'example' => 'http://',
- ],
- ],
- ],
- ],
- 'ratio' => [
- 'description' => '出场率',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.2',
- ],
- 'isAutoRecognition' => [
- 'description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)',
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- ],
- 'videoCalculatorResult' => [
- 'title' => '费用估算结果',
- 'description' => '费用估算结果',
- 'type' => 'object',
- 'properties' => [
- 'items' => [
- 'title' => '计费项明细',
- 'description' => '计费项明细',
- 'type' => 'array',
- 'items' => [
- 'title' => '计费项明细',
- 'description' => '计费项明细',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '计费项名称',
- 'description' => '计费项名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'type' => [
- 'title' => '名称',
- 'description' => '名称',
- 'type' => 'string',
- ],
- 'inputToken' => [
- 'title' => '类型',
- 'description' => '类型',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'outputToken' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'time' => [
- 'title' => '计费时长',
- 'description' => '计费时长',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'inputExpense' => [
- 'title' => '输入token计费',
- 'description' => '输入token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'outputExpense' => [
- 'title' => '输入token计费',
- 'description' => '输入token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'timeExpense' => [
- 'title' => '输出token计费',
- 'description' => '输出token计费',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'totalExpense' => [
- 'title' => '费用',
- 'description' => '费用',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.098',
- ],
- ],
- ],
- ],
- ],
- ],
- 'addDatasetDocumentsResult' => [
- 'title' => '自动保存执行结果',
- 'description' => '自动保存执行结果',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'title' => '自动保存任务状态:1 成功,0 失败',
- 'description' => '自动保存任务状态:1 成功,0 失败',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'title' => [
- 'title' => '视频名称',
- 'description' => '视频名称',
- 'type' => 'string',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'description' => '视频docId',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '如果自动保存失败,则输出错误信息',
- 'description' => '如果自动保存失败,则输出错误信息',
- 'type' => 'string',
- ],
- 'docUuid' => [
- 'title' => '视频的docUuid',
- 'description' => '视频的docUuid',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'usage' => [
- 'description' => 'token描述',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
+ 'text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '这是测试输出'],
],
],
- 'taskRunInfo' => [
- 'title' => '运行信息',
- 'description' => '运行信息',
+ 'usage' => [
+ 'title' => '大模型token用量信息',
+ 'description' => '大模型token用量信息',
'type' => 'object',
'properties' => [
- 'concurrentChargeEnable' => [
- 'title' => '是否使用付给并发:true时,按照实际运行时长计量',
- 'description' => '是否使用付费并发:true时,按照实际运行时长计量',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'responseTime' => [
- 'title' => '运行时长:rt',
- 'description' => '运行时长:从任务被调度开始到任务完成的耗时,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'inputTokens' => ['title' => '输入Token数量', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出Token数量', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总oken数量', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
- 'taskStatus' => [
- 'description' => '任务状态。'."\n"
- .'- PENDING:待执行'."\n"
- .'- RUNNING:执行中'."\n"
- .'- SUCCESSED:成功'."\n"
- .'- SUSPENDED:暂停'."\n"
- .'- FAILED:失败'."\n"
- .'- CANCELED: 取消',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'taskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'errorMessage' => [
- 'description' => '异常错误信息',
- 'type' => 'string',
- 'example' => 'Access was denied, message: No such namespace namespaces/mjp-test-default.',
- ],
],
],
],
@@ -3417,142 +3928,132 @@
],
'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' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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"}]',
+ 'title' => '影视互娱剧本创作-剧本续写',
+ 'description' => '根据用户输入剧本上文描述,即可快速生产下文,扩展编辑人员续写思路。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptContinue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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"}]',
- 'title' => '视频理解-获取异步任务状态和结果',
- 'description' => '阿里云百炼轻应用-视频理解-获取异步任务状态和结果:通过这个接口可以查看“提交异步任务”接口提交的视频理解任务状态和结果。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。'."\n"
- .'> 当返回结果中包含`header -> errorCode = ViolationOfSecurityPolicy`时,表明该请求触发了系统的安全策略限制,请对请求内容进行相应的修改。此时,`videoAnalysisResult`等业务数据返回为空。'."\n"
- .'>',
],
- 'UpdateVideoAnalysisTask' => [
- 'summary' => '视频理解-修改任务状态:目前仅支持取消任务。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTask',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunScriptPlanning' => [
+ 'summary' => '影视互娱乐剧本创作-剧本策划。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptPlanning',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-e9zzbkg0aj2mlXX'],
],
[
- 'name' => 'taskId',
+ 'name' => 'scriptName',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '自然语言输入剧本名称'."\n", 'description' => '自然语言输入剧本名称'."\n", 'type' => 'string', 'required' => false, 'example' => '都市战神', 'maxLength' => 5000],
],
[
- 'name' => 'taskStatus',
+ 'name' => 'scriptTypeKeyword',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
- ],
+ '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' => '剧本的分镜数量:单个剧本内用户可以定义生成对应的镜头描述数量,取值范围为1~10个', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'example' => '3', 'default' => '3'],
+ ],
+ [
+ 'name' => 'dialogueInScene',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否需要具体分镜对白,default=false', 'description' => '是否需要具体分镜对白,default=false', '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],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应',
+ 'description' => 'Schema of Response',
'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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'end' => ['title' => '输出是否完成,true 表示完成', 'description' => '输出是否完成,true 表示完成', 'type' => 'boolean'],
+ 'header' => [
+ 'title' => '流式输出 header 头,包含返回通用信息',
+ 'description' => '流式输出 header 头,包含返回通用信息',
+ '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' => '请求ID', 'type' => 'string', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF'],
+ 'sessionId' => ['title' => '一次会话ID', 'description' => '一次会话ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'taskId' => ['title' => '一次生成任务ID', 'description' => '一次生成任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['title' => '链路traceid ', 'description' => '链路traceid ', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
+ ],
],
- 'data' => [
- 'title' => '任务信息',
- 'description' => '任务信息',
+ 'payload' => [
+ 'title' => '返回结果的 payload,json 结构',
+ 'description' => '返回结果的 payload,json 结构',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'taskStatus' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'CANCELED',
+ 'output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '这是测试输出'],
+ ],
],
- 'taskErrorMessage' => [
- 'title' => '任务失败信息',
- 'description' => '任务失败信息',
- 'type' => 'string',
- 'example' => '主动取消',
+ 'usage' => [
+ 'title' => '大模型token用量信息',
+ 'description' => '大模型token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入Token数量', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出Token数量', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总oken数量', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
],
],
],
@@ -3560,82 +4061,61 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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"}]',
- 'title' => '视频理解-修改异步任务状态',
- ],
- 'UpdateVideoAnalysisTasks' => [
- 'summary' => '视频理解-批量取消任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTasks',
- 'methods' => [
- 'put',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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"}]',
+ 'title' => '影视互娱剧本创作-剧本策划',
+ 'description' => '根据用户对剧本前要的简单输入,就可得到剧本梗概及分镜头的简要描述,帮助编辑人员快速构思剧本框架',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptPlanning',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunScriptRefine' => [
+ 'summary' => '剧本对话内容的整理。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runScriptRefine',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '任务id列表',
- 'description' => '任务id列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-zna577pdximvztk5'],
],
[
- 'name' => 'taskStatus',
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
- ],
+ 'schema' => ['title' => '任务ID,相同的任务ID,表示一组任务对话', 'description' => '任务唯一标识'."\n"
+ ."\n"
+ .'> '."\n"
+ .'>- taskId默认无需填写,系统将自动生成。当后续任务填写的taskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>- 建议手动赋值taskId,以便关联上下文。', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2', 'maxLength' => 1000],
],
],
'responses' => [
@@ -3645,65 +4125,54 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8',
- ],
- 'code' => [
- 'description' => '响应Code码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'httpStatusCode' => [
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'end' => ['description' => '输出是否完成,true 表示完成', 'type' => 'boolean'],
+ 'header' => [
+ 'description' => '流式输出 header头,包含返回通用信息',
+ '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' => '请求ID', 'type' => 'string', 'example' => 'F8A35034-EDCF-5C50-95A5-1044316F36E3'],
+ 'sessionId' => ['title' => '一次会话ID', 'description' => '一次会话ID', 'type' => 'string', 'example' => '17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824'],
+ 'taskId' => ['title' => '一次生成任务ID', 'description' => '一次生成任务ID', 'type' => 'string', 'example' => '14356391-6c6c-40d5-b80a-8ecd03b69d72'],
+ 'traceId' => ['title' => '链路traceid ', 'description' => '链路traceid ', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc'],
+ ],
],
- 'data' => [
- 'title' => '删除结果',
- 'description' => '删除结果',
- 'type' => 'array',
- 'items' => [
- 'title' => '删除结果',
- 'description' => '删除结果',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'taskStatus' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'CANCELED',
- ],
- 'taskErrorMessage' => [
- 'title' => '任务失败信息',
- 'description' => '任务失败信息',
- 'type' => 'string',
- 'example' => 'xx',
+ 'payload' => [
+ 'description' => '返回结果的payload,json结构,不同event结构不同',
+ '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', 'description' => '正文,剧幕内容', 'example' => '{"第一幕":" 幕次: 第一幕\\n\\n 场面描述"}'],
+ ],
+ ],
],
- 'taskErrorCode' => [
- 'title' => '任务失败code',
- 'description' => '任务失败code',
- 'type' => 'string',
- 'example' => 'xx',
+ ],
+ 'usage' => [
+ 'title' => '大模型token用量信息',
+ 'description' => '大模型Token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入Token数量', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出Token数量', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总oken数量', 'description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
@@ -3712,64 +4181,105 @@
],
],
],
- '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' => '视频理解-批量取消任务',
- ],
- 'UpdateVideoAnalysisConfig' => [
- 'summary' => '视频理解-更新配置。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisConfig',
- 'methods' => [
- 'put',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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"}]',
+ 'title' => '影视互娱剧本创作-剧本整理',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'RunStyleWriting' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runStyleWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9xb8mx'],
+ ],
+ [
+ 'name' => 'learningSamples',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ 'title' => '需要作为学习样本的文章集合',
+ 'description' => '需要作为学习样本的文章集合',
+ 'type' => 'array',
+ 'items' => ['description' => '需要作为学习样本的文章', 'type' => 'string', 'required' => false, 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'],
+ 'required' => false,
+ 'example' => '["在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
+ .'"]',
+ 'maxItems' => 10,
+ 'minItems' => 1,
],
],
[
- 'name' => 'asyncConcurrency',
+ 'name' => 'writingTheme',
'in' => 'formData',
+ 'schema' => ['title' => '用户输入的写作主题,可以对主题进行自定义调整效果', 'description' => '用户输入的写作主题,可以对主题进行自定义调整效果', 'type' => 'string', 'required' => false, 'example' => '帮我写一篇关于妙笔产品等文案', 'maxLength' => 2000],
+ ],
+ [
+ 'name' => 'styleFeature',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文体特征标识符。如果指定了此参数,接口会按照指定的文体特征进行写作', 'description' => '文体特征标识符。如果指定了此参数,接口会按照指定的文体特征进行写作', 'type' => 'string', 'required' => false, 'example' => '文章特点1:标题采用话题标签形式,增强社交媒体传播性。\\n文章特点2:开篇通过引言简述背景,快速关联当下热点话题。\\n文章特点3:使用记者调查作为支撑,列举具体行业实例,增强论述的现实基础。\\n文章特点4:引入法律观点平衡论述,提供政策依据,并倡导正面价值观。\\n\\n示例文章特点总结:该文以社会热点为导向,运用具有传播力的标题设计,通过现象观察引入话题,结合实地调查数据展现广泛的社会现象,同时援引法律规定进行评析,确保论述客观性,并在结尾处倡导积极健康的职场文化,整体结构紧凑,信息丰富且具有引导性。', 'maxLength' => 2000],
+ ],
+ [
+ 'name' => 'referenceMaterials',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '视频理解-离线任务并发数,取值范围[2, 10]',
- 'description' => '视频理解-离线任务并发数,取值范围[2, 30]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
+ 'title' => '大模型生成功能的内容素材模型集合',
+ 'description' => '大模型生成功能的内容素材模型集合',
+ 'type' => 'array',
+ 'items' => ['description' => '大模型生成功能的内容素材', 'type' => 'string', 'required' => false, 'example' => '在这个快节奏的时代,文字似乎成了慢生活的奢侈品。但你是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'],
+ 'required' => false,
+ 'example' => '是否还记得,那些温柔的字句是如何悄悄潜入心田,激荡起久违的涟漪?今天,就让我们一同走进【妙笔写作】的世界,探索那些让文字跃然纸上的秘密,让灵感在指尖轻轻舞动,绽放独一无二的光彩。'."\n"
+ .'"]',
],
],
+ [
+ 'name' => 'processStage',
+ 'in' => 'formData',
+ 'schema' => ['title' => ' * 代表处理阶段'."\n"
+ .' * "full": 生成特点分析和创作内容'."\n"
+ .' * "analysisStage": 仅生成特点分析'."\n"
+ .' * "creationStage": 仅生成创作内容', 'description' => ' * 代表处理阶段'."\n"
+ .' * "full": 生成特点分析和创作内容'."\n"
+ .' * "analysisStage": 仅生成特点分析'."\n"
+ .' * "creationStage": 仅生成创作内容', 'type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'useSearch',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否自动检索互联网补充素材', 'description' => '是否自动检索互联网补充素材', 'type' => 'boolean', 'required' => false],
+ ],
],
'responses' => [
200 => [
@@ -3778,303 +4288,358 @@
'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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'end' => ['description' => '输出是否完成,true表示完成', 'type' => 'boolean', 'example' => 'true'],
+ 'header' => [
+ 'description' => '流式输出 header头,包含返回通用信息',
+ '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' => '请求ID', 'type' => 'string', 'example' => '0EB27AE3-CA53-5FAE-83C6-EE66CA4DF5DF'],
+ 'sessionId' => ['title' => '一次会话ID', 'description' => '一次会话ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'taskId' => ['title' => '一次生成任务ID', 'description' => '一次生成任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'traceId' => ['title' => '链路traceid ', 'description' => '链路traceid ', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
+ ],
+ 'example' => '{"event":"task-progress-start-generating","sessionId":"3cd10828-0e42-471c-8f1a-931cde20b035","taskId":"d3be9981-ca2d-4e17-bf31-1c0a628e9f99","traceId":"66bef4a7f5d61ff3c43f3b710574e175"}',
],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'payload' => [
+ 'description' => '返回结果的payload,json结构,不同event结构不同',
+ 'type' => 'object',
+ 'properties' => [
+ 'output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '这是测试输出'],
+ ],
+ 'example' => '{'."\n"
+ .' "text": "这是测试输出"'."\n"
+ .' }',
+ ],
+ 'usage' => [
+ 'title' => '大模型token用量信息',
+ 'description' => '大模型token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入Token数量', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出Token数量', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总oken数量', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
+ 'example' => '{'."\n"
+ .' "inputTokens": 1816,'."\n"
+ .' "outputTokens": 96,'."\n"
+ .' "totalTokens": 1912'."\n"
+ .' }',
+ ],
+ ],
+ 'example' => '{'."\n"
+ .' "output": {'."\n"
+ .' "text": "这是测试输出"'."\n"
+ .' },'."\n"
+ .' "usage": {'."\n"
+ .' "inputTokens": 1816,'."\n"
+ .' "outputTokens": 96,'."\n"
+ .' "totalTokens": 1912'."\n"
+ .' }'."\n"
+ .'}',
],
],
],
],
],
- '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"}]',
- 'title' => '视频理解-更新配置',
- 'description' => '阿里云百炼轻应用-视频理解-更新配置:通过这个接口可以修改异步任务并发配置。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。通过SDK方式调用API可参考控制台“API”下的示例。',
- ],
- 'GetVideoAnalysisConfig' => [
- 'summary' => '视频理解:获取基础配置。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisConfig',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '传媒/零售文章风格与格式学习',
+ 'summary' => '传媒/零售文章风格与格式学习。',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-23T11:06:56.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:00:57.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunStyleWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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' => '轻应用-标签挖掘。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runTagMiningAnalysis',
+ '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' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'w-08a4a3ba7104917c'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
+ ],
+ [
+ 'name' => 'businessType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务类型', 'description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'clueMining'],
+ ],
+ [
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。'],
+ ],
+ [
+ 'name' => 'content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待分析文本', 'description' => '待分析文本', 'type' => 'string', 'required' => true, 'example' => '待分析文本'],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
+ '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' => false,
],
],
+ [
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '额外信息', 'description' => '额外信息', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['title' => '输出格式', 'description' => '输出格式', 'type' => 'string', 'required' => false, 'example' => '请返回如下JSON格式,{"key1":"","key2":""}'],
+ ],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集成接入的API 密钥。获取[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'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '响应',
+ 'description' => '响应',
'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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'header' => [
+ 'title' => '消息头',
+ 'description' => '消息头',
+ 'type' => 'object',
+ 'properties' => [
+ 'errorCode' => ['title' => '错误码code', 'description' => '错误码code', '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'],
+ ],
],
- 'data' => [
- 'title' => '异步任务并发数',
- 'description' => '异步任务并发数',
+ 'payload' => [
+ 'title' => '消息体',
+ 'description' => '消息体',
'type' => 'object',
'properties' => [
- 'asyncConcurrency' => [
- 'title' => '异步任务并发数',
- 'description' => '异步任务并发数:取值范围[2~10]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'output' => [
+ 'title' => '输出结果',
+ 'description' => '输出结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '输出摘要文本', 'description' => '输出摘要文本', 'type' => 'string', 'example' => '大模型输出文本'],
+ ],
+ ],
+ 'usage' => [
+ 'title' => 'token消耗',
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'outputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'totalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
],
],
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '标签挖掘分析',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-10T11:40:54.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunTagMiningAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '视频理解-获取配置',
- 'description' => '阿里云百炼轻应用-视频理解-获取配置:通过这个接口可以查看异步任务并发配置。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。通过SDK方式调用API可参考控制台“API”下的示例。',
],
'RunVideoAnalysis' => [
'summary' => '阿里云百炼轻应用-影视传媒视频理解。',
'path' => '/{workspaceId}/quanmiao/lightapp/runVideoAnalysis',
- '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' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
'name' => 'videoUrl',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频链接'."\n"
- ."\n\n"
- .'> '."\n"
- .'> - videoUrl字段必填(如果填写了originalSessionId字段,videoUrl可不填)。'."\n"
- .'> - 不支持上传本地视频,您需填入可下载的URL地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxx.mp4',
- ],
+ 'schema' => ['description' => '视频链接'."\n"
+ ."\n\n"
+ .'> '."\n"
+ .'> - videoUrl字段必填(如果填写了originalSessionId字段,videoUrl可不填)。'."\n"
+ .'> - 不支持上传本地视频,您需填入可下载的URL地址。', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx.mp4'],
],
[
'name' => 'videoModelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频VL任务模型唯一标识,支持的模型:'."\n"
- .'- quanmiao-vl-turbo'."\n"
- .'- quanmiao-vl-plus'."\n"
- .'- quanmiao-vl-max-thinking'."\n"
- .'- quanmiao-vl-max'."\n"
- .'- Qwen-VL-Post',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-vl-turbo',
- ],
+ 'schema' => ['description' => '视频VL任务模型唯一标识,支持的模型:'."\n"
+ .'- quanmiao-vl-turbo'."\n"
+ .'- quanmiao-vl-plus'."\n"
+ .'- quanmiao-vl-max-thinking'."\n"
+ .'- quanmiao-vl-max'."\n"
+ .'- Qwen-VL-Post', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-vl-turbo'],
],
[
'name' => 'videoModelCustomPromptTemplate',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频vl任务prompt模版:必须包含{videoAsrText}变量,{videoAsrText}是视频的ASR文本信息,默认取页面看到的默认值。',
- '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"
- .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。',
- ],
+ 'schema' => ['description' => '视频vl任务prompt模版:必须包含{videoAsrText}变量,{videoAsrText}是视频的ASR文本信息,默认取页面看到的默认值。', '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"
+ .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。'],
],
[
'name' => 'modelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结(文本加工)依赖的大模型唯一标识,支持的模型,如果文本加工阶段想跑多任务,可以走textProcessTasks字段,如果传入了textProcessTasks,则当前字段和当前字段对应的prompt模版id,prompt模版将不再生效。'."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-llm-max',
- ],
+ 'schema' => ['description' => '视频总结(文本加工)依赖的大模型唯一标识,支持的模型,如果文本加工阶段想跑多任务,可以走textProcessTasks字段,如果传入了textProcessTasks,则当前字段和当前字段对应的prompt模版id,prompt模版将不再生效。'."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max'],
],
[
'name' => 'modelCustomPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
- ."\n"
- .'- PlotDetail:剧情详解(默认);'."\n"
- .'- Summary:内容概述;'."\n"
- .'- ExtractVideoTag:提取标签;'."\n"
- .'- ExplosivePointAnalysis:爆点分析;'."\n"
- .'- MultiTask:多类任务;'."\n"
- ."\n"
- .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
+ 'schema' => ['description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
+ ."\n"
+ .'- PlotDetail:剧情详解(默认);'."\n"
+ .'- Summary:内容概述;'."\n"
+ .'- ExtractVideoTag:提取标签;'."\n"
+ .'- ExplosivePointAnalysis:爆点分析;'."\n"
+ .'- MultiTask:多类任务;'."\n"
+ ."\n"
+ .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail'],
],
[
'name' => 'modelCustomPromptTemplate',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。',
- '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"
- .'直接输出视频剧情,不要输出其他信息。',
- ],
+ 'schema' => ['description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。', '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"
+ .'直接输出视频剧情,不要输出其他信息。'],
],
[
'name' => 'generateOptions',
@@ -4083,98 +4648,57 @@
'schema' => [
'description' => '视频理解生成任务选项。',
'type' => 'array',
- 'items' => [
- 'description' => '视频理解生成任务选项:包含的任务,会自动前置执行。'."\n"
- .'- videoAnalysis:视频语言分析(VL):如果仅传次值,则运行到视频语言分析后就结束了,不再跑后面的文本加工等子任务;'."\n"
- .'- **videoGenerate:文本加工-视频总结(默认)**,包含 videoAnalysis;'."\n"
- .'- videoTitleGenerate:视频标题生成,包含 videoAnalysis、videoGenerate;'."\n"
- .'- videoMindMappingGenerate:视频思维导图生成,包含 videoAnalysis、videoGenerate;videoRoleRecognition:角色自动识别。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoGenerate',
- ],
+ 'items' => ['description' => '视频理解生成任务选项:包含的任务,会自动前置执行。'."\n"
+ .'- videoAnalysis:视频语言分析(VL):如果仅传次值,则运行到视频语言分析后就结束了,不再跑后面的文本加工等子任务;'."\n"
+ .'- **videoGenerate:文本加工-视频总结(默认)**,包含 videoAnalysis;'."\n"
+ .'- videoTitleGenerate:视频标题生成,包含 videoAnalysis、videoGenerate;'."\n"
+ .'- videoMindMappingGenerate:视频思维导图生成,包含 videoAnalysis、videoGenerate;videoRoleRecognition:角色自动识别。', 'type' => 'string', 'required' => false, 'example' => 'videoGenerate'],
'required' => false,
],
],
[
'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '生成任务唯一标识:不传会默认生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => '生成任务唯一标识:不传会默认生成', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
'name' => 'originalSessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax'],
],
[
'name' => 'videoExtraInfo',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量',
- 'description' => '和视频相关的补充文字资料:您可以自定义扩展文本素材,应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量,传入的内容可以是视频摘要、视频简介或视频ASR转录信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '视频描述了:xx',
- ],
+ 'schema' => ['title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量', 'description' => '和视频相关的补充文字资料:您可以自定义扩展文本素材,应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量,传入的内容可以是视频摘要、视频简介或视频ASR转录信息。', 'type' => 'string', 'required' => false, 'example' => '视频描述了:xx'],
],
[
'name' => 'snapshotInterval',
'in' => 'formData',
- 'schema' => [
- 'title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。',
- 'description' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。'."\n"
- .'建议使用:当前字段优先级高于frameSampleMethod.interval,一般场景可以使用frameSampleMethod字段自定义(userdefined)模式下的interval,区别在于frameSampleMethod自定义模式interval取值需要在指定的视频时长对应抽帧间隔范围内。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。', 'description' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。'."\n"
+ .'建议使用:当前字段优先级高于frameSampleMethod.interval,一般场景可以使用frameSampleMethod字段自定义(userdefined)模式下的interval,区别在于frameSampleMethod自定义模式interval取值需要在指定的视频时长对应抽帧间隔范围内。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
],
[
'name' => 'splitInterval',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值',
- 'description' => '视频分镜最小间隔:单位秒,取值范围[1, 150],默认根据视频长度取推荐值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值', 'description' => '视频分镜最小间隔:单位秒,取值范围[1, 150],默认根据视频长度取推荐值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'language',
'in' => 'formData',
- 'schema' => [
- 'title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)',
- 'description' => '语音识别语言:'."\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:越南语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'english',
- ],
+ 'schema' => ['title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)', 'description' => '语音识别语言:'."\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:越南语', 'type' => 'string', 'required' => false, 'example' => 'english'],
],
[
'name' => 'frameSampleMethod',
@@ -4184,29 +4708,12 @@
'description' => '抽帧模式选型',
'type' => 'object',
'properties' => [
- 'methodName' => [
- 'description' => '抽帧模式选项,可传参数包括'."\n"
- .'- standard(标准)--默认'."\n"
- .'- fast(快速/更低成本)'."\n"
- .'- userdefined(自定义)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'standard',
- ],
- 'interval' => [
- 'description' => '抽帧间隔:单位秒,仅在userdefined模式下有效',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '4',
- ],
- 'pixel' => [
- 'description' => '抽帧像素:每一帧最大边像素,仅在userdefined模式下有效,取值范围是300到768',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '400',
- ],
+ 'methodName' => ['description' => '抽帧模式选项,可传参数包括'."\n"
+ .'- standard(标准)--默认'."\n"
+ .'- fast(快速/更低成本)'."\n"
+ .'- userdefined(自定义)', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'interval' => ['description' => '抽帧间隔:单位秒,仅在userdefined模式下有效', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '4'],
+ 'pixel' => ['description' => '抽帧像素:每一帧最大边像素,仅在userdefined模式下有效,取值范围是300到768', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '400'],
],
'required' => false,
'example' => 'english',
@@ -4223,57 +4730,26 @@
'description' => '人物',
'type' => 'object',
'properties' => [
- 'roleName' => [
- 'description' => '人物名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
- 'roleInfo' => [
- 'description' => '人物信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '是个xx',
- ],
+ 'roleName' => ['description' => '人物名称', 'type' => 'string', 'required' => false, 'example' => '张三'],
+ 'roleInfo' => ['description' => '人物信息', 'type' => 'string', 'required' => false, 'example' => '是个xx'],
'urls' => [
'description' => '人物头像',
'type' => 'array',
- 'items' => [
- 'description' => '人物头像',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
- ],
- 'required' => false,
- ],
- 'isAutoRecognition' => [
- 'description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)',
- 'type' => 'boolean',
+ 'items' => ['description' => '人物头像', 'type' => 'string', 'required' => false, 'example' => 'http://xxx'],
'required' => false,
- 'example' => 'false',
],
+ 'isAutoRecognition' => ['description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'timeIntervals' => [
'description' => '角色出场时间段列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'description' => '开始时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
- 'endTime' => [
- 'description' => '结束时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1748491200000',
- ],
+ 'startTime' => ['description' => '开始时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ 'endTime' => ['description' => '结束时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748491200000'],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
],
@@ -4294,38 +4770,23 @@
'description' => '视频总结(文本加工)任务',
'type' => 'object',
'properties' => [
- 'modelId' => [
- 'description' => '视频总结依赖的大模型唯一标识,支持的模型'."\n"
- .'- qwen-max-latest'."\n"
- .'- qwen-max'."\n"
- .'- qwen-plus-latest'."\n"
- .'- qwen-plus'."\n"
- .'- qwen2.5-7b-instruct-1m'."\n"
- .'- deepseek-r1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- 'modelCustomPromptTemplate' => [
- 'description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'modelCustomPromptTemplateId' => [
- 'description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
- ."\n"
- .'- PlotDetail:剧情详解(默认);'."\n"
- .'- Summary:内容概述;'."\n"
- .'- ExtractVideoTag:提取标签;'."\n"
- .'- ExplosivePointAnalysis:爆点分析;'."\n"
- .'- MultiTask:多类任务;'."\n"
- ."\n"
- .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PlotDetail',
- ],
+ 'modelId' => ['description' => '视频总结依赖的大模型唯一标识,支持的模型'."\n"
+ .'- qwen-max-latest'."\n"
+ .'- qwen-max'."\n"
+ .'- qwen-plus-latest'."\n"
+ .'- qwen-plus'."\n"
+ .'- qwen2.5-7b-instruct-1m'."\n"
+ .'- deepseek-r1', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
+ 'modelCustomPromptTemplate' => ['description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'modelCustomPromptTemplateId' => ['description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
+ ."\n"
+ .'- PlotDetail:剧情详解(默认);'."\n"
+ .'- Summary:内容概述;'."\n"
+ .'- ExtractVideoTag:提取标签;'."\n"
+ .'- ExplosivePointAnalysis:爆点分析;'."\n"
+ .'- MultiTask:多类任务;'."\n"
+ ."\n"
+ .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail'],
],
'required' => false,
],
@@ -4335,24 +4796,12 @@
[
'name' => 'faceIdentitySimilarityMinScore',
'in' => 'formData',
- 'schema' => [
- 'description' => '人物识别相似度阈值:(0~1)',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.7',
- ],
+ 'schema' => ['description' => '人物识别相似度阈值:(0~1)', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7'],
],
[
'name' => 'videoShotFaceIdentityCount',
'in' => 'formData',
- 'schema' => [
- 'description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量:[1~5]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量:[1~5]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'excludeGenerateOptions',
@@ -4366,14 +4815,9 @@
."\n"
.'- videoCaption:视频语音识别',
'type' => 'array',
- 'items' => [
- 'description' => '排除的生成步骤:'."\n"
- ."\n"
- .'- videoCaption:视频语音识别',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[\\"videoCaption\\"]',
- ],
+ 'items' => ['description' => '排除的生成步骤:'."\n"
+ ."\n"
+ .'- videoCaption:视频语音识别', 'type' => 'string', 'required' => false, 'example' => '[\\"videoCaption\\"]'],
'required' => false,
],
],
@@ -4395,48 +4839,16 @@
'description' => '字幕(asr)内容',
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'title' => '当前句子开始时间:毫秒',
- 'description' => '当前句子开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
- 'endTime' => [
- 'title' => '当前句子结束时间:毫秒',
- 'description' => '当前句子结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10000',
- ],
- 'text' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你好',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
+ 'startTime' => ['title' => '当前句子开始时间:毫秒', 'description' => '当前句子开始时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
+ 'endTime' => ['title' => '当前句子结束时间:毫秒', 'description' => '当前句子结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
+ 'text' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '你好'],
+ 'speaker' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
'required' => false,
],
'required' => false,
],
- 'videoCaptionFileUrl' => [
- 'title' => '视频字幕(ASR)文件',
- 'description' => '视频字幕(ASR)文件',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss:// | http://',
- ],
+ 'videoCaptionFileUrl' => ['title' => '视频字幕(ASR)文件', 'description' => '视频字幕(ASR)文件', 'type' => 'string', 'required' => false, 'example' => 'oss:// | http://'],
],
'required' => false,
],
@@ -4444,25 +4856,14 @@
[
'name' => 'autoRoleRecognitionVideoUrl',
'in' => 'formData',
- 'schema' => [
- 'description' => '自动识别功能单独的视频地址Url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://',
- ],
+ 'schema' => ['description' => '自动识别功能单独的视频地址Url', 'type' => 'string', 'required' => false, 'example' => 'http://'],
],
[
'name' => 'splitType',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'description' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
- .' fixDuration(按照固定时长分镜),默认采用minDuration模式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'fixDuration',
- ],
+ 'schema' => ['title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
+ .' fixDuration(按照固定时长分镜),默认采用minDuration模式', 'description' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
+ .' fixDuration(按照固定时长分镜),默认采用minDuration模式', 'type' => 'string', 'required' => false, 'example' => 'fixDuration'],
],
[
'name' => 'videoUrls',
@@ -4472,13 +4873,7 @@
'title' => '多视频url',
'description' => '多视频url',
'type' => 'array',
- 'items' => [
- 'title' => '视频url',
- 'description' => '视频url',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
- ],
+ 'items' => ['title' => '视频url', 'description' => '视频url', 'type' => 'string', 'required' => false, 'example' => 'http://xxx'],
'required' => false,
],
],
@@ -4491,81 +4886,26 @@
'description' => '指定数据集后:视频理解结果作为meta信息和视频一起上传到妙搜',
'type' => 'object',
'properties' => [
- 'datasetId' => [
- 'title' => '数据集id',
- 'description' => '数据集id:如果期望上传到妙搜,这个字段必选',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '890',
- ],
- 'datasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'datasetId' => ['title' => '数据集id', 'description' => '数据集id:如果期望上传到妙搜,这个字段必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '890'],
+ 'datasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'document' => [
'title' => '自动保存视频参数',
'description' => '上传妙搜相关参数:不录入会自动生成',
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '视频名称',
- 'description' => '视频名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'description' => '文档业务唯一标识:同数据集会排重',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'categoryUuid' => [
- 'title' => '类目唯一标识',
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'title' => ['title' => '视频名称', 'description' => '视频名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'docId' => ['title' => '视频docId', 'description' => '文档业务唯一标识:同数据集会排重', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'categoryUuid' => ['title' => '类目唯一标识', 'description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'tags' => [
'title' => '标签',
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'title' => '标签',
- 'description' => '标签值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'extend1' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'extend2' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'extend3' => [
- 'title' => '扩展字段',
- 'description' => '扩展字段3',
- 'type' => 'string',
+ 'items' => ['title' => '标签', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => 'xx',
],
+ 'extend1' => ['title' => '扩展字段', 'description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend2' => ['title' => '扩展字段', 'description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend3' => ['title' => '扩展字段', 'description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'metadata' => [
'title' => '字典',
'description' => '元数据',
@@ -4578,18 +4918,8 @@
'description' => 'keyValue结构的元数据',
'type' => 'object',
'properties' => [
- 'key' => [
- 'description' => '字段名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'value' => [
- 'description' => '字段值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'key' => ['description' => '字段名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'value' => ['description' => '字段值', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
'required' => false,
],
@@ -4617,41 +4947,13 @@
'description' => '流式输出 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-progress-start-generating',
- ],
- 'eventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '可空',
- ],
- 'sessionId' => [
- 'description' => '一次生成唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'taskId' => [
- 'description' => '生成唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'traceId' => [
- 'description' => '链路traceid ',
- 'type' => 'string',
- 'example' => '2150432017236011824686132ecdbc',
- ],
+ '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' => '链路traceid ', 'type' => 'string', 'example' => '2150432017236011824686132ecdbc'],
],
],
'payload' => [
@@ -4666,44 +4968,16 @@
'description' => '视频语言vl生成结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '生成内容',
- 'type' => 'string',
- 'example' => '根据xxx',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '生成内容', 'type' => 'string', 'example' => '根据xxx'],
'usage' => [
'description' => 'Token数量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'imageTokens' => [
- 'description' => '图片识别token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'imageTokens' => ['description' => '图片识别token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
],
],
'videoShotAnalysisResults' => [
@@ -4713,43 +4987,20 @@
'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' => '根据xxx',
- ],
+ 'endTime' => ['description' => '结束时间,相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
+ 'startTime' => ['description' => '开始时间,相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'text' => ['description' => '分镜对应生成内容', 'type' => 'string', 'example' => '根据xxx'],
],
],
],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'description' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-vl-max',
- ],
+ 'modelId' => ['title' => '实际使用的模型唯一标识', 'description' => '实际使用的模型唯一标识', 'type' => 'string', 'example' => 'qwen-vl-max'],
],
],
'videoCaptionResult' => [
'description' => '视频字幕结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
'videoCaptions' => [
'description' => '视频字幕列表',
'type' => 'array',
@@ -4757,39 +5008,12 @@
'description' => '视频字幕',
'type' => 'object',
'properties' => [
- 'endTime' => [
- 'description' => '结束时间:相对时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20000',
- ],
- 'endTimeFormat' => [
- 'description' => '结束时间,格式化结果:00:01',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'startTime' => [
- 'description' => '开始时间,相对时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'startTimeFormat' => [
- 'description' => '开始时间,格式化结果:00:01',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'text' => [
- 'description' => '字幕内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'speaker' => [
- 'title' => '角色',
- 'description' => '角色',
- 'type' => 'string',
- 'example' => '张三',
- ],
+ 'endTime' => ['description' => '结束时间:相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'],
+ 'endTimeFormat' => ['description' => '结束时间,格式化结果:00:01', 'type' => 'string', 'example' => '00:01'],
+ 'startTime' => ['description' => '开始时间,相对时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'startTimeFormat' => ['description' => '开始时间,格式化结果:00:01', 'type' => 'string', 'example' => '00:01'],
+ 'text' => ['description' => '字幕内容', 'type' => 'string', 'example' => 'xxx'],
+ 'speaker' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'example' => '张三'],
],
],
],
@@ -4799,101 +5023,36 @@
'description' => '视频总结结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '视频总结内容',
- 'type' => 'string',
- 'example' => '根据xxx',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '视频总结内容', 'type' => 'string', 'example' => '根据xxx'],
'usage' => [
'description' => 'Token数量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'description' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelReduce' => [
- 'title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest',
- 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性',
- 'type' => 'boolean',
- 'example' => 'qwen-plus-latest',
- ],
- 'reasonText' => [
- 'description' => '模型思考过程',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'index' => [
- 'description' => '多任务标号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'modelId' => ['title' => '实际使用的模型唯一标识', 'description' => '实际使用的模型唯一标识', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelReduce' => ['title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest', 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性', 'type' => 'boolean', 'example' => 'qwen-plus-latest'],
+ 'reasonText' => ['description' => '模型思考过程', 'type' => 'string', 'example' => 'xxx'],
+ 'index' => ['description' => '多任务标号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'videoMindMappingGenerateResult' => [
'description' => '视频思维导图结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '生成原始内容',
- 'type' => 'string',
- 'example' => '根据xxx',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '生成原始内容', 'type' => 'string', 'example' => '根据xxx'],
'usage' => [
'description' => 'Token数量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
'videoMindMappings' => [
@@ -4917,94 +5076,39 @@
'description' => '子节点',
'type' => 'object',
'properties' => [
- 'name' => [
- 'description' => '节点描述',
- 'type' => 'string',
- 'example' => '三级',
- ],
+ 'name' => ['description' => '节点描述', 'type' => 'string', 'example' => '三级'],
],
],
],
- 'name' => [
- 'description' => '节点描述',
- 'type' => 'string',
- 'example' => '二级',
- ],
+ 'name' => ['description' => '节点描述', 'type' => 'string', 'example' => '二级'],
],
],
],
- 'name' => [
- 'description' => '节点描述',
- 'type' => 'string',
- 'example' => '一级',
- ],
+ 'name' => ['description' => '节点描述', 'type' => 'string', 'example' => '一级'],
],
],
],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'description' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'modelReduce' => [
- 'title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest',
- 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'modelId' => ['title' => '实际使用的模型唯一标识', 'description' => '实际使用的模型唯一标识', 'type' => 'string', 'example' => 'true'],
+ 'modelReduce' => ['title' => '是否发生模型降级:如果使用的是max模型,如果系统判断prompt输入超过上限,会尝试降级成qwen-plus-latest', 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性', 'type' => 'boolean', 'example' => 'true'],
],
],
'videoTitleGenerateResult' => [
'description' => '视频标题结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'text' => [
- 'description' => '生成内容',
- 'type' => 'string',
- 'example' => '标题',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'text' => ['description' => '生成内容', 'type' => 'string', 'example' => '标题'],
'usage' => [
'description' => 'Token数量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
- 'modelId' => [
- 'title' => '实际使用的模型唯一标识',
- 'description' => '实际使用的模型唯一标识',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelReduce' => [
- 'title' => 'modelReduce',
- 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'modelId' => ['title' => '实际使用的模型唯一标识', 'description' => '实际使用的模型唯一标识', 'type' => 'string', 'example' => 'qwen-max'],
+ 'modelReduce' => ['title' => 'modelReduce', 'description' => '模型是否被降级:如果模型是qwen-max或qwen-max-latest,且超过prompt输入上限时,会尝试降级到qwen-plus-latest模型,保证信息完整性', 'type' => 'boolean', 'example' => 'true'],
],
],
'videoShotSnapshotResult' => [
@@ -5018,28 +5122,10 @@
'description' => '片段',
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'description' => '开始时间:相对时间,单位ms',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'endTime' => [
- 'description' => '结束时间:相对时间,单位ms',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'startTimeFormat' => [
- 'description' => '开始时间(格式化):相对时间,比如00:01',
- 'type' => 'string',
- 'example' => '00:01',
- ],
- 'endTimeFormat' => [
- 'description' => '结束时间(格式化):相对时间,比如00:01',
- 'type' => 'string',
- 'example' => '00:02',
- ],
+ 'startTime' => ['description' => '开始时间:相对时间,单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'endTime' => ['description' => '结束时间:相对时间,单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'startTimeFormat' => ['description' => '开始时间(格式化):相对时间,比如00:01', 'type' => 'string', 'example' => '00:01'],
+ 'endTimeFormat' => ['description' => '结束时间(格式化):相对时间,比如00:01', 'type' => 'string', 'example' => '00:02'],
'videoSnapshots' => [
'description' => '帧列表',
'type' => 'array',
@@ -5047,11 +5133,7 @@
'description' => '帧',
'type' => 'object',
'properties' => [
- 'url' => [
- 'description' => '帧url:带有效期的可公网访问地址,如需要下载,请在有效期内下载',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
+ 'url' => ['description' => '帧url:带有效期的可公网访问地址,如需要下载,请在有效期内下载', 'type' => 'string', 'example' => 'http://xxx'],
],
],
],
@@ -5060,29 +5142,24 @@
],
],
],
- 'resultJsonFileUrl' => [
- 'title' => '全量结果文件地址:'."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
- .'当前包含的字段:'."\n"
- .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
- .'其他字段获取方式不变,文本方式返回。'."\n"
- .'文件类型:json'."\n"
- .'文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'description' => '结果json文件地址:'."\n"
- ."\n"
- .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用:'."\n"
- ."\n"
- .'- 当前包含的字段:数据结构定义见RunVideoAnalysis接口'."\n"
- .' - videoShotSnapshotResult:每个分片抽帧信息,包括每帧url'."\n"
- .' - videoShotAnalysisResults:每个分片语言分析结果明细'."\n"
- .'- 其他字段获取方式不变,文本方式返回。'."\n"
- .'- 文件类型:json'."\n"
- .'- 文件内容:全量报文,包含文本方式返回的'."\n"
- .'返回event:task-finished',
- 'type' => 'string',
- 'example' => 'http://',
- ],
+ 'resultJsonFileUrl' => ['title' => '全量结果文件地址:'."\n"
+ .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用。'."\n"
+ .'当前包含的字段:'."\n"
+ .'- videoShotSnapshotResult(分片抽帧信息),数据结构定义见RunVideoAnalysis接口'."\n"
+ .'其他字段获取方式不变,文本方式返回。'."\n"
+ .'文件类型:json'."\n"
+ .'文件内容:全量报文,包含文本方式返回的'."\n"
+ .'返回event:task-finished', 'description' => '结果json文件地址:'."\n"
+ ."\n"
+ .'由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段url下载文件,并解析使用:'."\n"
+ ."\n"
+ .'- 当前包含的字段:数据结构定义见RunVideoAnalysis接口'."\n"
+ .' - videoShotSnapshotResult:每个分片抽帧信息,包括每帧url'."\n"
+ .' - videoShotAnalysisResults:每个分片语言分析结果明细'."\n"
+ .'- 其他字段获取方式不变,文本方式返回。'."\n"
+ .'- 文件类型:json'."\n"
+ .'- 文件内容:全量报文,包含文本方式返回的'."\n"
+ .'返回event:task-finished', 'type' => 'string', 'example' => 'http://'],
'videoGenerateResults' => [
'description' => '当入参为多任务时(textProcessTasks有值),返回文本加工结果对应这个字段,可以通过数据所在数组位置(下标)或index(1开始)找到对应结果。',
'type' => 'array',
@@ -5090,54 +5167,18 @@
'description' => '文本分析结果',
'type' => 'object',
'properties' => [
- 'generateFinished' => [
- 'description' => '当前任务是否已生成结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'modelId' => [
- 'description' => '模型ID',
- 'type' => 'string',
- 'example' => 'qwen-max-latest',
- ],
- 'index' => [
- 'description' => '序号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'text' => [
- 'description' => '视频总结内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'reasonText' => [
- 'description' => '模型思考过程',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'generateFinished' => ['description' => '当前任务是否已生成结束', 'type' => 'boolean', 'example' => 'true'],
+ 'modelId' => ['description' => '模型ID', 'type' => 'string', 'example' => 'qwen-max-latest'],
+ 'index' => ['description' => '序号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'text' => ['description' => '视频总结内容', 'type' => 'string', 'example' => 'xxx'],
+ 'reasonText' => ['description' => '模型思考过程', 'type' => 'string', 'example' => 'xxx'],
'usage' => [
'description' => '用量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
@@ -5155,16 +5196,8 @@
'items' => [
'type' => 'object',
'properties' => [
- 'roleName' => [
- 'description' => '角色名称',
- 'type' => 'string',
- 'example' => 'test-role',
- ],
- 'roleInfo' => [
- 'description' => '人物信息描述',
- 'type' => 'string',
- 'example' => '角色身份',
- ],
+ 'roleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'test-role'],
+ 'roleInfo' => ['description' => '人物信息描述', 'type' => 'string', 'example' => '角色身份'],
'timeIntervals' => [
'title' => '出场时间段',
'description' => '出场时间段',
@@ -5172,46 +5205,18 @@
'items' => [
'type' => 'object',
'properties' => [
- 'startTime' => [
- 'description' => '开始时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'endTime' => [
- 'description' => '结束时间,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1735535279000',
- ],
- 'timestamp' => [
- 'title' => '角色出现时间',
- 'description' => '角色出现时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23333333',
- ],
- 'url' => [
- 'description' => '图片url',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qtgazV1oZ3djafcFz_!!6000000005238-0-tps-1540-1540.jpg',
- ],
+ 'startTime' => ['description' => '开始时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'endTime' => ['description' => '结束时间,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1735535279000'],
+ 'timestamp' => ['title' => '角色出现时间', 'description' => '角色出现时间', 'type' => 'integer', 'format' => 'int64', 'example' => '23333333'],
+ 'url' => ['description' => '图片url', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qtgazV1oZ3djafcFz_!!6000000005238-0-tps-1540-1540.jpg'],
],
+ 'description' => '',
],
],
- 'ratio' => [
- 'title' => '出场率',
- 'description' => '出场率',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.06',
- ],
- 'isAutoRecognition' => [
- 'description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'ratio' => ['title' => '出场率', 'description' => '出场率', 'type' => 'number', 'format' => 'float', 'example' => '0.06'],
+ 'isAutoRecognition' => ['description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
@@ -5230,67 +5235,15 @@
'description' => '计费项明细',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '计费项名称',
- 'description' => '计费项名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'type' => [
- 'title' => '计费项类型',
- 'description' => '计费项类型',
- 'type' => 'string',
- 'example' => '模型推理',
- ],
- 'inputToken' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'outputToken' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- ],
- 'time' => [
- 'title' => '计费时长',
- 'description' => '计费时长',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- 'inputExpense' => [
- 'title' => '输入token价格',
- 'description' => '输入token价格',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.234',
- ],
- 'outputExpense' => [
- 'title' => '输出token价格',
- 'description' => '输出token价格',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.124',
- ],
- 'timeExpense' => [
- 'title' => '时间计费',
- 'description' => '时间计费',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.02',
- ],
- 'totalExpense' => [
- 'title' => '总计费',
- 'description' => '总计费',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.378',
- ],
+ 'name' => ['title' => '计费项名称', 'description' => '计费项名称', 'type' => 'string', 'example' => 'xxx'],
+ 'type' => ['title' => '计费项类型', 'description' => '计费项类型', 'type' => 'string', 'example' => '模型推理'],
+ 'inputToken' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'outputToken' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'time' => ['title' => '计费时长', 'description' => '计费时长', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ 'inputExpense' => ['title' => '输入token价格', 'description' => '输入token价格', 'type' => 'number', 'format' => 'double', 'example' => '0.234'],
+ 'outputExpense' => ['title' => '输出token价格', 'description' => '输出token价格', 'type' => 'number', 'format' => 'double', 'example' => '0.124'],
+ 'timeExpense' => ['title' => '时间计费', 'description' => '时间计费', 'type' => 'number', 'format' => 'double', 'example' => '0.02'],
+ 'totalExpense' => ['title' => '总计费', 'description' => '总计费', 'type' => 'number', 'format' => 'double', 'example' => '0.378'],
],
],
],
@@ -5301,37 +5254,11 @@
'description' => '自动保存执行结果',
'type' => 'object',
'properties' => [
- 'status' => [
- 'title' => '自动保存任务状态:1 成功,0 失败',
- 'description' => '自动保存任务状态:1 成功,0 失败',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'title' => [
- 'title' => '视频名称',
- 'description' => '视频名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'docId' => [
- 'title' => '视频docId',
- 'description' => '视频docId',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'errorMessage' => [
- 'title' => '如果自动保存失败,则输出错误信息',
- 'description' => '如果自动保存失败,则输出错误信息',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'docUuid' => [
- 'title' => '视频的docUuid',
- 'description' => '视频的docUuid',
- 'type' => 'string',
- 'example' => 'uuid',
- ],
+ 'status' => ['title' => '自动保存任务状态:1 成功,0 失败', 'description' => '自动保存任务状态:1 成功,0 失败', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'title' => ['title' => '视频名称', 'description' => '视频名称', 'type' => 'string', 'example' => 'xxx'],
+ 'docId' => ['title' => '视频docId', 'description' => '视频docId', 'type' => 'string', 'example' => 'xxx'],
+ 'errorMessage' => ['title' => '如果自动保存失败,则输出错误信息', 'description' => '如果自动保存失败,则输出错误信息', 'type' => 'string', 'example' => 'xxx'],
+ 'docUuid' => ['title' => '视频的docUuid', 'description' => '视频的docUuid', 'type' => 'string', 'example' => 'uuid'],
],
],
],
@@ -5340,53 +5267,27 @@
'description' => 'Token数量',
'type' => 'object',
'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'totalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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-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' => '视频理解-在线任务',
- 'description' => '## 接口说明'."\n"
- .'阿里云百炼轻应用-视频理解:基于这接口,可以传入一个视频,进行字幕提取、视频内容分析、视频总结、标题抽取、思维导图生成等任务,也可以通过自定义prompt来实现差异化的视频内容生成。'."\n"
+ 'description' => '阿里云百炼轻应用-视频理解:基于这接口,可以传入一个视频,进行字幕提取、视频内容分析、视频总结、标题抽取、思维导图生成等任务,也可以通过自定义prompt来实现差异化的视频内容生成。'."\n"
."\n"
.'- 欢迎前往[轻应用-影视传媒视频理解](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)直接体验。'."\n"
."\n"
@@ -5474,12 +5375,10 @@
.'```'."\n"
."\n"
.'- **给子账号授权**:菜单“**身份管理-用户**”下,找到对应用户,新增授权,切换自定义授权,添加上面自定义的授权策略。'."\n"
- ."\n\n"
."\n"
.'### 阿里云百炼控制台授权说明'."\n"
."\n"
- .'使用主账号或有阿里云百炼管理员权限的子账号,登录阿里云百炼控制台,在[权限管理-用户管理](https://bailian.console.aliyun.com/?tab=app#/authority)页面添加子账号,并进行授权管理员权限。'."\n"
- ."\n\n"
+ .'使用主账号或有阿里云百炼管理员权限的子账号,登录阿里云百炼控制台,在[权限管理-用户管理](https://bailian.console.aliyun.com/?tab=app#/authority)页面添加子账号。'."\n"
."\n"
.'## 接口部分入参取值说明'."\n"
.'### 抽帧配置字段(frameSampleMethod)'."\n"
@@ -5492,90 +5391,95 @@
.' - 最小抽帧间隔 = max("标准"方式对应抽帧间隔 - 0.2,1)'."\n"
.' - 最大抽帧间隔 = "标准"方式对应抽帧间隔 + 5'."\n"
.' - 最小抽帧像素 = max("标准"方式对应抽帧像素 - 50,300)'."\n"
- .' - 最大抽帧像素 = "标准"方式对应抽帧像素 + 50><details>',
+ .' - 最大抽帧像素 = "标准"方式对应抽帧像素 + 50'."\n"
+ ."\n"
+ .'## Agent 集成'."\n"
+ .'Agent 可通过 Skill 直接使用视频理解能力:'."\n"
+ ."\n"
+ .'- **Skill 名称**:`alibabacloud-bailian-videoanalysis`'."\n"
+ .'- **Skill 地址**:[https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis](https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis)',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-11-24T13:17:56.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-10-17T01:54:58.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-20T10:20:44.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-03-27T09:29:33.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-18T05:48:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-01-15T11:40:37.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-01-14T12:12:10.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-12-05T11:47:13.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-09-26T10:46:41.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-05T05:01:32.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'SubmitVideoDetectShotTask' => [
- 'summary' => '轻应用-视频拆条异步任务'."\n"
+ 'RunVideoDetectShot' => [
+ 'summary' => '轻应用-视频拆条'."\n"
."\n"
.'使用视频拆条需先开通影视传媒视频理解(免费开通)https://bailian.console.aliyun.com/?tab=app#/app/app-market/quanmiao/video-comprehend'."\n"
."\n"
.'目前拆条提供三种场景视频的处理:'."\n"
.'1、节目场景 2、新闻场景 3、其他场景'."\n"
.'详细使用建议及参考prompt请查看下方补充说明。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitVideoDetectShotTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoDetectShot',
+ '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxxxx'],
],
[
'name' => 'videoUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频的地址',
- 'description' => '视频的地址',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://xxx.mp4',
- ],
+ 'schema' => ['title' => '视频的地址', 'description' => '视频的地址', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.mp4'],
],
[
'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' => 'llm的模型,推荐选择deepseek-r1'."\n"
- .'可选项:'."\n"
- .'- deepseek-r1'."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-r1',
- ],
+ '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' => 'llm的模型,推荐选择deepseek-r1'."\n"
+ .'可选项:'."\n"
+ .'- deepseek-r1'."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'deepseek-r1'],
],
[
'name' => 'options',
@@ -5585,78 +5489,34 @@
'title' => '用户选择使用什么方式进行分镜,可选项:ASR',
'description' => '用户选择使用什么方式进行分镜,可选项:ASR',
'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'deduplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'description' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR'],
+ 'required' => true,
],
],
[
- 'name' => 'prompt',
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm用户自定义prompt',
- 'description' => 'llm用户自定义prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '任务唯一标识', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
],
[
- 'name' => 'taskId',
+ 'name' => 'originalSessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax'],
],
[
- 'name' => 'originalSessionId',
+ 'name' => 'prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['title' => 'llm用户自定义prompt', 'description' => 'llm用户自定义prompt', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'modelCustomPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm生成拆条结果prompt的ID',
- 'description' => 'llm生成拆条结果prompt的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotShowPrompt',
- ],
+ 'schema' => ['title' => 'llm生成拆条结果prompt的ID', 'description' => 'llm生成拆条结果prompt的ID', 'type' => 'string', 'required' => false, 'example' => 'videoDetectShotShowPrompt'],
],
[
'name' => 'modelVlCustomPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl识别prompt的ID',
- 'description' => 'vl识别prompt的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotVlShowPrompt',
- ],
+ 'schema' => ['title' => 'vl识别prompt的ID', 'description' => 'vl识别prompt的ID', 'type' => 'string', 'required' => false, 'example' => 'videoDetectShotVlShowPrompt'],
],
[
'name' => 'recognitionOptions',
@@ -5666,113 +5526,78 @@
'title' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
'description' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => false,
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR'],
+ 'required' => true,
],
],
[
'name' => 'intelliSimpPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '大语言模型前置简化promptId',
- 'description' => '大语言模型前置简化promptId',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'intelliSimpShowPrompt',
- ],
+ 'schema' => ['title' => '大语言模型前置简化promptId', 'description' => '大语言模型前置简化promptId', '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' => '执行intelliSimpPrompt的模型,推荐选择quanmiao-llm-max'."\n"
- .'可选项:'."\n"
- .'- deepseek-r1'."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-llm-max',
- ],
+ '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' => '执行intelliSimpPrompt的模型,推荐选择 quanmiao-llm-max'."\n"
+ .'可选项:'."\n"
+ .'- deepseek-r1'."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max'],
],
[
'name' => 'intelliSimpPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '简化输入给llm的数据的prompt(用户自定义)',
- 'description' => '简化输入给llm的数据的prompt(用户自定义)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '简化输入给llm的数据的prompt(用户自定义)', 'description' => '简化输入给llm的数据的prompt(用户自定义)', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'vlPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl模型用户自定义prompt',
- 'description' => 'vl模型用户自定义prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '用户自定义的vl识别prompt', 'description' => '用户自定义的vl识别prompt', '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' => '语音识别语言:'."\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:越南语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chinese',
- ],
+ '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' => '语音识别语言:'."\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:越南语', 'type' => 'string', 'required' => false, 'example' => 'chinese'],
],
],
'responses' => [
@@ -5782,62 +5607,87 @@
'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',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'header' => [
+ 'description' => '流式输出 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'],
+ ],
],
- 'data' => [
- 'description' => '结果',
+ 'payload' => [
+ 'description' => '生成结果数据',
'type' => 'object',
'properties' => [
- 'taskId' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'example' => '22ec888712de45b39b97983f8d166831',
+ 'output' => [
+ 'description' => '输出内容对象',
+ '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' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'xxx', 'example' => 'xxx'],
+ 'description' => '',
+ ],
+ ],
+ 'videoRecognitionResult' => [
+ 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
+ 'description' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
+ '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'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'usage' => [
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'inputTokens' => ['description' => '输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '4546'],
+ 'outputTokens' => ['description' => '输出Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '820'],
+ 'totalTokens' => ['description' => '总token数', 'type' => 'integer', 'format' => 'int64', 'example' => '5366'],
+ ],
],
],
],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '58868FD6-53D7-5ACD-80F7-854C8EA256EF'],
],
],
],
],
'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' => '请检查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"}]',
- 'title' => '智能拆条-提交异步任务',
+ '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' => '智能拆条-在线任务',
'extraInfo' => '目前拆条提供三种场景视频的处理:'."\n"
.'1、节目场景 2、新闻场景 3、其他场景'."\n"
."\n"
@@ -6215,58 +6065,159 @@
.' 6、必须保证时间的准确性。'."\n"
."\n"
.' 请严格按照上述规则处理文本。',
- ],
- 'GetVideoDetectShotTask' => [
- 'summary' => '轻应用-获取视频拆条异步任务结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getVideoDetectShotTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoDetectShot',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SubmitEnterpriseVocAnalysisTask' => [
+ 'summary' => '提交企业VOC异步任务',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitEnterpriseVocAnalysisTask',
+ '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',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。'],
+ ],
+ [
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务补充信息', 'description' => '业务补充信息', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
+ 'in' => 'formData',
+ 'schema' => ['title' => '输出格式描述提示词(不传的话默认会根据任务描述生成json格式)', 'description' => '输出格式描述提示词(不传的话默认会根据任务描述生成json格式)', 'type' => 'string', 'required' => false, 'example' => '请直接输出json格式,不要输出其他内容:'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ 'title' => '内容标签',
+ 'description' => '内容标签',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签体系列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'tagDefinePrompt' => ['title' => '给到大模型的标签定义Prompt', 'description' => '给到大模型的标签定义Prompt', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'taskId',
- 'in' => 'query',
+ 'name' => 'filterTags',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
+ 'title' => '过滤标签',
+ 'description' => '过滤标签',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagName' => ['title' => '标签名称', 'description' => '过滤标签名称', 'type' => 'string', 'required' => false, 'example' => '过滤标签名称'],
+ 'tagDefinePrompt' => ['title' => '给到大模型的 筛选的标签定义Prompt', 'description' => '给到大模型的 筛选的标签定义Prompt', 'type' => 'string', 'required' => false, 'example' => '标签抽取的定义的Prompt'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'contents',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '待挖掘的素材内容列表(url、fileKey、contents 三选一)(此数组不超过200个,更多请走fileKey或contents文件形式)',
+ 'description' => '待挖掘的素材内容列表(url、fileKey、contents 三选一)(此数组不超过200个,更多请走fileKey或contents文件形式)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '素材对象',
+ 'description' => '素材对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'text' => ['title' => '素材内容(字符数不能超过1w个)', 'description' => '素材内容(字符数不能超过1w个)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'id' => ['title' => '素材ID', 'description' => '素材ID', 'type' => 'string', 'required' => false, 'example' => 'id-xxxxx'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
+ [
+ 'name' => 'url',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待挖掘的素材内容文件URL(url、fileKey、contents 三选一)(整体文件大小不能超过100M,素材个数不能超过6w条)', 'description' => '待挖掘的素材内容文件URL(url、fileKey、contents 三选一)(整体文件大小不能超过100M,素材个数不能超过6w条)', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt'],
+ ],
+ [
+ 'name' => 'fileKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待挖掘的素材内容文件FileKey(url、fileKey、contents 三选一)(fileKey 是从全妙SASS页面上传所获取到的唯一key)', 'description' => '待挖掘的素材内容文件FileKey(url、fileKey、contents 三选一)(fileKey 是从全妙SASS页面上传所获取到的唯一key)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt'],
+ ],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼APIKEY', 'description' => '百炼APIKEY', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxx'],
+ ],
+ [
+ 'name' => 'sourceTrace',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否启用溯源(启用溯源时不支持自定义outputformat)', 'description' => '是否启用溯源(启用溯源时不支持自定义outputformat)', 'type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'batchTask',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否走模型的BATCH API (费用减半、时效性24小时内)'."\n"
+ ."\n"
+ .'(支持batchAPI的模型有:通义千问 Max、Plus、Flash、Turbo、Long 的稳定版本及其部分 latest 版本,以及 QwQ 系列(qwq-plus、qwq-32b-preview)和部分第三方模型(deepseek-r1、deepseek-v3)。'."\n"
+ .')'."\n", 'description' => '是否走模型的BATCH API (费用减半、时效性24小时内)'."\n"
+ ."\n"
+ .'(支持batchAPI的模型有:通义千问 Max、Plus、Flash、Turbo、Long 的稳定版本及其部分 latest 版本,以及 QwQ 系列(qwq-plus、qwq-32b-preview)和部分第三方模型(deepseek-r1、deepseek-v3)。'."\n"
+ .')'."\n", 'type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'positiveFilter',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否正向筛选(true-正向筛选,默认;false-反向筛选)', 'description' => '是否正向筛选(true-正向筛选,默认;false-反向筛选)', 'type' => 'boolean', 'required' => false],
+ ],
],
'responses' => [
200 => [
@@ -6275,511 +6226,788 @@
'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' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ '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'],
'data' => [
- 'description' => '结果',
+ 'title' => '业务对象',
+ 'description' => '业务对象',
'type' => 'object',
'properties' => [
- 'header' => [
- 'description' => 'event名称',
- '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' => '全量路ID',
- 'type' => 'string',
- 'example' => '215045f817272303448235204efdef',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '结果',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'description' => '结果',
- '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' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'xxx',
- 'description' => 'xxx',
- ],
- ],
- ],
- 'videoRecognitionResult' => [
- 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- 'description' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- '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',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'usage' => [
- 'description' => 'token数量',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '36',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- ],
- 'totalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '49',
- ],
- ],
- ],
- ],
- ],
- 'taskRunInfo' => [
- 'title' => '运行信息',
- 'description' => '运行信息',
- 'type' => 'object',
- 'properties' => [
- 'concurrentChargeEnable' => [
- 'title' => '是否使用付给并发:true时,按照实际运行时长计量',
- 'description' => '是否使用付给并发:true时,按照实际运行时长计量',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'responseTime' => [
- 'title' => '运行时长:rt',
- 'description' => '运行时长:rt',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- ],
- ],
- 'taskStatus' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'taskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'errorMessage' => [
- 'description' => '异常错误信息',
- 'type' => 'string',
- 'example' => 'Failed to proxy flink ui request, message: An error occurred: Invalid UUID string: jobsn.',
- ],
+ 'taskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'a0cc71ec-fe07-47e5-bf12-6e1c46081c98'],
],
],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '403'],
+ 'message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '无权限访问接口'],
+ 'success' => ['title' => '接口请求是否成功:true 成功,false 失败', 'description' => '接口请求是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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' => '提交企业VOC挖掘异步任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:53:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-17T11:51:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '智能拆条-获取异步任务状态和结果',
],
- 'UpdateVideoDetectShotTask' => [
- 'summary' => '智能拆条-修改异步任务状态:目前仅支持取消任务。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/updateVideoDetectShotTask',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitEssayCorrectionTask' => [
+ 'summary' => '提交作文批改任务。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitEssayCorrectionTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'taskId',
+ 'name' => 'tasks',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
+ 'title' => '批改任务列表',
+ 'description' => '批改任务列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '批改子任务',
+ 'description' => '子任务',
+ 'type' => 'object',
+ 'properties' => [
+ 'grade' => ['title' => '年级,可选值有:'."\n"
+ .'['."\n"
+ .' "初中一年级",'."\n"
+ .' "初中二年级",'."\n"
+ .' "初中三年级",'."\n"
+ .' "高中一年级",'."\n"
+ .' "高中二年级",'."\n"
+ .' "高中三年级"'."\n"
+ .']', 'description' => '年级,可选值有:'."\n"
+ .'['."\n"
+ .' "初中一年级",'."\n"
+ .' "初中二年级",'."\n"
+ .' "初中三年级",'."\n"
+ .' "高中一年级",'."\n"
+ .' "高中二年级",'."\n"
+ .' "高中三年级"'."\n"
+ .']', 'type' => 'string', 'required' => false, 'example' => '高中二年级'],
+ 'subject' => ['title' => '科目,可选值有:['."\n"
+ .' "语文",'."\n"
+ .' "英语应用文",'."\n"
+ .' "英语读后续写"'."\n"
+ .' ]', 'description' => '科目,可选值有:['."\n"
+ .' "语文",'."\n"
+ .' "英语应用文",'."\n"
+ .' "英语读后续写"'."\n"
+ .' ]', '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来区分不同任务。', 'description' => '用户自定义ID。用来唯一标识每个任务,不能重复', 'type' => 'string', 'required' => false, 'example' => 'xxxxx'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'example' => '[{"grade": "高中二年级", "subject": "语文", "totalScore": 60, "question": "请以我的梦想为主题写一篇作文", "answer": "我的梦想是成为一名科学家...", "customId": "task-001"}]',
],
],
[
- 'name' => 'taskStatus',
+ 'name' => 'grade',
+ 'in' => 'formData',
+ 'schema' => ['title' => '年级(公共值,优先取子任务中的grade)', 'description' => '年级(公共值,优先取子任务中的grade)', 'type' => 'string', 'required' => false, 'example' => '高中二年级'],
+ ],
+ [
+ 'name' => 'subject',
+ 'in' => 'formData',
+ 'schema' => ['title' => '科目(公共值,优先取子任务中的subject)', 'description' => '科目(公共值,优先取子任务中的subject)', 'type' => 'string', 'required' => false, 'example' => '语文'],
+ ],
+ [
+ 'name' => 'totalScore',
+ 'in' => 'formData',
+ 'schema' => ['title' => '总分(公共值,优先取子任务中的 totalScore)', 'description' => '总分(公共值,优先取子任务中的 totalScore)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'question',
+ 'in' => 'formData',
+ 'schema' => ['title' => '作文题目(公共值,优先取子任务中的question)', 'description' => '作文题目(公共值,优先取子任务中的question)', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'otherReviewPoints',
'in' => 'formData',
+ 'schema' => ['title' => '其他评阅要点(公共值,优先取子任务中的otherReviewPoints )', 'description' => '其他评阅要点(公共值,优先取子任务中的otherReviewPoints )', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID'."\n"
+ ."\n"
+ .'可参考模型列表如下:'."\n"
+ .'```json'."\n"
+ ."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "ModelName": "自定义批改模型",'."\n"
+ .' "ModelId": "qwen-custom-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "作文批改模型 1",'."\n"
+ .' "ModelId": "qwen-correction-v1"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ModelName": "作文批改轻量模型",'."\n"
+ .' "ModelId": "qwen-correction-v1-lite"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => 'qwen-correction-v1'],
+ ],
+ [
+ 'name' => 'dimensions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'description' => '任务状态:'."\n"
- .'- CANCELED:取消任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CANCELED',
+ 'title' => '自定义评分维度列表(仅 qwen-custom-correction-v1 模型支持)',
+ 'description' => '自定义评分维度列表(仅 qwen-custom-correction-v1 模型支持)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '自定义评分维度',
+ 'description' => '自定义评分维度',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '维度名称', 'description' => '维度名称', 'type' => 'string', 'required' => false, 'example' => '内容完整度'],
+ 'rubric' => ['title' => '维度细则描述', 'description' => '维度细则描述', 'type' => 'string', 'required' => false, 'example' => '文章内容是否完整,是否涵盖了题目的核心要求'],
+ 'maxScore' => ['title' => '维度满分', 'description' => '维度满分', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'example' => '[{"name": "内容完整度", "rubric": "文章内容是否完整,是否涵盖了题目的核心要求", "maxScore": 30}]',
],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
'data' => [
- 'title' => '任务信息',
- 'description' => '任务信息',
+ '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',
- ],
+ 'taskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
],
],
],
],
],
],
- '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' => '智能拆条-修改异步任务状态',
- ],
- 'UpdateVideoDetectShotConfig' => [
- 'summary' => '智能拆条-更新配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoDetectShotConfig',
- 'methods' => [
- 'put',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '提交作文批改任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SubmitTagMiningAnalysisTask' => [
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitTagMiningAnalysisTask',
+ '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' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
+ ],
+ [
+ 'name' => 'businessType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务类型', 'description' => '业务类型', 'type' => 'string', 'required' => false, 'example' => 'clueMining'],
+ ],
+ [
+ 'name' => 'taskDescription',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。'],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ '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' => false,
],
],
[
- 'name' => 'asyncConcurrency',
+ 'name' => 'extraInfo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '额外信息', 'description' => '额外信息', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ [
+ 'name' => 'outputFormat',
'in' => 'formData',
+ 'schema' => ['title' => '输出格式', 'description' => '输出格式', 'type' => 'string', 'required' => false, 'example' => '请返回如下JSON格式,{"key1":"","key2":""}'],
+ ],
+ [
+ 'name' => 'url',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待分析的内容文件URl(每条内容通过换行符分隔,contents、url二选一)', 'description' => '待分析的内容文件URl(每条内容通过换行符分隔,contents、url二选一)', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxxx.txt', 'maxLength' => 2000],
+ ],
+ [
+ 'name' => 'contents',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '视频理解-离线任务并发数,取值范围[2, 10]',
- 'description' => '视频理解-离线任务并发数,取值范围[2, 10]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
+ 'title' => '待分析的内容列表(contents、url二选一)',
+ 'description' => '待分析的内容列表(contents、url二选一)',
+ 'type' => 'array',
+ 'items' => ['title' => '待分析的内容', 'description' => '待分析的内容', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'maxLength' => 2000],
+ 'required' => false,
+ 'maxItems' => 1000,
],
],
+ [
+ 'name' => 'apiKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼APIKEY', 'description' => '阿里云百炼API KEY', 'type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'batchTask',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'boolean'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '响应',
+ 'description' => '响应',
'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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ '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' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'data' => [
+ 'title' => '任务提交响应',
+ 'description' => '任务提交响应',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ ],
],
],
],
],
],
- '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' => '智能拆条-更新配置',
- ],
- 'GetVideoDetectShotConfig' => [
- 'summary' => '智能拆条-获取配置',
- 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoDetectShotConfig',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交标签挖掘分析任务',
+ 'summary' => '轻应用-标签挖掘。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-10T11:40:54.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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' => '阿里云百炼轻应用-提交视频理解离线异步任务。',
+ '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' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'videoUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '视频url', 'description' => '视频url', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx.mp4'],
+ ],
+ [
+ 'name' => 'videoModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频vl任务模型唯一标识,支持的模型:'."\n"
+ .'- quanmiao-vl-turbo'."\n"
+ .'- quanmiao-vl-plus'."\n"
+ .'- quanmiao-vl-max-thinking'."\n"
+ .'- quanmiao-vl-max'."\n"
+ .'- Qwen-VL-Post', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-vl-turbo'],
+ ],
+ [
+ 'name' => 'videoModelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频vl任务prompt模版:必须包含{videoAsrText}变量,{videoAsrText}是视频的ASR文本信息,默认取页面看到的默认值。', '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"
+ .'直接按照任务目标里即可,先输出每张图片的描述,再串联起来输出整个视频片段的剧情。'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频总结(文本加工)依赖的大模型唯一标识,'."\n"
+ ."\n"
+ .'**如果文本加工阶段想跑多任务**,可以走textProcessTasks字段,如果传入了textProcessTasks,则当前字段和当前字段对应的prompt模版id,prompt模版将不再生效。'."\n"
+ ."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max'],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplateId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
+ ."\n"
+ .'- PlotDetail:剧情详解(默认);'."\n"
+ .'- Summary:内容概述;'."\n"
+ .'- ExtractVideoTag:提取标签;'."\n"
+ .'- ExplosivePointAnalysis:爆点分析;'."\n"
+ .'- MultiTask:多类任务;'."\n"
+ ."\n"
+ .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail'],
+ ],
+ [
+ 'name' => 'modelCustomPromptTemplate',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。', '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"
+ .'直接输出视频剧情,不要输出其他信息。'],
+ ],
+ [
+ 'name' => 'generateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
+ 'description' => '视频理解生成任务选项。',
+ 'type' => 'array',
+ 'items' => ['description' => '视频理解生成任务选项:包含的任务,会自动前置执行。'."\n"
+ .'- videoAnalysis:视频语言分析(VL):如果仅传次值,则运行到视频语言分析后就结束了,不再跑后面的文本加工等子任务;'."\n"
+ .'- **videoGenerate:文本加工-视频总结(默认)**,包含 videoAnalysis;'."\n"
+ .'- videoTitleGenerate:视频标题生成,包含 videoAnalysis、videoGenerate;'."\n"
+ .'- videoMindMappingGenerate:视频思维导图生成,包含 videoAnalysis、videoGenerate;videoRoleRecognition:角色自动识别。', 'type' => 'string', 'required' => false, 'example' => 'videoGenerate'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'videoExtraInfo',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义扩展文本素材:应用到生成中,需要手动调整prompt模版,增加{videoExtraInfo}变量', 'description' => '和视频相关的补充文字资料:您可以自定义扩展文本素材,应用到生成中,需要手动调整 prompt 模版,增加{videoExtraInfo}变量,传入的内容可以是视频摘要、视频简介或视频 ASR 转录信息。', 'type' => 'string', 'required' => false, 'example' => '视频描述了:xx'],
+ ],
+ [
+ 'name' => 'snapshotInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。', 'description' => '抽帧间隔:X秒一帧,取值范围[1, 10],间隔越大模型能提取到的信息越少,耗时越长,成本越高,默认已是最佳实践,一般无需修改,如果要修改,请根据视频时长来定,建议[1~3]。'."\n"
+ .'建议使用:当前字段优先级高于frameSampleMethod.interval,一般场景可以使用frameSampleMethod字段自定义(userdefined)模式下的interval,区别在于frameSampleMethod自定义模式interval取值需要在指定的视频时长对应抽帧间隔范围内。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'splitInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => '分镜最小间隔:[1, 150],取当前配置和系统根据时长推荐的最小值', 'description' => '视频分镜最小间隔:单位秒,取值范围[1, 150],默认根据视频长度取推荐值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'language',
+ 'in' => 'formData',
+ 'schema' => ['title' => '语言,可传参数chinese、french、english、japanese'."\0".'、chineseEnglishFreely(中英文自由说)', 'description' => '语言,可传参数'."\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:越南语', 'type' => 'string', 'required' => false, 'example' => 'chinese'],
+ ],
+ [
+ 'name' => 'frameSampleMethod',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '抽帧方式',
+ 'type' => 'object',
+ 'properties' => [
+ 'methodName' => ['description' => '抽帧类型,可传参数包括'."\n"
+ .'- fast:快速/更低成本'."\n"
+ .'- standard:标准(默认)'."\n"
+ .'- userdefined:自定义', 'type' => 'string', 'required' => false, 'example' => 'standard'],
+ 'interval' => ['description' => '抽帧间隔:单位秒,仅在userdefined模式下有效', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
+ 'pixel' => ['description' => '抽帧像素:每一帧最大边像素,仅在userdefined模式下有效,取值范围是300到768', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '768'],
+ ],
+ 'required' => false,
+ 'example' => 'english',
+ ],
+ ],
+ [
+ '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' => ['description' => '自动识别是否使用的是自动识别单独的视频地址(是:则人脸图片无法使用时间与视频帧用时间对应,因为可能是不同的视频)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'timeIntervals' => [
+ 'description' => '角色出场时间段列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ 'endTime' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '345546789'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'textProcessTasks',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '视频总结(文本加工)任务列表:最多支持3个',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视频总结(文本加工)任务',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['description' => '视频总结依赖的大模型唯一标识,支持的模型'."\n"
+ ."\n"
+ .'- qwen-max-latest'."\n"
+ .'- qwen-max'."\n"
+ .'- qwen-plus-latest'."\n"
+ .'- qwen-plus'."\n"
+ .'- qwen2.5-7b-instruct-1m'."\n"
+ .'- deepseek-r1', 'type' => 'string', 'required' => false, 'example' => 'qwen-max-latest'],
+ 'modelCustomPromptTemplate' => ['description' => '视频总结依赖的大模型prompt模版:必须同时包含{videoAsrText} 和 {videoAnalysisText}变量,{videoAsrText}是视频的ASR文本信息,{videoAnalysisText}是视频的各个子镜头的VL视觉信息(视觉语言分析结果)。', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'modelCustomPromptTemplateId' => ['description' => '视频总结依赖的大模型prompt模版唯一标识:'."\n"
+ ."\n"
+ .'- PlotDetail:剧情详解(默认);'."\n"
+ .'- Summary:内容概述;'."\n"
+ .'- ExtractVideoTag:提取标签;'."\n"
+ .'- ExplosivePointAnalysis:爆点分析;'."\n"
+ .'- MultiTask:多类任务;'."\n"
+ ."\n"
+ .'如果modelCustomPromptTemplate未传,则会取模版唯一标识对应的默认prompt,modelCustomPromptTemplate优先级高于modelCustomPromptTemplateId。', 'type' => 'string', 'required' => false, 'example' => 'PlotDetail'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'faceIdentitySimilarityMinScore',
+ 'in' => 'formData',
+ 'schema' => ['description' => '人物识别相似度阈值:0~1', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.7'],
+ ],
+ [
+ 'name' => 'videoShotFaceIdentityCount',
+ 'in' => 'formData',
+ 'schema' => ['description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量:[1~5]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'deduplicationId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交', 'description' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'excludeGenerateOptions',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '排除的生成步骤:'."\n"
+ ."\n"
+ .'- videoCaption:视频语音识别',
+ 'description' => '排除的生成步骤:'."\n"
+ ."\n"
+ .'- videoCaption:视频语音识别',
+ 'type' => 'array',
+ 'items' => ['description' => '排除的生成步骤:'."\n"
+ ."\n"
+ .'- videoCaption:视频语音识别', 'type' => 'string', 'required' => false, 'example' => '[\\"videoCaption\\"]'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'videoCaptionInfo',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '字幕(asr)信息',
+ 'description' => '字幕(asr)信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'videoCaptions' => [
+ 'title' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
+ 'description' => '字幕(ASR)内容,和 videoCaptionsFIleUrl二选一',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '字幕(asr)内容',
+ 'description' => '字幕(asr)内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'startTime' => ['title' => '当前句子开始时间:毫秒', 'description' => '当前句子开始时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
+ 'endTime' => ['title' => '当前句子结束时间:毫秒', 'description' => '当前句子结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
+ 'text' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '你好'],
+ 'speaker' => ['title' => '角色', 'description' => '角色', 'type' => 'string', 'required' => false, 'example' => '张三'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'videoCaptionFileUrl' => ['title' => '视频字幕(ASR)文件', 'description' => '视频字幕(ASR)文件', 'type' => 'string', 'required' => false, 'example' => 'oss:// | http://'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'autoRoleRecognitionVideoUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自动识别专属url', 'description' => '自动识别功能单独的视频地址Url', 'type' => 'string', 'required' => false, 'example' => 'http://'],
+ ],
+ [
+ 'name' => 'splitType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
+ .' fixDuration(按照固定时长分镜),默认采用minDuration模式', 'description' => '分镜类型:minDuration(限制分镜最小时长),'."\n"
+ .' fixDuration(按照固定时长分镜),默认采用minDuration模式', 'type' => 'string', 'required' => false, 'example' => 'fixDuration'],
+ ],
+ [
+ 'name' => 'addDocumentParam',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '结果自动保存(自动上传妙搜数据集)',
+ 'description' => '指定数据集后:视频理解结果作为meta信息和视频一起上传到妙搜',
+ 'type' => 'object',
+ 'properties' => [
+ 'datasetId' => ['title' => '数据集id', 'description' => '数据集id:如果期望上传到妙搜,这个字段必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3031'],
+ 'datasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'document' => [
+ 'title' => '自动保存视频参数',
+ 'description' => '上传妙搜相关参数:不录入会自动生成',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => '视频名称', 'description' => '视频名称', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'docId' => ['title' => '视频docId', 'description' => '文档业务唯一标识:同数据集会排重', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'categoryUuid' => ['title' => '类目唯一标识', 'description' => '文档类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'tags' => [
+ 'title' => '标签',
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => ['title' => 'value', 'description' => '标签', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'required' => false,
+ ],
+ 'extend1' => ['title' => '扩展字段', 'description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend2' => ['title' => '扩展字段', 'description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'extend3' => ['title' => '扩展字段', 'description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'metadata' => [
+ 'title' => '字典信息',
+ 'description' => '元数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'keyValues' => [
+ 'title' => 'key-value格式字典',
+ 'description' => 'keyValue结构的元数据',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'key-value格式字典',
+ 'description' => 'keyValue 结构的元数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => '名称', 'description' => '字段名称', 'type' => 'string', 'required' => false, 'example' => 'summary'],
+ 'value' => ['title' => '取值', 'description' => '字段值', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'videoUrls',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '多视频url',
+ 'description' => '多视频url',
+ 'type' => 'array',
+ 'items' => ['description' => '多视频url:会合并成一个视频处理,适合短视频场景', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'required' => false,
],
],
],
@@ -6790,142 +7018,146 @@
'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',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '异步任务并发数',
- 'description' => '异步任务并发数',
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'asyncConcurrency' => [
- 'title' => '异步任务并发数',
- 'description' => '异步任务并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'taskId' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ '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' => '视频理解-提交异步任务',
+ 'description' => '### 异步任务说明'."\n"
+ ."\n"
+ .'区别于在线同步接口,提交异步任务后实时返回,无需等待执行结束。任务由后台异步调度(排队、并行),结果可通过"获取异步任务状态和结果"接口查询。'."\n"
+ ."\n"
+ .'### 接口调用说明'."\n"
+ ."\n"
+ .'- 支持绝大部分开发语言 SDK 方式接入'."\n"
+ .'- 可在 [OpenAPI 门户]() 直接调试和使用'."\n"
+ .'- 也可前往 [轻应用-影视传媒视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend),切换到"API"页签查看调用 Demo'."\n"
+ ."\n"
+ .'### 并发说明'."\n"
+ ."\n"
+ .'| 项目 | 说明 |'."\n"
+ .'|------|------|'."\n"
+ .'| 默认并发 | 2 并发(异步任务运行并发,非接口调用并发) |'."\n"
+ .'| 可调上限 | 通过 `UpdateVideoAnalysisConfig` 配置接口可调整至 30 |'."\n"
+ .'| 更高并发 | 业务量大可联系客服或运营申请更多并发 |'."\n"
+ .'| 排队机制 | 并发数 = 后台同时运行的任务数,超过并发数的任务自动后台排队 |'."\n"
+ ."\n"
+ .'### 角色识别说明'."\n"
+ ."\n"
+ .'- 通过 API 接口实现"识别视频中的人物身份"'."\n"
+ .'- **默认可识别**:16 个人物,每个角色 1 张图片'."\n"
+ .'- **放宽限制**:如需进一步放宽,请加入钉钉群 `116015001424` 联系产研'."\n"
+ .'- **超时风险**:一个视频理解任务中做太多次人物角色匹配,存在超时风险'."\n"
+ ."\n"
+ .'### 调度轮询最佳实践'."\n"
+ ."\n"
+ .'因接口调用并发有限制,建议如下:'."\n"
+ ."\n"
+ .'- **扩并发**:扩的是异步处理任务的并发,非提交任务接口的并发'."\n"
+ .'- **提交任务**:理论串行即可。任务多时可适当 2~3 个并发提交'."\n"
+ .'- **结果轮询**:任务按提交顺序调度,只需周期轮询最早未完成的 top n(n == 异步任务并发数)即可。更多任务状态只会是排队中,轮询意义不大'."\n"
+ ."\n"
+ .'### Agent 集成'."\n"
+ ."\n"
+ .'Agent 可通过 Skill 直接使用视频理解能力:'."\n"
+ ."\n"
+ .'- **Skill 名称**:`alibabacloud-bailian-videoanalysis`'."\n"
+ .'- **Skill 地址**:[https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis](https://skills.aliyun.com/skills/alibabacloud-bailian-videoanalysis)',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-16T12:55:30.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-10-17T01:54:58.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-29T11:52:08.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-20T10:20:44.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-15T11:52:23.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-27T09:29:33.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-18T05:48:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:24:41.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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"}]',
- 'title' => '智能拆条-获取配置',
],
- 'RunVideoDetectShot' => [
- 'summary' => '轻应用-视频拆条'."\n"
+ 'SubmitVideoDetectShotTask' => [
+ 'summary' => '轻应用-视频拆条异步任务'."\n"
."\n"
.'使用视频拆条需先开通影视传媒视频理解(免费开通)https://bailian.console.aliyun.com/?tab=app#/app/app-market/quanmiao/video-comprehend'."\n"
."\n"
.'目前拆条提供三种场景视频的处理:'."\n"
.'1、节目场景 2、新闻场景 3、其他场景'."\n"
.'详细使用建议及参考prompt请查看下方补充说明。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runVideoDetectShot',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'path' => '/{workspaceId}/quanmiao/lightapp/submitVideoDetectShotTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
'name' => 'videoUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频的地址',
- 'description' => '视频的地址',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://xxx.mp4',
- ],
+ 'schema' => ['title' => '视频的地址', 'description' => '视频的地址', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.mp4'],
],
[
'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' => 'llm的模型,推荐选择deepseek-r1'."\n"
- .'可选项:'."\n"
- .'- deepseek-r1'."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deepseek-r1',
- ],
+ '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' => 'llm的模型,推荐选择deepseek-r1'."\n"
+ .'可选项:'."\n"
+ .'- deepseek-r1'."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'deepseek-r1'],
],
[
'name' => 'options',
@@ -6935,67 +7167,39 @@
'title' => '用户选择使用什么方式进行分镜,可选项:ASR',
'description' => '用户选择使用什么方式进行分镜,可选项:ASR',
'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => true,
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR'],
+ 'required' => false,
],
],
[
- 'name' => 'taskId',
+ 'name' => 'deduplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'schema' => ['title' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交', 'description' => '排重字段:可以根据业务需要和业务场景定义自己的业务唯一标识,当前字段重复的数据,系统会保证至少72h内不允许重复提交', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'originalSessionId',
+ 'name' => 'prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax',
- ],
+ 'schema' => ['title' => 'llm用户自定义prompt', 'description' => 'llm用户自定义prompt', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'prompt',
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm用户自定义prompt',
- 'description' => 'llm用户自定义prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '任务唯一标识', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2'],
+ ],
+ [
+ 'name' => 'originalSessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '源任务唯一标识:如果要基于历史任务重跑某个子任务(generateOptions字段指定的),可以传入历史任务taskId+originalSessionId,后台会加载历史任务已生成数据,跳过前置步骤,提升生成效率,如果后台数据过久,比如超过7天,查询失败,会默认重跑前置依赖子任务。', 'type' => 'string', 'required' => false, 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5ax'],
],
[
'name' => 'modelCustomPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'llm生成拆条结果prompt的ID',
- 'description' => 'llm生成拆条结果prompt的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotShowPrompt',
- ],
+ 'schema' => ['title' => 'llm生成拆条结果prompt的ID', 'description' => 'llm生成拆条结果prompt的ID', 'type' => 'string', 'required' => false, 'example' => 'videoDetectShotShowPrompt'],
],
[
'name' => 'modelVlCustomPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'vl识别prompt的ID',
- 'description' => 'vl识别prompt的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'videoDetectShotVlShowPrompt',
- ],
+ 'schema' => ['title' => 'vl识别prompt的ID', 'description' => 'vl识别prompt的ID', 'type' => 'string', 'required' => false, 'example' => 'videoDetectShotVlShowPrompt'],
],
[
'name' => 'recognitionOptions',
@@ -7005,113 +7209,78 @@
'title' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
'description' => '用户选择使用什么方式对每个分镜进行内容识别,可选项:ASR,OCR,VL,可多选',
'type' => 'array',
- 'items' => [
- 'description' => 'ASR',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASR',
- ],
- 'required' => true,
+ 'items' => ['description' => 'ASR', 'type' => 'string', 'required' => false, 'example' => 'ASR'],
+ 'required' => false,
],
],
[
'name' => 'intelliSimpPromptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '大语言模型前置简化promptId',
- 'description' => '大语言模型前置简化promptId',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'intelliSimpShowPrompt',
- ],
+ 'schema' => ['title' => '大语言模型前置简化promptId', 'description' => '大语言模型前置简化promptId', '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' => '执行intelliSimpPrompt的模型,推荐选择 quanmiao-llm-max'."\n"
- .'可选项:'."\n"
- .'- deepseek-r1'."\n"
- .'- quanmiao-llm-max'."\n"
- .'- quanmiao-llm-max-thinking'."\n"
- .'- quanmiao-llm-plus'."\n"
- .'- quanmiao-llm-turbo',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-llm-max',
- ],
+ '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' => '执行intelliSimpPrompt的模型,推荐选择quanmiao-llm-max'."\n"
+ .'可选项:'."\n"
+ .'- deepseek-r1'."\n"
+ .'- quanmiao-llm-max'."\n"
+ .'- quanmiao-llm-max-thinking'."\n"
+ .'- quanmiao-llm-plus'."\n"
+ .'- quanmiao-llm-turbo', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-llm-max'],
],
[
'name' => 'intelliSimpPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '简化输入给llm的数据的prompt(用户自定义)',
- 'description' => '简化输入给llm的数据的prompt(用户自定义)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '简化输入给llm的数据的prompt(用户自定义)', 'description' => '简化输入给llm的数据的prompt(用户自定义)', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'vlPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户自定义的vl识别prompt',
- 'description' => '用户自定义的vl识别prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => 'vl模型用户自定义prompt', 'description' => 'vl模型用户自定义prompt', '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' => '语音识别语言:'."\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:越南语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'chinese',
- ],
+ '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' => '语音识别语言:'."\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:越南语', 'type' => 'string', 'required' => false, 'example' => 'chinese'],
],
],
'responses' => [
@@ -7121,179 +7290,30 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'header' => [
- 'description' => '流式输出 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',
- ],
- ],
- ],
- 'payload' => [
- 'description' => '生成结果数据',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'output' => [
- 'description' => '输出内容对象',
- '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' => '拆条结果结构化,如果结构化失败则参数不存在,请根据text的返回结果进行解析;参数可通过prompt进行自定义调整,可参考modelCustomPromptTemplateId(通过/getLightAppGeneralConfig接口获取)进行改写',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'xxx',
- 'example' => 'xxx',
- ],
- ],
- ],
- 'videoRecognitionResult' => [
- 'title' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- 'description' => '视频识别结果列表,根据入参的recognitionOptions选项进行视频内容识别后的结果',
- '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',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'usage' => [
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4546',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '820',
- ],
- 'totalTokens' => [
- 'description' => '总token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5366',
- ],
- ],
- ],
+ 'taskId' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'example' => '22ec888712de45b39b97983f8d166831'],
],
],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '58868FD6-53D7-5ACD-80F7-854C8EA256EF',
- ],
],
],
],
],
'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' => '请检查workspaceId的赋值'],
],
],
- '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' => '智能拆条-在线任务',
+ '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' => '智能拆条-提交异步任务',
'extraInfo' => '目前拆条提供三种场景视频的处理:'."\n"
.'1、节目场景 2、新闻场景 3、其他场景'."\n"
."\n"
@@ -7671,1503 +7691,200 @@
.' 6、必须保证时间的准确性。'."\n"
."\n"
.' 请严格按照上述规则处理文本。',
- ],
- 'RunHotTopicChat' => [
- 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单(热榜)问答:可以对播报单、新闻、开放域内容问答。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicChat',
- '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' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '数据模型ID。默认:qwen-max-latest',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max-latest',
- ],
- ],
- [
- 'name' => 'modelCustomPromptTemplate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'prompt模版',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'generateOptions',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '生成模式列表:默认textChatGenerate',
- 'description' => '生成模式列表:默认textChatGenerate',
- 'type' => 'array',
- 'items' => [
- 'title' => '生成模式:'."\n"
- .'- categoryRecommend:频道热点推荐'."\n"
- .'- textChatGenerate:问答(默认)'."\n"
- .'- internetSearch:互联网搜索'."\n"
- .'- queryRecommend:query推荐',
- 'description' => '生成模式:summaryChatGenerate、newsChatGenerate和控制台第三步两个选项对应,可以直接使用,其他场景可以按需要组合:'."\n"
- .'- 能力组合:内置好的,原子能力+搜索源的组合'."\n"
- .' - summaryChatGenerate:对应轻应用控制台“仅针对聚合新闻播报单内已包含的信息进行回答”,包括categoryRecommend, hotTopicSummarySearch, textChatGenerate'."\n"
- .' - newsChatGenerate:对应轻应用控制台“允许针对新闻的原始素材和互联网开放域进行搜索后回答“,包括hotTopicNewsSearch, internetSearch, textChatGenerate'."\n"
- .'- 原子能力:'."\n"
- .' - categoryRecommend:频道热点推荐,比如“推荐下体育新闻”'."\n"
- .' - textChatGenerate:问答,仅次选项时,必须明确指定源internetSearch、hotTopicSummarySearch、hotTopicNewsSearch,比如“xxx事件哪天发生的”'."\n"
- .' - queryRecommend:开启query推荐,单独结构返回'."\n"
- .'- 搜索源:'."\n"
- .' - hotTopicSummarySearch:热榜摘要搜索源'."\n"
- .' - hotTopicNewsSearch:热榜新闻详情搜索源'."\n"
- .' - internetSearch:互联网通用领域搜索源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'newsChatGenerate',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '对话任务唯一标识:多轮时,这个值保持不变',
- 'description' => '对话任务唯一标识:多轮时,这个值保持不变',
- 'type' => 'string',
- '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',
- ],
- ],
- [
- 'name' => 'prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户问题',
- 'description' => '用户问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '帮我播报体育热点',
- ],
- ],
- [
- 'name' => 'hotTopicVersion',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热榜版本',
- 'description' => '热榜版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-09-13_12',
- ],
- ],
- [
- 'name' => 'category',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热榜中平道',
- 'description' => '热榜频道',
- 'type' => 'string',
- 'required' => false,
- 'example' => '体育',
- ],
- ],
- [
- 'name' => 'hotTopics',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '热点名称列表',
- 'description' => '热点名称列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '热点标题名称',
- 'description' => '热点标题名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'imageCount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '配图张数:不一定都有图',
- 'description' => '配图张数:不一定都有图,取值[1-3]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'stepForBroadcastContentConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '新闻播报内容配置:仅Saas用,Paas调用建议走hotTopicVersion',
- 'description' => '新闻播报内容配置:仅Saas用,Paas调用建议走hotTopicVersion',
- 'type' => 'object',
- 'properties' => [
- 'categories' => [
- 'title' => '选择的频道列表',
- 'description' => '选择的频道列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '频道',
- 'description' => '频道',
- 'type' => 'string',
- 'required' => false,
- 'example' => '体育',
- ],
- 'required' => false,
- ],
- 'customHotValueWeights' => [
- 'title' => '热度计算维度',
- 'description' => '热度计算维度,不传,则走默认',
- 'type' => 'array',
- 'items' => [
- 'title' => '热度计算维度列表',
- 'description' => '热度计算维度列表',
- 'type' => 'object',
- 'properties' => [
- 'dimension' => [
- 'title' => '权重维度唯一标识:'."\n"
- .'- views("阅读量")'."\n"
- .'- comments("评论量")'."\n"
- .'- ups("点赞数")'."\n"
- .'- downs("点踩数")'."\n"
- .'- publishTime("发布时间")',
- 'description' => '权重维度唯一标识:'."\n"
- .'- views("阅读量")'."\n"
- .'- comments("发表观点量")'."\n"
- .'- ups("点赞数")'."\n"
- .'- downs("点踩数")'."\n"
- .'- publishTime("发布时间")',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'comments',
- ],
- 'weight' => [
- 'title' => '权重,0-10之间',
- 'description' => '权重,0-10之间',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'topicCount' => [
- 'title' => '话题数量',
- 'description' => '话题数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'messages',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '上下文',
- 'description' => '上下文',
- 'type' => 'array',
- 'items' => [
- 'title' => '角色:user、assistant、system',
- 'description' => '角色:user、assistant、system',
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
- 'content' => [
- 'title' => '发生时间',
- 'description' => '发生时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'createTime' => [
- 'title' => '时间',
- 'description' => '时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-12-10 18:51:29',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'articles' => [
- 'title' => '参照内容列表',
- 'description' => '参照内容列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '内容列表',
- 'description' => '内容列表',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '正文',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'pubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-09-22 16:45:06',
- ],
- 'score' => [
- 'title' => '相关度',
- 'description' => '相关度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.8',
- ],
- 'searchSourceName' => [
- 'title' => '文章来源名称',
- 'description' => '文章来源名称',
- 'type' => 'string',
- 'example' => '互联网',
- ],
- 'select' => [
- 'title' => '是否参照',
- 'description' => '是否参照',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'url' => [
- 'title' => '链接',
- 'description' => '链接',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- ],
- ],
- ],
- 'hotTopicSummaries' => [
- 'title' => '热点列表',
- 'description' => '热点列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '热点',
- 'description' => '热点',
- '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' => '热点话题文本摘要',
- 'description' => '热点话题文本摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'customTextSummary' => [
- 'title' => '自定义热点话题文本摘要',
- 'description' => '自定义热点话题文本摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'news' => [
- 'title' => '新闻列表',
- 'description' => '新闻列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '新闻',
- 'description' => '新闻',
- 'type' => 'object',
- 'properties' => [
- 'title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- ],
- ],
- ],
- 'images' => [
- 'title' => '图片列表',
- 'description' => '图片列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '图片',
- 'description' => '图片',
- 'type' => 'object',
- 'properties' => [
- 'url' => [
- 'title' => '图片',
- 'description' => '图片',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.png',
- ],
- ],
- ],
- ],
- 'url' => [
- 'title' => '热点话题的URL',
- 'description' => '热点话题的URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.html',
- ],
- 'pubTime' => [
- 'title' => '热点话题发布时间',
- 'description' => '热点话题发布时间',
- 'type' => 'string',
- 'example' => '2025-05-20 12:00:00',
- ],
- ],
- ],
- ],
- 'multimodalMedias' => [
- 'title' => '配图',
- 'description' => '配图',
- 'type' => 'array',
- 'items' => [
- 'title' => '配图',
- 'description' => '配图',
- 'type' => 'object',
- 'properties' => [
- 'fileUrl' => [
- 'title' => '链接',
- 'description' => '链接',
- 'type' => 'string',
- 'example' => 'http://xxxx',
- ],
- 'mediaType' => [
- 'title' => '类型:'."\n"
- .'- image:图片',
- 'description' => '类型:'."\n"
- .'- image:图片',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'sortScore' => [
- 'title' => '相关度',
- 'description' => '相关度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.8',
- ],
- ],
- ],
- ],
- 'recommendQueries' => [
- 'title' => '推荐query列表',
- 'description' => '推荐query列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '推荐query',
- 'description' => '推荐query',
- 'type' => 'string',
- 'example' => '关于xx你有什么看法?',
- ],
- ],
- 'searchQuery' => [
- 'title' => '改写后query',
- 'description' => '改写后query',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'text' => [
- 'title' => '生成正文:答案等',
- 'description' => '生成正文:答案等',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'category' => [
- 'title' => '新闻播报场景的领域识别(时政、社会、国际等频道识别)',
- 'description' => '新闻播报场景的领域识别(时政、社会、国际等频道识别)',
- 'type' => 'string',
- 'example' => '国际',
- ],
- 'keyword' => [
- 'title' => '新闻播报场景的关键字识别',
- 'description' => '新闻播报场景的关键字识别',
- 'type' => 'string',
- 'example' => 'AI',
- ],
- 'location' => [
- 'title' => '新闻播报场景的地点名识别',
- 'description' => '新闻播报场景的地点名识别',
- 'type' => 'string',
- 'example' => '杭州',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8',
- ],
- ],
- ],
- ],
- ],
- '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 \\"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' => '播报单(热榜)问答',
- 'description' => '## 当前接口RunHotTopicChat说明'."\n"
- .'通过此接口,可以对播报单(热榜)、热榜新闻、开放域内容做问答,包括频道推荐、热点推荐、热点内容问答等。'."\n"
- ."\n"
- .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
- ."\n"
- .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
- ."\n"
- .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
- ."\n"
- .'**通过SDK方式调用API,请可参考[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)“API”页签下的java、python示例!**'."\n"
- ."\n"
- .'## 新闻热榜互动全量API说明'."\n"
- .'### API明细'."\n"
- ."\n"
- .'#### AI妙笔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) - **查询完整播报单(热榜)** --常用'."\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) - 提交自定义播报单任务'."\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) - 获取自定义播报单任务结果'."\n"
- ."\n"
- .'#### 阿里云百炼全妙轻应用SDK下:对应alibabacloud-quanmiaolightapp20240801'."\n"
- ."\n"
- .'- **RunHotTopicChat** - **播报单(热榜)问答** --常用'."\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) - 播报单热点自定义摘要生成'."\n"
- ."\n"
- .'### 场景说明'."\n"
- .'#### 场景1:获取完整播报单(热榜)全量或者部分频道热点:'."\n"
- .'- GetHotTopicBroadcast:查询播报单'."\n"
- ."\n"
- .'#### 场景2:针对播报单或通用领域问题做问答:'."\n"
- .'- RunHotTopicChat:问答'."\n"
- ."\n"
- .'#### 场景3:内置播报单(热榜)不满足要求,需要个性化定制(频道、个性化摘要等):'."\n"
- .'- SubmitCustomHotTopicBroadcastJob:提交自定义播报单任务'."\n"
- .'- GetCustomHotTopicBroadcastJob:轮训自定义播报单任务状态'."\n"
- .'- GetHotTopicBroadcast:获取自定义播报单信息',
],
- 'RunHotTopicSummary' => [
- 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单热点自定义摘要生成:流式生成自定义风格的热点摘要。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runHotTopicSummary',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'UpdateVideoAnalysisConfig' => [
+ 'summary' => '视频理解-更新配置。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisConfig',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '路径参数,[业务空间id](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'hotTopicVersion',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热点播报单版本号',
- 'description' => '热点播报单版本号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2024-10-16_8',
- ],
- ],
- [
- 'name' => 'topicIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '要进行摘要热点话题ID列表',
- 'description' => '要进行摘要热点话题ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '热点ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'required' => true,
- 'example' => 'xxxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'stepForCustomSummaryStyleConfig',
+ 'name' => 'asyncConcurrency',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '自定义输出风格配置',
- 'description' => '自定义输出风格配置',
- 'type' => 'object',
- 'properties' => [
- 'summaryImageCount' => [
- 'title' => '摘要图片数量',
- 'description' => '摘要图片数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'summaryPrompt' => [
- 'title' => '自定义摘要Prompt',
- 'description' => '自定义摘要Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '视频理解-离线任务并发数,取值范围[2, 10]', 'description' => '视频理解-离线任务并发数,取值范围[2, 30]', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
- 'description' => '响应',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '输出摘要文本',
- 'type' => 'string',
- 'example' => '这是测试输出',
- ],
- 'topicId' => [
- 'title' => '热点ID',
- 'description' => '热点ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- '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'],
+ 'code' => ['description' => '状态码', 'type' => 'string', 'example' => 'xx'],
+ 'message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'ok'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- '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\\": \\"5D0E915E-655D-59A8-894F-93873F73AAE5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => '视频理解-更新配置',
+ 'description' => '阿里云百炼轻应用-视频理解-更新配置:通过这个接口可以修改异步任务并发配置。欢迎前往[视频理解控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/video-comprehend)体验。通过SDK方式调用API可参考控制台“API”下的示例。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '播报单热点自定义摘要生成',
- 'description' => '通过此接口,可以流式生成播报单热点下自定义风格的热点摘要。'."\n"
- ."\n"
- .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
- ."\n"
- .'通过SDK方式调用API可参考控制台“API”下的示例。',
],
- 'RunEnterpriseVocAnalysis' => [
- 'summary' => '企业VOC分析。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runEnterpriseVocAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'UpdateVideoAnalysisTask' => [
+ 'summary' => '视频理解-修改任务状态:目前仅支持取消任务。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTask',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '你是一名经验丰富的数据分析师,擅长从文本评论中提取结构化信息。你需要从用户评论列表中识别和提取出与以下四个维度相关的关键词和短语:'."\n"
- .' '."\n"
- .' 索引:输入评论JSON数组中的索引(从零开始)表示针对该条索引抽取的维度。'."\n"
- .' 购买动机:描述用户购买产品的原因、需求或驱动力的关键词或短语。'."\n"
- .' 未满足需求点:用户在使用产品过程中提到的未满足需求或问题的关键词或短语。'."\n"
- .' 使用场景:用户提到的具体使用场景、使用方式或环境的关键词或短语。'."\n"
- .' 正负面观点:明确表示用户对产品或服务的正面或负面看法的关键词或短语。',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息(业务补充信息)',
- 'description' => '额外信息(业务补充信息)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'outputFormat',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '输出格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '按照如下格式输出:{"text1": "xxxx", "text2": "xxxx"}',
- ],
- ],
- [
- 'name' => 'content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '这是一段需要分析的文本内容',
- ],
- ],
- [
- 'name' => 'tags',
- '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,
- ],
- ],
- [
- 'name' => 'filterTags',
- '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,
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- 'description' => '百炼APIKEY',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sk-xxxx',
- ],
- ],
- [
- 'name' => 'akProxy',
+ 'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'none',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'none',
- ],
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'sourceTrace',
+ 'name' => 'taskStatus',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'description' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'description' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'type' => 'string', 'required' => true, 'example' => 'CANCELED'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应',
+ 'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
+ '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '任务信息',
+ 'description' => '任务信息',
'type' => 'object',
'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
+ 'taskId' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'example' => '3feb69ed02d9b1a17d0f1a942675d300'],
+ 'taskStatus' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'CANCELED'],
+ 'taskErrorMessage' => ['title' => '任务失败信息', 'description' => '任务失败信息', 'type' => 'string', 'example' => '主动取消'],
],
],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '输出摘要文本',
- 'type' => 'string',
- 'example' => '输出摘要文本'."\n"
- ."\n",
- ],
- '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' => '推理模型返回的推理内容',
- 'description' => '推理模型返回的推理内容',
- 'type' => 'string',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '49483FFC-0CB9-5163-8D3E-234E276E6DA8',
- ],
],
],
],
],
- '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\\": \\"DataNotExists\\",\\n \\"message\\": \\"任务不存在\\",\\n \\"success\\": false,\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskId\\": \\"3feb69ed02d9b1a17d0f1a942675d300\\",\\n \\"taskStatus\\": \\"CANCELED\\",\\n \\"taskErrorMessage\\": \\"主动取消\\"\\n }\\n}","type":"json"}]',
+ 'title' => '视频理解-修改异步任务状态',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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\\\\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"}]',
- 'title' => '在线企业VOC分析',
],
- 'SubmitEnterpriseVocAnalysisTask' => [
- 'summary' => '提交企业VOC异步任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitEnterpriseVocAnalysisTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoAnalysisTasks' => [
+ 'summary' => '视频理解-批量取消任务',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/videoAnalysis/updateVideoAnalysisTasks',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ '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' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务补充信息',
- 'description' => '业务补充信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- [
- 'name' => 'outputFormat',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式描述提示词(不传的话默认会根据任务描述生成json格式)',
- 'description' => '输出格式描述提示词(不传的话默认会根据任务描述生成json格式)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请直接输出json格式,不要输出其他内容:',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'tags',
- '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' => '给到大模型的标签定义Prompt',
- 'description' => '给到大模型的标签定义Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'filterTags',
- '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' => '给到大模型的 筛选的标签定义Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签抽取的定义的Prompt',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'contents',
+ 'name' => 'taskIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '待挖掘的素材内容列表(url、fileKey、contents 三选一)(此数组不超过200个,更多请走fileKey或contents文件形式)',
- 'description' => '待挖掘的素材内容列表(url、fileKey、contents 三选一)(此数组不超过200个,更多请走fileKey或contents文件形式)',
+ 'title' => '任务id列表',
+ 'description' => '任务id列表',
'type' => 'array',
- 'items' => [
- 'title' => '素材对象',
- 'description' => '素材对象',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '素材内容(字符数不能超过1w个)',
- 'description' => '素材内容(字符数不能超过1w个)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'id' => [
- 'title' => '素材ID',
- 'description' => '素材ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'id-xxxxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'url',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待挖掘的素材内容文件URL(url、fileKey、contents 三选一)(整体文件大小不能超过100M,素材个数不能超过6w条)',
- 'description' => '待挖掘的素材内容文件URL(url、fileKey、contents 三选一)(整体文件大小不能超过100M,素材个数不能超过6w条)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
- ],
- ],
- [
- 'name' => 'fileKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待挖掘的素材内容文件FileKey(url、fileKey、contents 三选一)(fileKey 是从全妙SASS页面上传所获取到的唯一key)',
- 'description' => '待挖掘的素材内容文件FileKey(url、fileKey、contents 三选一)(fileKey 是从全妙SASS页面上传所获取到的唯一key)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt',
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- 'description' => '百炼APIKEY',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sk-xxxxxxxx',
+ 'items' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ 'required' => true,
],
],
[
- 'name' => 'sourceTrace',
+ 'name' => 'taskStatus',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'description' => '是否启用溯源(启用溯源时不支持自定义outputformat)',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'description' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'type' => 'string', 'required' => true, 'example' => 'CANCELED'],
],
],
'responses' => [
@@ -9177,115 +7894,74 @@
'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' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8'],
+ 'code' => ['description' => '响应Code码', 'type' => 'string', 'example' => 'successful'],
+ 'message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'success'],
+ 'success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'httpStatusCode' => ['description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '业务对象',
- 'description' => '业务对象',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'a0cc71ec-fe07-47e5-bf12-6e1c46081c98',
+ 'title' => '删除结果',
+ 'description' => '删除结果',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '删除结果',
+ 'description' => '删除结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'taskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => 'xx'],
+ 'taskStatus' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'CANCELED'],
+ 'taskErrorMessage' => ['title' => '任务失败信息', 'description' => '任务失败信息', 'type' => 'string', 'example' => 'xx'],
+ 'taskErrorCode' => ['title' => '任务失败code', 'description' => '任务失败code', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '无权限访问接口',
- ],
- 'success' => [
- 'title' => '接口请求是否成功:true 成功,false 失败',
- 'description' => '接口请求是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
],
],
],
],
- '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\\": \\"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' => '视频理解-批量取消任务',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '提交企业VOC挖掘异步任务',
],
- 'GetEnterpriseVocAnalysisTask' => [
- 'summary' => '获取企业VOC分析任务结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getEnterpriseVocAnalysisTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoDetectShotConfig' => [
+ 'summary' => '智能拆条-更新配置',
+ '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',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
+ 'name' => 'asyncConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['title' => '视频理解-离线任务并发数,取值范围[2, 10]', 'description' => '视频理解-离线任务并发数,取值范围[2, 10]', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
],
'responses' => [
@@ -9295,262 +7971,65 @@
'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' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
- 'httpStatusCode' => [
- 'title' => 'Http状态码',
- 'description' => 'Http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'message' => [
- 'title' => '响应失败时的消息',
- 'description' => '响应失败时的消息',
- 'type' => 'string',
- 'example' => '无权限访问接口',
- ],
- 'success' => [
- 'title' => 'true:此次接口响应成功,false:响应失败',
- 'description' => 'true:此次接口响应成功,false:响应失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'data' => [
- 'title' => '结果对象',
- 'description' => '结果对象',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'type' => 'string',
- 'example' => 'PENDING',
- ],
- 'errorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '任务错误消息'."\n"
- ."\n",
- ],
- 'usage' => [
- 'title' => '消耗量统计',
- 'description' => '消耗量统计',
- 'type' => 'object',
- 'properties' => [
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'inputTokens' => [
- 'description' => '输入token量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'statisticsOverview' => [
- 'title' => '统计概览',
- 'description' => '统计概览',
- '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' => '标签名称'."\n",
- ],
- 'valueCount' => [
- 'title' => '标签值数量',
- 'description' => '标签值数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'modelId' => [
- 'title' => '此次使用的模型ID',
- 'description' => '此次使用的模型ID',
- 'type' => 'string',
- 'example' => 'qwen-max',
- ],
- 'modelName' => [
- 'title' => '此次使用的模型名称',
- 'description' => '此次使用的模型名称',
- 'type' => 'string',
- 'example' => '通义千问-MAX',
- ],
- ],
- ],
+ '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- '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\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"code\\": \\"xx\\",\\n \\"message\\": \\"ok\\",\\n \\"success\\": true,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => '智能拆条-更新配置',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '获取企业VOC分析任务结果',
],
- 'ExportAnalysisTagDetailByTaskId' => [
- 'summary' => '导出挖掘任务明细',
- 'path' => '/{workspaceId}/quanmiao/lightapp/exportAnalysisTagDetailByTaskId',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateVideoDetectShotTask' => [
+ 'summary' => '智能拆条-修改异步任务状态:目前仅支持取消任务。',
+ 'path' => '/{workspaceId}/quanmiao/lightapp/updateVideoDetectShotTask',
+ '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' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxxxxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
'name' => 'taskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- [
- 'name' => 'category',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分类筛选',
- 'description' => '分类筛选',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签分类',
- ],
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'categories',
+ 'name' => 'taskStatus',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '多分类筛选',
- 'description' => '多分类筛选',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签分类',
- 'description' => '标签分类',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标签分类列表',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'description' => '任务状态:'."\n"
+ .'- CANCELED:取消任务', 'type' => 'string', 'required' => true, 'example' => 'CANCELED'],
],
],
'responses' => [
@@ -9560,3278 +8039,611 @@
'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' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ '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' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => 'URL(临时公网可下载的URL,1小时失效)',
- 'description' => 'URL(临时公网可下载的URL,1小时失效)',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxxx.xlsx',
+ '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'],
+ ],
],
],
],
],
],
- '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' => '智能拆条-修改异步任务状态',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '根据任务ID导出分析明细',
],
- 'ListAnalysisTagDetailByTaskId' => [
- 'summary' => '获取挖掘分析结果明细列表',
- 'path' => '/{workspaceId}/quanmiao/lightapp/listAnalysisTagDetailByTaskId',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => ' learningSamples总长度非空,且不能超过4000个字符'],
+ ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.', 'http_code' => 403, 'description' => '请检查workspaceId的赋值'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetVideoAnalysisTask'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'RunVideoAnalysis'],
+ ['description' => '请求参数发生变更', 'api' => 'SubmitVideoAnalysisTask'],
],
- 'parameters' => [
- [
- 'name' => 'nextToken',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '标记当前开始读取的位置,置空表示从头开始',
- 'description' => '标记当前开始读取的位置,置空表示从头开始',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==',
- ],
- ],
- [
- 'name' => 'maxResults',
- 'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'title' => '本次读取的最大数据记录数量',
- 'description' => '本次读取的最大数据记录数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '挖掘的任务ID',
- 'description' => '挖掘的任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
+ 'createdAt' => '2025-12-16T12:55:41.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetVideoAnalysisTask'],
+ ['description' => '响应参数发生变更', 'api' => 'RunVideoAnalysis'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'totalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
- 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
- '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' => 'MaxResults本次请求所返回的最大记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'code' => [
- 'title' => '响应Code码',
- 'description' => '响应Code码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'message' => [
- 'title' => '响应消息',
- 'description' => '响应消息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- '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' => '原始响应',
- ],
- 'sourceList' => [
- 'title' => '溯源原文列表,启用sourceTrace时会返回该字段',
- 'description' => '溯源原文列表,启用sourceTrace时会返回该字段',
- 'type' => 'array',
- 'items' => [
- 'title' => '溯源原文,启用sourceTrace时会返回该字段',
- 'description' => '溯源原文,启用sourceTrace时会返回该字段',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'createdAt' => '2025-11-24T13:18:08.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'QuanMiaoLightApp',
+ 'productName' => '大模型服务平台百炼',
+ 'ramCodes' => ['quanmiaolightapp'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'RunEnterpriseVocAnalysis',
+ 'description' => '在线企业VOC分析',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEnterpriseVocAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'GetVideoAnalysisTask',
+ 'description' => '视频理解-获取异步任务状态和结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '获取挖掘结果明细列表',
- ],
- 'GenerateOutputFormat' => [
- 'summary' => '轻应用-标签挖掘-获取示例输出格式。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/generateOutputFormat',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GenerateBroadcastNews',
+ 'description' => '播报单(热榜)热点推荐',
'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',
- ],
- ],
- [
- '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',
- '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' => '额外信息',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateBroadcastNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'data' => [
- 'title' => '示例格式对象',
- 'description' => '示例格式对象',
- 'type' => 'object',
- 'properties' => [
- 'outputFormat' => [
- 'title' => '输出格式',
- 'description' => '输出格式',
- 'type' => 'string',
- 'example' => '请直接以如下JSON格式输出,不要输出其他内容:'."\n"
- .'{'."\n"
- .' "是否近期买房": "",'."\n"
- .' "购房付款方式": "",'."\n"
- .' "家庭人口数量": "",'."\n"
- .' "房间数量需求": "",'."\n"
- .' "买房投资诉求": "",'."\n"
- .' "客户买房类型": "",'."\n"
- .' "客户买房预算": "",'."\n"
- .' "客户居住地": "",'."\n"
- .' "用户核心需求": ['."\n"
- .' ""'."\n"
- .' ],'."\n"
- .' "年龄": "",'."\n"
- .' "性别": "",'."\n"
- .' "职业":""'."\n"
- .'}'."\n",
- ],
- ],
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- '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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- ],
+ [
+ 'apiName' => 'GetVideoDetectShotConfig',
+ 'description' => '智能拆条-获取配置',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunScriptRefine',
+ 'description' => '影视互娱剧本创作-剧本整理',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '获取输出格式示例',
- ],
- 'RunTagMiningAnalysis' => [
- 'summary' => '轻应用-标签挖掘。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runTagMiningAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/octet-stream',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'SubmitVideoDetectShotTask',
+ 'description' => '智能拆条-提交异步任务',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'w-08a4a3ba7104917c',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'businessType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
- ],
- [
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待分析文本',
- 'description' => '待分析文本',
- 'type' => 'string',
- 'required' => true,
- 'example' => '待分析文本',
- ],
- ],
- [
- 'name' => 'tags',
- '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' => false,
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '额外信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- [
- 'name' => 'outputFormat',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '输出格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集成接入的API 密钥。获取[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',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '响应',
- 'description' => '响应',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '输出摘要文本',
- 'type' => 'string',
- 'example' => '大模型输出文本',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '085BE2D2-BB7E-59A6-B688-F2CB32124E7F',
- ],
- ],
+ [
+ 'apiName' => 'CancelAsyncTask',
+ 'description' => '根据任务ID取消异步任务的执行',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunStyleWriting',
+ 'description' => '传媒/零售文章风格与格式学习',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunStyleWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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 },\\n \\"usage\\": {\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 100,\\n \\"totalTokens\\": 200\\n }\\n },\\n \\"requestId\\": \\"085BE2D2-BB7E-59A6-B688-F2CB32124E7F\\"\\n}","type":"json"}]',
- 'title' => '标签挖掘分析',
- ],
- 'RunNetworkContentAudit' => [
- 'summary' => '轻应用-网络内容审核。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runNetworkContentAudit',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
- [
- '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' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'businessType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
- ],
- [
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待分析文本',
- 'description' => '待分析文本',
- 'type' => 'string',
- 'required' => true,
- 'example' => '待分析文本',
- ],
- ],
- [
- 'name' => 'tags',
- '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' => false,
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '额外信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- [
- 'name' => 'outputFormat',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '输出格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集成接入的API 密钥。获取[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',
+ [
+ 'apiName' => 'UpdateVideoAnalysisTasks',
+ 'description' => '视频理解-批量取消任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '响应',
- 'description' => '响应',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '输出摘要文本',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5D0E915E-655D-59A8-894F-93873F73AAE5',
- ],
- ],
+ [
+ 'apiName' => 'RunMarketingInformationWriting',
+ 'description' => '电商零售推广文案写作',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'GetTagMiningAnalysisTask',
+ 'description' => '获取标签挖掘分析任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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\\": \\"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' => '网络内容安全审核',
- ],
- 'RunEssayCorrection' => [
- 'summary' => '作业批改',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runEssayCorrection',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
- [
- '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' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxxxxx',
- ],
- ],
- [
- 'name' => 'grade',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '年级',
- 'description' => '年级',
- 'type' => 'string',
- 'required' => false,
- 'example' => '初中一年级',
- ],
- ],
- [
- 'name' => 'subject',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '学科',
- 'description' => '学科',
- 'type' => 'string',
- 'required' => false,
- 'example' => '语文',
- ],
- ],
- [
- 'name' => 'totalScore',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '总分',
- 'description' => '总分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
- ],
- [
- 'name' => 'question',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '题目不能为空',
- 'description' => '题目不能为空',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'answer',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '作答内容',
- 'description' => '作答内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'otherReviewPoints',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '其他评审要点',
- 'description' => '其他评审要点',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID,默认 通义千问3-作业学习强化模型'."\n"
- ."\n"
- .'```json'."\n"
- .'['."\n"
- .' {'."\n"
- .' "ModelName": "通义千问3-作业学习强化模型",'."\n"
- .' "ModelId": "qwen3-32b-offline-202506171456-fb65"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "ModelName": "通义千问-作业批改精调模型",'."\n"
- .' "ModelId": "qwen-correction-v2"'."\n"
- .' }'."\n"
- .']'."\n"
- .'```',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen3-32b-offline-202506171456-fb65',
+ [
+ 'apiName' => 'RunHotTopicSummary',
+ 'description' => '播报单热点自定义摘要生成',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '响应',
- 'description' => '响应',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => '审阅结果',
- 'type' => 'string',
- 'example' => '审阅结果'."\n"
- ."\n",
- ],
- 'score' => [
- 'title' => '作文审阅得分',
- 'description' => '作文审阅得分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- ],
+ [
+ 'apiName' => 'GetVideoDetectShotTask',
+ 'description' => '智能拆条-获取异步任务状态和结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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"}]',
- 'title' => '作文批改',
- ],
- 'RunOcrParse' => [
- 'summary' => '作文图片OCR解析',
- 'path' => '/{workspaceId}/quanmiao/lightapp/runOcrParse',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
- [
- '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' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'url',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '图片URL(url与fileKey二选一)',
- 'description' => '图片URL(url与fileKey二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
- ],
- ],
- [
- 'name' => 'fileKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '图片URL(url与fileKey二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/public/government_service_experience_feedback_summary.txt',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-vl-ocr-latest',
+ [
+ 'apiName' => 'UpdateVideoDetectShotTask',
+ 'description' => '智能拆条-修改异步任务状态',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '响应',
- 'description' => '响应',
- 'type' => 'object',
- 'properties' => [
- 'header' => [
- 'title' => '消息头',
- 'description' => '消息头',
- 'type' => 'object',
- 'properties' => [
- 'errorCode' => [
- 'title' => '错误码code',
- 'description' => '错误码code',
- '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',
- ],
- ],
- ],
- 'payload' => [
- 'title' => '消息体',
- 'description' => '消息体',
- 'type' => 'object',
- 'properties' => [
- 'output' => [
- 'title' => '输出结果',
- 'description' => '输出结果',
- 'type' => 'object',
- 'properties' => [
- 'text' => [
- 'title' => '输出摘要文本',
- 'description' => 'OCR文本输出',
- 'type' => 'string',
- 'example' => 'OCR文本输出'."\n"
- ."\n",
- ],
- ],
- ],
- 'usage' => [
- 'title' => 'token消耗',
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '117F5ABE-CF02-5502-9A3F-E56BC9081A64',
- ],
- ],
+ [
+ 'apiName' => 'UpdateVideoAnalysisConfig',
+ 'description' => '视频理解-更新配置',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'SubmitTagMiningAnalysisTask',
+ 'description' => '提交标签挖掘分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitTagMiningAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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\\": \\"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' => '图片OCR解析',
- ],
- 'SubmitEssayCorrectionTask' => [
- 'summary' => '提交作文批改任务。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitEssayCorrectionTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'SubmitEssayCorrectionTask',
+ 'description' => '提交作文批改任务',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'tasks',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '批改任务列表',
- 'description' => '批改任务列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '子任务',
- 'description' => '子任务',
- 'type' => 'object',
- 'properties' => [
- 'grade' => [
- 'title' => '年级,可选值有:'."\n"
- .'['."\n"
- .' "初中一年级",'."\n"
- .' "初中二年级",'."\n"
- .' "初中三年级",'."\n"
- .' "高中一年级",'."\n"
- .' "高中二年级",'."\n"
- .' "高中三年级"'."\n"
- .']',
- 'description' => '年级,可选值有:'."\n"
- .'['."\n"
- .' "初中一年级",'."\n"
- .' "初中二年级",'."\n"
- .' "初中三年级",'."\n"
- .' "高中一年级",'."\n"
- .' "高中二年级",'."\n"
- .' "高中三年级"'."\n"
- .']',
- 'type' => 'string',
- 'required' => false,
- 'example' => '高中二年级',
- ],
- 'subject' => [
- 'title' => '科目,可选值有:['."\n"
- .' "语文",'."\n"
- .' "英语应用文",'."\n"
- .' "英语读后续写"'."\n"
- .' ]',
- 'description' => '科目,可选值有:['."\n"
- .' "语文",'."\n"
- .' "英语应用文",'."\n"
- .' "英语读后续写"'."\n"
- .' ]',
- '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来区分不同任务。',
- 'description' => '用户自定义ID。用来唯一标识每个任务,不能重复',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'grade',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '年级(公共值,优先取子任务中的grade)',
- 'description' => '年级(公共值,优先取子任务中的grade)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '高中二年级',
- ],
- ],
- [
- 'name' => 'subject',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '科目(公共值,优先取子任务中的subject)',
- 'description' => '科目(公共值,优先取子任务中的subject)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '语文',
- ],
- ],
- [
- 'name' => 'totalScore',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '总分(公共值,优先取子任务中的 totalScore)',
- 'description' => '总分(公共值,优先取子任务中的 totalScore)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '60',
- ],
- ],
- [
- 'name' => 'question',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '作文题目(公共值,优先取子任务中的question)',
- 'description' => '作文题目(公共值,优先取子任务中的question)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'otherReviewPoints',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '其他评阅要点(公共值,优先取子任务中的otherReviewPoints )',
- 'description' => '其他评阅要点(公共值,优先取子任务中的otherReviewPoints )',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- '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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'data' => [
- 'title' => '任务结果',
- 'description' => '任务结果',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'RunEssayCorrection',
+ 'description' => '作文批改',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunEssayCorrection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunScriptChat',
+ 'description' => '影视互娱剧本创作-交互式创作',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '提交作文批改任务',
- ],
- 'GetEssayCorrectionTask' => [
- 'summary' => '获取作文批改结果',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getEssayCorrectionTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetFileContent',
+ 'description' => '获取文件内容',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '[百炼业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetFileContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'httpStatusCode' => [
- 'title' => 'Http状态码',
- 'description' => 'Http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'title' => '响应失败时的消息',
- 'description' => '响应失败时的消息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'success' => [
- 'title' => 'true:此次接口响应成功,false:响应失败',
- 'description' => 'true:此次接口响应成功,false:响应失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'data' => [
- 'title' => '结果对象',
- 'description' => '结果对象',
- 'type' => 'object',
- 'properties' => [
- 'status' => [
- 'title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'type' => 'string',
- 'example' => 'PENDING',
- ],
- 'errorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '任务错误消息'."\n"
- ."\n",
- ],
- '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' => '评阅结果'."\n"
- ."\n",
- ],
- 'score' => [
- 'title' => '作文审阅得分',
- 'description' => '作文审阅得分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '58',
- ],
- 'usage' => [
- 'title' => '单个任务的token消耗数',
- 'description' => '单个任务的token消耗数',
- '$ref' => '#/components/schemas/ModelUsage',
- ],
- ],
- ],
- ],
- 'totalUsage' => [
- 'title' => '所有任务总模型token消耗数',
- 'description' => '所有任务总模型token消耗数',
- '$ref' => '#/components/schemas/ModelUsage',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunMarketingInformationExtract',
+ 'description' => '电商零售内容实体抽取',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunMarketingInformationExtract',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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 \\"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"}]',
- 'title' => '获取作文批改任务结果',
- ],
- 'GenerateBroadcastNews' => [
- 'summary' => '阿里云百炼轻应用-车机/内容平台新闻热榜互动-播报单热点推荐:理解用户意图,获取对应频道下热点列表。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/GenerateBroadcastNews',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'RunVideoDetectShot',
+ 'description' => '智能拆条-在线任务',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间唯一标识',
- 'description' => '[业务空间唯一标识](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户意图:比如“帮我播报体育热点”',
- 'description' => '用户意图',
- 'type' => 'string',
- 'required' => true,
- 'example' => '帮我播报体育热点',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoDetectShot',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'data' => [
- 'description' => '分类和新闻热点数据',
- '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' => '热点话题ID',
- 'type' => 'string',
- 'example' => '1458tb3bjo7531kap42a',
- ],
- 'images' => [
- 'description' => '相关图片列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '相关图片',
- 'type' => 'object',
- 'properties' => [
- 'url' => [
- 'description' => '图片url',
- 'type' => 'string',
- 'example' => 'http://xxx.com/xxx.jpeg',
- ],
- ],
- ],
- ],
- 'textSummary' => [
- 'description' => '热点话题文本摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
- 'sessionId' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => '2bb0ea82dafd48a8817fadc4c90e2b52',
- ],
- 'taskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- 'text' => [
- 'description' => '理解结果',
- 'type' => 'string',
- 'example' => '体育',
- ],
- 'usage' => [
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'inputTokens' => [
- 'description' => '输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'outputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'totalTokens' => [
- 'description' => '总token量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- ],
- ],
- ],
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- '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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- ],
+ [
+ 'apiName' => 'ListAnalysisTagDetailByTaskId',
+ 'description' => '获取挖掘结果明细列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '播报单(热榜)热点推荐',
- 'description' => '理解用户意图,获取对应频道下热点列表,比如“播报体育新闻”。历史接口,建议走“播报单(热榜)问答接口 RunHotTopicChat”,完全覆盖了当前接口的能力。'."\n"
- ."\n"
- .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
- ."\n"
- .'通过SDK方式调用API可参考控制台“API”下的java、python示例。',
- ],
- 'SubmitTagMiningAnalysisTask' => [
- 'summary' => '轻应用-标签挖掘。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/submitTagMiningAnalysisTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'RunNetworkContentAudit',
+ 'description' => '网络内容安全审核',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'modelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- ],
- [
- 'name' => 'businessType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务类型',
- 'description' => '业务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'clueMining',
- ],
- ],
- [
- 'name' => 'taskDescription',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '给你一条待分析文本数据,请你按照标签体系来对数据进行打标。',
- ],
- ],
- [
- 'name' => 'tags',
- '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' => false,
- ],
- ],
- [
- 'name' => 'extraInfo',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '额外信息',
- 'description' => '额外信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- [
- 'name' => 'outputFormat',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '输出格式',
- 'description' => '输出格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请返回如下JSON格式,{"key1":"","key2":""}',
- ],
- ],
- [
- 'name' => 'url',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待分析的内容文件URl(每条内容通过换行符分隔,contents、url二选一)',
- 'description' => '待分析的内容文件URl(每条内容通过换行符分隔,contents、url二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxxx.txt',
- 'maxLength' => 2000,
- ],
- ],
- [
- 'name' => 'contents',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '待分析的内容列表(contents、url二选一)',
- 'description' => '待分析的内容列表(contents、url二选一)',
- 'type' => 'array',
- 'items' => [
- 'title' => '待分析的内容',
- 'description' => '待分析的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- 'maxLength' => 2000,
- ],
- 'required' => false,
- 'maxItems' => 1000,
- ],
- ],
- [
- 'name' => 'apiKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- 'description' => '阿里云百炼API KEY',
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '响应',
- 'description' => '响应',
- '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' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'success' => [
- 'title' => '请求是否成功',
- 'description' => '请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'data' => [
- 'title' => '任务提交响应',
- 'description' => '任务提交响应',
- 'type' => 'object',
- 'properties' => [
- 'taskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3feb69ed02d9b1a17d0f1a942675d300',
- ],
- ],
- ],
- ],
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunNetworkContentAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunScriptPlanning',
+ 'description' => '影视互娱剧本创作-剧本策划',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptPlanning',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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"}]',
- 'title' => '提交标签挖掘分析任务',
- ],
- 'ListHotTopicSummaries' => [
- 'summary' => '阿里云百炼-轻应用-车机/内容平台新闻热榜互动-查询完整播报单(热榜):通过这个接口可以获取播报单所有内容。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/listHotTopicSummaries',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListHotTopicSummaries',
+ 'description' => '查询完整播报单(热榜)',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识,百炼首页左上角获取',
- 'description' => '百炼业务空间唯一标识,百炼首页左上角获取',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
- ],
- [
- 'name' => 'category',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分类',
- 'description' => '分类',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'hotTopic',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热点话题',
- 'description' => '热点话题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'hotTopicVersion',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热点话题版本',
- 'description' => '热点话题版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-09-13_12',
- ],
- ],
- [
- 'name' => 'nextToken',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JlroP3CjgQh5PQDlH3ArzADkBTPZgVqo+64jhZRglNq0mEYoV5SlGb/Juvo8CdfYE9rlwEr2pIJQwdaYotak9g==',
- ],
- ],
- [
- 'name' => 'maxResults',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '每页返回最大数量。'."\n"
- ."\n"
- .'> 默认100,最大1000。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '0',
- 'exclusiveMinimum' => true,
- 'example' => '20',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ListHotTopicSummaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- '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' => '热点话题ID',
- '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',
- ],
- ],
- ],
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- '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' => '下一页的token',
- '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' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'totalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
+ [
+ 'apiName' => 'SubmitEnterpriseVocAnalysisTask',
+ 'description' => '提交企业VOC挖掘异步任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '查询完整播报单(热榜)',
- 'description' => '通过这个接口可以获取“完整播报单(热榜)”下所有内容,包括频道、热点、热度、播报摘要等,默认获取当前最近版本的播报单,通过制定版本可以获取指定时间段系统版本或自定义版本的播报单内容。'."\n"
- ."\n"
- .'建议走最新的[**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)接口:出入参更完善。'."\n"
- ."\n"
- .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
- ."\n"
- .'通过SDK方式调用API可参考控制台“API”页签下的java、python示例。',
- ],
- 'GetTagMiningAnalysisTask' => [
- 'summary' => '获取挖掘分析任务结果。',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getTagMiningAnalysisTask',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'RunTagMiningAnalysis',
+ 'description' => '标签挖掘分析',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunTagMiningAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetEnterpriseVocAnalysisTask',
+ 'description' => '获取企业VOC分析任务结果',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'taskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务ID'."\n",
- 'description' => '任务ID'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
- ],
- ],
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => 'workspaceId',
- 'description' => '[workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'httpStatusCode' => [
- 'title' => 'HTTP响应吗',
- 'description' => 'HTTP响应吗',
- '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' => '输入token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'outputToken' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'totalToken' => [
- 'title' => '总token数',
- 'description' => '总token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '300',
- ],
- ],
- ],
- ],
- ],
- 'header' => [
- 'title' => '响应头信息',
- 'description' => '响应头信息',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '大模型请求ID',
- 'description' => '大模型请求ID',
- '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' => '任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'type' => 'string',
- 'example' => 'RUNNIN',
- ],
- 'errorCode' => [
- 'title' => '错误信息',
- 'description' => '任务错误Code',
- 'type' => 'string',
- 'example' => '任务错误Code'."\n"
- ."\n",
- ],
- 'errorMessage' => [
- 'title' => '错误消息',
- 'description' => '任务错误消息',
- 'type' => 'string',
- 'example' => '任务错误消息'."\n"
- ."\n",
- ],
- ],
- ],
- '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',
- ],
- ],
+ [
+ 'apiName' => 'GetVideoAnalysisConfig',
+ 'description' => '视频理解-获取配置',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetVideoAnalysisConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'SubmitVideoAnalysisTask',
+ 'description' => '视频理解-提交异步任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:SubmitVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '获取标签挖掘分析任务结果',
- ],
- 'CancelAsyncTask' => [
- 'summary' => '取消异步任务',
- 'path' => '/{workspaceId}/quanmiao/lightapp/cancelAsyncTask',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'RunOcrParse',
+ 'description' => '图片OCR解析',
'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '百炼业务空间ID',
- 'description' => '[百炼业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxxxxx',
- ],
- ],
- [
- 'name' => 'taskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a3d1c2ac-f086-4a21-9069-f5631542f5a2',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunOcrParse',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '无权限访问接口',
- ],
- 'httpStatusCode' => [
- 'title' => 'http响应码',
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '403',
- ],
- 'success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'data' => [
- 'title' => '此次取消是否成功',
- 'description' => '此次取消是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'RunScriptContinue',
+ 'description' => '影视互娱剧本创作-剧本续写',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunScriptContinue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'RunVideoAnalysis',
+ 'description' => '视频理解-在线任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunVideoAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '根据任务ID取消异步任务的执行',
- ],
- 'HotNewsRecommend' => [
- 'summary' => '热点新闻推荐',
- 'path' => '/{workspaceId}/quanmiao/lightapp/hotNewsRecommend',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '推荐新闻的提示词',
- 'description' => '推荐新闻的提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '今天的财经新闻',
- ],
- ],
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ [
+ 'apiName' => 'UpdateVideoDetectShotConfig',
+ 'description' => '智能拆条-更新配置',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoDetectShotConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '阿里云为该请求生成的唯一标识符。',
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '575D5893-01DB-5C81-A899-74F67616762A',
- ],
- 'code' => [
- 'title' => '接口返回码:200:表示成功。其它:表示错误码。错误码详情,请参见错误码。',
- 'description' => '接口返回码:200:表示成功。其它:表示错误码。错误码详情,请参见错误码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'success' => [
- 'title' => '是否调用成功:true:调用成功。 false:调用失败。',
- 'description' => '是否调用成功:true:调用成功。 false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- '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' => 'QuarkCommonNews:联网检索',
- ],
- 'imageUrls' => [
- 'title' => '新闻图片列表',
- 'description' => '新闻图片列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址列表',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.png',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetEssayCorrectionTask',
+ 'description' => '获取作文批改任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GetEssayCorrectionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => '新闻热点推荐',
- 'description' => '理解用户意图,获取对应频道下热点列表,比如“播报体育新闻”。历史接口,建议走“播报单(热榜)问答接口 RunHotTopicChat”,完全覆盖了当前接口的能力。'."\n"
- ."\n"
- .'欢迎前往[控制台](https://bailian.console.aliyun.com/#/app/app-market/quanmiao/news-broadcast)体验。'."\n"
- ."\n"
- .'通过SDK方式调用API可参考控制台“API”下的java、python示例。',
- ],
- 'GetFileContent' => [
- 'summary' => '获取文件内容',
- 'path' => '/{workspaceId}/quanmiao/lightapp/getFileContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GenerateOutputFormat',
+ 'description' => '获取输出格式示例',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:GenerateOutputFormat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'fileKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '文件FileKey(妙笔服务文件唯一标识)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/temp/1154600634854327_10045847/300469535473178749_300469535473178749_ee11508152b74137ac5747a6f632256e.docx',
+ [
+ 'apiName' => 'HotNewsRecommend',
+ 'description' => '新闻热点推荐',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:HotNewsRecommend',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'workspaceId',
- 'in' => 'path',
- 'schema' => [
- 'description' => '阿里云百炼平台[工作空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxx',
+ ],
+ [
+ 'apiName' => 'ExportAnalysisTagDetailByTaskId',
+ 'description' => '根据任务ID导出分析明细',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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' => 'BE603C85-90AA-50FC-A2D6-128AA9FA200D',
- ],
- 'success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'data' => [
- 'description' => '结果对象',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'description' => '内容',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- ],
- ],
- 'httpStatusCode' => [
- 'description' => 'Http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'code' => [
- 'description' => '响应Code码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- ],
+ [
+ 'apiName' => 'RunHotTopicChat',
+ 'description' => '播报单(热榜)问答',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:RunHotTopicChat',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action , Please check the assignment of the workspaceId.',
+ [
+ 'apiName' => 'UpdateVideoAnalysisTask',
+ 'description' => '视频理解-修改异步任务状态',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quanmiaolightapp:UpdateVideoAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'QuanMiaoLightApp', 'resourceType' => '全部资源', '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"}]',
- 'title' => '获取文件内容',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'quanmiaolightapp.cn-beijing.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];